REST Resource: spreadsheets

資源：試算表

代表試算表的資源。

JSON 表示法 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode)
}
欄位
spreadsheetId

string

試算表的 ID。這個欄位為唯讀。
properties

object (SpreadsheetProperties)

試算表的整體屬性。
sheets[]

object (Sheet)

試算表中的工作表。
namedRanges[]

object (NamedRange)

試算表中定義的已命名範圍。
spreadsheetUrl

string

試算表網址。這個欄位為唯讀。
developerMetadata[]

object (DeveloperMetadata)

與試算表相關聯的開發人員中繼資料。
dataSources[]

object (DataSource)

與試算表連結的外部資料來源清單。
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

僅供輸出。資料來源重新整理時間表清單。
comments[]

object (CommentThread)

與試算表相關聯的註解串。
commentsViewMode

enum (CommentsViewMode)

僅供輸出。試算表套用的註解檢視模式。

SpreadsheetProperties

試算表的屬性。

JSON 表示法 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
欄位
title

string

試算表的標題。
locale

string

試算表的語言代碼，採用下列其中一種格式：

  • ISO 639-1 語言代碼，例如 en

  • 如果沒有 639-1 代碼，請使用 ISO 639-2 語言代碼，例如 fil

  • ISO 語言代碼和國家/地區代碼的組合，例如 en_US

注意：更新這個欄位時，系統僅支援部分語言/地區設定。
autoRecalc

enum (RecalculationInterval)

重新計算不穩定函式前要等待的時間量。
timeZone

string

試算表的時區，採用 CLDR 格式，例如 America/New_York。如果系統無法辨識時區，可能是自訂時區，例如 GMT-07:00。
defaultFormat

object (CellFormat)

試算表中所有儲存格的預設格式。如果儲存格格式與這個預設格式相同，系統就不會設定 CellData.effectiveFormat。這個欄位為唯讀。
iterativeCalculationSettings

object (IterativeCalculationSettings)

決定是否要以反覆運算方式解決循環參照問題，以及解決方式。如果沒有這個欄位，表示循環參照會導致計算錯誤。
spreadsheetTheme

object (SpreadsheetTheme)

套用至試算表的主題。
importFunctionsExternalUrlAccessAllowed

boolean

是否允許圖片和匯入函式存取外部網址。如果為 true，則為唯讀。如果為 false，您可以設為 true。如果管理員已啟用允許清單功能，系統會略過這個值，一律傳回 true。

RecalculationInterval

列舉可能的重新計算間隔選項。

列舉
RECALCULATION_INTERVAL_UNSPECIFIED 預設值。不得使用這個值。
ON_CHANGE 易變函式會在每次變更時更新。
MINUTE 易變函式會在每次變更和每分鐘更新。
HOUR 易變函式會在每次變更時更新，每小時也會更新一次。

IterativeCalculationSettings

這些設定可控管如何以反覆運算方式解決循環相依性。

JSON 表示法 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
欄位
maxIterations

integer

啟用反覆運算時，要執行的計算輪數上限。
convergenceThreshold

number

啟用反覆運算後，如果連續結果的差異小於這個門檻值，計算就會停止。

SpreadsheetTheme

代表試算表主題

JSON 表示法 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
欄位
primaryFontFamily

string

主要字型系列的名稱。
themeColors[]

object (ThemeColorPair)

試算表主題的顏色配對。如要更新，請提供所有主題顏色配對。

ThemeColorPair

將試算表主題顏色類型對應至代表該類型的具體顏色。

JSON 表示法 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
欄位
colorType

enum (ThemeColorType)

試算表主題顏色類型。
color

object (ColorStyle)

對應主題顏色類型的具體顏色。

NamedRange

已命名範圍。

JSON 表示法 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
欄位
namedRangeId

string

已命名範圍的 ID。
name

string

已命名範圍的名稱。
range

object (GridRange)

代表的範圍。

DataSource

試算表中外部資料來源的相關資訊。

JSON 表示法 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
欄位
dataSourceId

string

試算表範圍內可識別資料來源的專屬 ID。範例：1080547365。
spec

object (DataSourceSpec)

與這個試算表連結的資料來源 DataSourceSpec。
calculatedColumns[]

object (DataSourceColumn)

資料來源中的所有計算結果欄。
sheetId

integer

與資料來源連結的 Sheet ID。設定後即無法變更。

建立資料來源時，系統也會建立相關聯的DATA_SOURCE試算表。如果未指定欄位，系統會隨機產生所建立試算表的 ID。

DataSourceSpec

這會指定資料來源的詳細資料。舉例來說，如果是 BigQuery，這會指定 BigQuery 來源的相關資訊。

JSON 表示法 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
欄位
parameters[]

object (DataSourceParameter)

查詢資料來源時使用的資料來源參數。
各資料來源類型的實際規格。以下列出互斥欄位。回應中最多會設定一個欄位：
bigQuery

object (BigQueryDataSourceSpec)

A BigQueryDataSourceSpec。
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][]。
互斥欄位的結尾。

BigQueryDataSourceSpec

連結至工作表的 BigQuery 資料來源規格。

JSON 表示法 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
欄位
projectId

string

已啟用 BigQuery 且已附加帳單帳戶的 Google Cloud 專案 ID。針對資料來源執行的任何查詢，都會向專案收費。
實際規格。以下列出互斥欄位。回應中最多會設定一個欄位：
querySpec

object (BigQueryQuerySpec)

A BigQueryQuerySpec。
tableSpec

object (BigQueryTableSpec)

A BigQueryTableSpec。
互斥欄位的結尾。

BigQueryQuerySpec

指定自訂 BigQuery 查詢。

JSON 表示法 
{
  "rawQuery": string
}
欄位
rawQuery

string

原始查詢字串。

BigQueryTableSpec

指定 BigQuery 資料表定義。只能使用原生資料表。

JSON 表示法 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
欄位
tableProjectId

string

資料表所屬的 BigQuery 專案 ID。如未指定，系統會假設您使用的是 projectId。
tableId

string

BigQuery 資料表 ID。
datasetId

string

BigQuery 資料集 ID。

LookerDataSourceSpec

Looker 資料來源的規格。

JSON 表示法 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
欄位
instanceUri

string

Looker 執行個體網址。
model

string

Looker 模型的名稱。
explore

string

Looker 模型探索的名稱。

DataSourceParameter

資料來源查詢中的參數。使用者可透過參數將試算表中的值傳遞至查詢。

JSON 表示法 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
欄位
參數 ID。以下列出互斥欄位。回應中最多會設定一個欄位：
name

string

具名參數。必須是支援 DataSource 的合法 ID。例如 BigQuery ID。
互斥欄位的結尾。
參數值。以下列出互斥欄位。回應中最多會設定一個欄位：
namedRangeId

string

NamedRange 的 ID。大小必須為 1x1。
range

object (GridRange)

包含參數值的範圍。大小必須為 1x1。
互斥欄位的結尾。

DataSourceRefreshSchedule

排定重新整理資料來源的時間。

試算表中的資料來源會在時間間隔內重新整理。您可以在 Google 試算表編輯器中點選「排定重新整理」按鈕，指定開始時間，但間隔固定為 4 小時。舉例來說，如果您指定開始時間為上午 8 點，系統每天會在上午 8 點到中午 12 點之間重新整理資料。

JSON 表示法 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
欄位
enabled

boolean

如果已啟用重新整理時間表，則為 True，否則為 False。
refreshScope

enum (DataSourceRefreshScope)

重新整理的範圍。必須為 ALL_DATA_SOURCES。
nextRun

object (Interval)

僅供輸出。下次執行的時間間隔。
排程設定：以下列出互斥的欄位。回應中最多會設定一個欄位：
dailySchedule

object (DataSourceRefreshDailySchedule)

每日重新整理排程。
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

每週更新時間表。
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

每月更新時間表。
互斥欄位的結尾。

DataSourceRefreshScope

資料來源重新整理範圍。

列舉
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED 預設值，請勿使用。
ALL_DATA_SOURCES 重新整理試算表中的所有資料來源和相關聯的資料來源物件。

DataSourceRefreshDailySchedule

排定在特定時間間隔內每天重新整理資料。

JSON 表示法 
{
  "startTime": {
    object (TimeOfDay)
  }
}
欄位
startTime

object (TimeOfDay)

排定重新整理資料來源的時間間隔開始時間。系統只會使用 hours 部分。時間間隔大小預設為 Google 試算表編輯器中的大小。

TimeOfDay

代表一天中的時間。日期和時區並不需要指定，或是在其他位置上指定。API 可選擇允許閏秒。相關類型為 google.type.Date 和 google.protobuf.Timestamp。

JSON 表示法 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
欄位
hours

integer

以 24 小時制表示一天的小時數。必須大於或等於 0，且通常必須小於或等於 23。API 可選擇允許使用「24:00:00」這類的值來表示營業打烊時間等情況。
minutes

integer

小時的第幾分鐘。必須大於或等於 0，且小於或等於 59。
seconds

integer

一分鐘內的第幾秒。必須大於或等於 0，且通常必須小於或等於 59。如果 API 允許閏秒，則可允許值為 60。
nanos

integer

以奈秒為單位的秒數分數。必須大於或等於 0，且小於或等於 999,999,999。

DataSourceRefreshWeeklySchedule

每週排程，在特定時間間隔的特定日子更新資料。

JSON 表示法 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
欄位
startTime

object (TimeOfDay)

排定重新整理資料來源的時間間隔開始時間。系統只會使用 hours 部分。時間間隔大小預設為 Google 試算表編輯器中的大小。
daysOfWeek[]

enum (DayOfWeek)

要更新的星期幾。至少須指定一天。

DayOfWeek

代表星期幾。

列舉
DAY_OF_WEEK_UNSPECIFIED 未指定星期幾。
MONDAY 星期一
TUESDAY 週二
WEDNESDAY 週三
THURSDAY 週四
FRIDAY Friday (週五)
SATURDAY Saturday (週六)
SUNDAY 星期日

DataSourceRefreshMonthlySchedule

每月排程，在特定時間間隔內，於每月的特定日期重新整理資料。

JSON 表示法 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
欄位
startTime

object (TimeOfDay)

排定重新整理資料來源的時間間隔開始時間。系統只會使用 hours 部分。時間間隔大小預設為 Google 試算表編輯器中的大小。
daysOfMonth[]

integer

要更新的日期。系統僅支援 1 到 28，分別對應到第 1 天到第 28 天。至少須指定一天。

間隔

代表時間間隔，編碼以一個時間戳記開始 (含)，一個時間戳記結束 (不含)。

開始時間必須小於或等於結束時間。如果開始時間等於結束時間，間隔會是空白 (不符合任何時間)。如果開始和結束時間都未指定，則間隔會符合任何時間。

JSON 表示法 
{
  "startTime": string,
  "endTime": string
}
欄位
startTime

string (Timestamp format)

選填。間隔的開始時間 (含)。

如果指定了這個值，符合此間隔的時間戳記必須等於或晚於開始時間。
endTime

string (Timestamp format)

(選用步驟) 間隔的結束時間 (不含)。

如果指定，符合這個間隔的時間戳記必須早於結束時間。

CommentThread

代表試算表中的單一註解討論串。

JSON 表示法 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
欄位
commentId

string

留言串的專屬 ID。
anchorId

string

這個討論串所連結的試算表CommentAnchor ID。
headPost

object (Post)

討論串中的第一則貼文。
replies[]

object (Post)

回覆主貼文。
status

enum (Status)

討論串是否已開啟或解決。
建立留言時，文件中的引文。以下列出互斥欄位。回應中最多會設定一個欄位：
plainTextQuote

string

建立留言時試算表中的引文，格式為純文字。
互斥欄位的結尾。

貼文

代表留言串中的單一留言。

JSON 表示法 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
欄位
postId

string

僅供輸出。貼文的專屬 ID。
content

string

貼文內容。

如果 commentAction 不是 RESOLVE 或 REOPEN，則不得為空白。

系統會以類似於在 Google 試算表編輯器中建立的註解方式處理這類文字內容。格式設定、通知等行為與舊版類似。

不得超過 2048 個 UTF-8 程式碼單元。
contentHtml

string

僅供輸出。以 HTML 格式呈現的貼文內容。
author

object (PostAuthor)

僅供輸出。發布貼文的使用者。
createTime

string (Timestamp format)

僅供輸出。貼文的建立時間。
updateTime

string (Timestamp format)

僅供輸出。貼文的上次更新時間。
deleted

boolean

僅供輸出。貼文是否已刪除。如果 true、content 和 author 欄位會留空。
fromImportedSpreadsheet

boolean

僅供輸出。貼文是否來自匯入的試算表。來電者無法直接設定這個欄位。
fromCopiedSpreadsheet

boolean

僅供輸出。貼文是否來自複製的試算表。來電者無法直接設定這個欄位。
assigneeEmail

string

(選用步驟) 這則貼文新指派給討論串的使用者電子郵件地址。

如果發生下列情況，系統會傳回 400 Bad Request 錯誤：
commentAction

enum (CommentActionType)

建立貼文時採取的動作。

PostAuthor

代表撰寫留言貼文的使用者。

JSON 表示法 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
欄位
displayName

string

使用者的顯示名稱。如果作者匿名，則可能不會顯示。
me

boolean

使用者是否為提出要求的已驗證使用者。
anonymous

boolean

使用者是否匿名。
user

string

貼文作者的使用者資源名稱，也可以用來在 Google People API 中識別使用者。格式：users/{user}。如果匿名欄位為 true，或貼文來自匯入的試算表，系統就不會填入這個欄位。

CommentActionType

對留言討論串回覆所採取的動作。

列舉
COMMENT_ACTION_TYPE_UNSPECIFIED 預設值。這個值不會使用。
NO_COMMENT_ACTION_CHANGE 這則貼文沒有任何動作變更。
RESOLVE 這則貼文會解決該討論串的問題。
REOPEN 這則貼文會重新開啟討論串。

狀態

留言串的狀態選項。

列舉
STATUS_UNSPECIFIED 預設值。這個值不會使用。
OPEN 註解討論串已開啟。
RESOLVED 註解討論串已解決。

CommentsViewMode

試算表套用的註解檢視模式，指出是否包含註解。您可以選擇是否要連同註解和註解錨點一起讀取試算表。

列舉
COMMENTS_VIEW_MODE_UNSPECIFIED 未指定 CommentsViewMode，因此套用 COMMENTS_VIEW_MODE_OMITTED。
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS 系統會根據使用者目前的存取層級，將 CommentsViewMode 套用至傳回的試算表。如果使用者只有檢視權限，系統會套用 COMMENTS_VIEW_MODE_OMITTED。否則會套用 COMMENTS_VIEW_MODE_INCLUDED。
COMMENTS_VIEW_MODE_OMITTED 系統傳回的試算表會省略註解。
COMMENTS_VIEW_MODE_INCLUDED

傳回的試算表包含註解。

如果使用者沒有檢視留言的權限，使用這個模式擷取試算表的要求會傳回 403 錯誤。

方法

batchUpdate

 對試算表套用一或多項更新。

create

 建立試算表，並傳回新建立的試算表。

get

 傳回指定 ID 的試算表。

getByDataFilter

 傳回指定 ID 的試算表。