試算表
試算表中的表單。
JSON 表示法 |
---|
{ "properties": { object ( |
欄位 | |
---|---|
properties
|
工作表的屬性。 |
data[]
|
如果是網格工作表,則為網格中的資料。
傳回的 GridData 物件數量取決於此工作表上要求的範圍數量。舉例來說,如果這代表
對於 |
merges[]
|
要合併的範圍。 |
conditionalFormats[]
|
這個試算表中的條件式格式規則。 |
filterViews[]
|
這個試算表中的篩選器檢視畫面。 |
protectedRanges[]
|
這份工作表中的受保護範圍。 |
basicFilter
|
這個工作表的篩選器 (如果有的話)。 |
charts[]
|
這個工作表上每張圖表的規格。 |
bandedRanges[]
|
這個工作表上的帶狀 (交替顏色) 範圍。 |
developerMetadata[]
|
與工作表相關聯的開發人員中繼資料。 |
rowGroups[]
|
這個工作表上的所有列群組,依範圍起始索引和群組深度排序。 |
columnGroups[]
|
這個工作表上的所有欄群組,以範圍起始索引遞增排序,然後依群組深度排序。 |
slicers[]
|
這個工作表上的切片器。 |
tables[]
|
這個工作表上的表格。 |
SheetProperties
工作表的屬性。
JSON 表示法 |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
欄位 | |
---|---|
sheetId
|
工作表的 ID。不得為負數。設定後即無法變更這個欄位。 |
title
|
工作表的名稱。 |
index
|
試算表內的工作表索引。新增或更新工作表屬性時,如果排除這個欄位,系統會將工作表新增或移至工作表清單的結尾。更新工作表索引或插入工作表時,系統會將移動視為「移動前」的索引。舉例來說,如果有三個工作表 (S1、S2、S3),為了將 S1 移至 S2 之前,索引必須設為 2。如果要求的索引與工作表目前的索引相同,或是要求的新索引等於目前的工作表索引 + 1,系統會忽略工作表索引更新要求。 |
sheetType
|
工作表類型。預設值為 |
gridProperties
|
如果工作表是格狀,則為工作表的其他屬性。(如果工作表是物件工作表,包含圖表或圖片,則不會有這個欄位)。在編寫時,如果在非格線工作表上設定任何格線屬性,就會發生錯誤。
如果這個試算表是 |
tabColor
|
UI 中分頁的顏色。已淘汰:請改用 |
tabColorStyle
|
|
rightToLeft
|
如果工作表是 RTL 工作表而非 LTR 工作表,則為 True。 |
dataSourceSheetProperties
|
僅供輸出。如果有這個欄位,則會包含 |
SheetType
工作表類型。
列舉 | |
---|---|
SHEET_TYPE_UNSPECIFIED
|
預設值,請勿使用。 |
GRID
|
工作表是格狀檢視畫面。 |
OBJECT
|
試算表沒有格線,而是包含圖表或圖片等物件。 |
DATA_SOURCE
|
工作表會連結至外部 DataSource ,並顯示資料的預覽畫面。 |
GridProperties
格線的屬性。
JSON 表示法 |
---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
欄位 | |
---|---|
rowCount
|
格狀檢視畫面中的列數。 |
columnCount
|
格狀檢視畫面中的欄數。 |
frozenRowCount
|
網格中凍結的資料列數。 |
frozenColumnCount
|
網格中凍結的資料欄數。 |
hideGridlines
|
如果格線未在 UI 中顯示格線,則傳回「是」。 |
rowGroupControlAfter
|
如果在群組後方顯示列群組控制項切換鈕,則為「是」。 |
columnGroupControlAfter
|
如果在群組後方顯示欄組控制項切換鈕,則為「是」。 |
DataSourceSheetProperties
DATA_SOURCE
工作表的其他屬性。
JSON 表示法 |
---|
{ "dataSourceId": string, "columns": [ { object ( |
欄位 | |
---|---|
dataSourceId
|
工作表連結的 |
columns[]
|
工作表上顯示的資料欄,對應至 |
dataExecutionStatus
|
資料執行狀態。 |
GridData
格狀圖中的資料,以及維度相關的中繼資料。
JSON 表示法 |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
欄位 | |
---|---|
startRow
|
這個 GridData 參照的第一列,以零為基底。 |
startColumn
|
GridData 參照的第一欄,以零為起點。 |
rowData[]
|
格狀檢視畫面中的資料,每列一個項目,從 startRow 中的列開始。RowData 中的值會對應至從 |
rowMetadata[]
|
關於格狀檢視畫面中要求資料列的中繼資料,從 |
columnMetadata[]
|
關於格狀檢視畫面中所要求資料欄的中繼資料,從 |
RowData
資料列中每個儲存格相關資料。
JSON 表示法 |
---|
{
"values": [
{
object ( |
欄位 | |
---|---|
values[]
|
資料列中的值,每個資料欄一個。 |
DimensionProperties
維度的屬性。
JSON 表示法 |
---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
欄位 | |
---|---|
pixelSize
|
維度的高度 (如果是資料列) 或寬度 (如果是資料欄),以像素為單位。 |
developerMetadata[]
|
與單一資料列或資料欄相關聯的開發人員中繼資料。 |
dataSourceColumnReference
|
僅供輸出。如果已設定,則是資料來源試算表中的資料欄。 |
ConditionalFormatRule
描述條件式格式的規則。
JSON 表示法 |
---|
{ "ranges": [ { object ( |
欄位 | |
---|---|
ranges[]
|
如果條件為 true,則會對這些範圍套用格式。所有範圍都必須位於同一個格狀區塊。 |
聯集欄位 rule 。控制此條件式格式的規則,必須設定一個。rule 只能是下列其中一個: |
|
booleanRule
|
格式化值會根據規則設為「開啟」或「關閉」。 |
gradientRule
|
格式會因規則中的漸層而有所不同。 |
BooleanRule
視條件而定,規則可能會或不會相符。
JSON 表示法 |
---|
{ "condition": { object ( |
欄位 | |
---|---|
condition
|
規則的條件。如果條件評估為 true,就會套用格式。 |
format
|
要套用的格式。條件式格式只能套用部分格式: |
GradientRule
根據所列插補點,套用漸層色彩階調格式的規則。格式會根據單元格內容與內插點的值而有所不同。
JSON 表示法 |
---|
{ "minpoint": { object ( |
欄位 | |
---|---|
minpoint
|
內插的起始點。 |
midpoint
|
選用的中間插補點。 |
maxpoint
|
最終插補點。 |
InterpolationPoint
漸層條件式格式中的單一插補點。這些程式碼會根據所選顏色、類型和值,將漸層色彩等級固定。
JSON 表示法 |
---|
{ "color": { object ( |
欄位 | |
---|---|
color
|
這個內插點應使用的顏色。已淘汰:請改用 |
colorStyle
|
|
type
|
如何解讀值。 |
value
|
|
InterpolationPointType
插補點的類型。
列舉 | |
---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED
|
預設值,請勿使用。 |
MIN
|
插補點會使用條件格式範圍內儲存格中的最小值。 |
MAX
|
插補點會使用條件格式範圍內儲存格中的最大值。 |
NUMBER
|
插補點會使用 InterpolationPoint.value 中的值。 |
PERCENT
|
插補點是指條件式格式範圍內所有儲存格中指定的百分比。如果值為: |
PERCENTILE
|
插補點是指條件式格式範圍內所有儲存格中指定百分比的值。如果值為:=PERCENTILE(FLATTEN(range), value / 100) ,則相當於 NUMBER 。在展開時,系統會忽略範圍中的錯誤。 |
FilterView
篩選器檢視畫面。
JSON 表示法 |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
欄位 | |
---|---|
filterViewId
|
篩選器檢視畫面的 ID。 |
title
|
篩選器檢視畫面的名稱。 |
range
|
這個篩選器檢視畫面涵蓋的範圍。
寫入時,只能設定 |
namedRangeId
|
這個篩選器檢視畫面所依據的命名範圍 (如果有的話)。
寫入時,只能設定 |
tableId
|
這個篩選器檢視畫面的支援表格 (如果有的話)。
寫入時,只能設定 |
sortSpecs[]
|
每個資料欄的排序順序。如果較早的規格中值相等,系統就會使用較新的規格。 |
criteria
|
每個資料欄顯示/隱藏值的條件。地圖的鍵是資料欄索引,值則是該資料欄的條件。
這個欄位已淘汰,請改用 |
filterSpecs[]
|
用於顯示/隱藏每個資料欄值的篩選條件。
回應中會填入 |
ProtectedRange
受保護的範圍。
JSON 表示法 |
---|
{ "protectedRangeId": integer, "range": { object ( |
欄位 | |
---|---|
protectedRangeId
|
受保護範圍的 ID。此欄位為唯讀欄位。 |
range
|
受保護的範圍。範圍可能完全不受限制,這類範圍視為受保護的工作表。
寫入時,只能設定 |
namedRangeId
|
這個受保護範圍的命名範圍 (如果有的話)。
寫入時,只能設定 |
tableId
|
這個受保護範圍的資料表 (如果有)。
寫入時,只能設定 |
description
|
這個受保護範圍的說明。 |
warningOnly
|
如果這個受保護的範圍在編輯時會顯示警告,則為 True。警告式保護功能可讓所有使用者編輯受保護範圍內的資料,但編輯時會顯示警告,要求使用者確認編輯內容。
寫入時:如果這個欄位為 true,系統會忽略 |
requestingUserCanEdit
|
如果要求這個受保護範圍的使用者可以編輯受保護區域,則為 true。此欄位為唯讀欄位。 |
unprotectedRanges[]
|
受保護工作表中未受保護的範圍清單。只有受保護的工作表才能支援未受保護的範圍。 |
editors
|
有權編輯受保護範圍的使用者和群組。只有具備受保護範圍和文件編輯權限的使用者,才能看到這個欄位。 |
編輯者
受保護範圍的編輯者。
JSON 表示法 |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
欄位 | |
---|---|
users[]
|
擁有受保護範圍的編輯存取權使用者的電子郵件地址。 |
groups[]
|
具有保護範圍編輯權限的群組電子郵件地址。 |
domainUsersCanEdit
|
如果文件網域中的任何使用者都有保護範圍的編輯存取權,則為 true。網域保護功能僅支援網域內的文件。 |
BasicFilter
與工作表相關聯的預設篩選器。
JSON 表示法 |
---|
{ "range": { object ( |
欄位 | |
---|---|
range
|
篩選器涵蓋的範圍。 |
tableId
|
|
sortSpecs[]
|
每個資料欄的排序順序。如果較早的規格中值相等,系統就會使用較新的規格。 |
criteria
|
每個資料欄顯示/隱藏值的條件。地圖的鍵是資料欄索引,值則是該資料欄的條件。
這個欄位已淘汰,請改用 |
filterSpecs[]
|
每個資料欄的篩選條件。
回應中會填入 |
BandedRange
工作表中的帶狀 (交替顏色) 範圍。
JSON 表示法 |
---|
{ "bandedRangeId": integer, "bandedRangeReference": string, "range": { object ( |
欄位 | |
---|---|
bandedRangeId
|
帶狀範圍的 ID。如果未設定,請參閱 |
bandedRangeReference
|
僅供輸出。帶狀範圍的參照,用於識別 |
range
|
套用這些屬性的範圍。 |
rowProperties
|
列帶的屬性。這些屬性會逐列套用至指定範圍內的所有資料列。必須指定至少一個 |
columnProperties
|
資料欄區塊的屬性。這些屬性會逐一套用至範圍內的所有資料欄。必須指定至少一個 |
BandingProperties
屬性參照單一維度 (資料列或資料欄)。如果同時設定 BandedRange.row_properties
和 BandedRange.column_properties
,系統會根據下列規則將填充顏色套用至儲存格:
-
headerColor
和footerColor
優先於錶帶顏色。 -
firstBandColor
優先於secondBandColor
。 -
rowProperties
優先於columnProperties
。
舉例來說,第一列顏色優先於第一欄顏色,但第一欄顏色優先於第二列顏色。同樣地,資料列標題會優先於左上方儲存格中的欄標題,但如果未設定資料列標題,欄標題會優先於第一列顏色。
JSON 表示法 |
---|
{ "headerColor": { object ( |
欄位 | |
---|---|
headerColor
|
第一列或第一欄的顏色。如果已設定這個欄位,系統會在第一列或第一欄中填入這個顏色,並從第二列或第二欄開始,在 |
headerColorStyle
|
第一列或第一欄的顏色。如果已設定這個欄位,系統會在第一列或第一欄中填入這個顏色,並從第二列或第二欄開始,在 |
firstBandColor
|
第一個交替顏色。(必要) 已淘汰:請使用 |
firstBandColorStyle
|
第一個交替顏色。(必要) 如果同時設定 |
secondBandColor
|
交錯的第二個顏色。(必要) 已淘汰:請使用 |
secondBandColorStyle
|
交錯的第二個顏色。(必要) 如果同時設定 |
footerColor
|
最後一列或欄的顏色。如果未設定這個欄位,系統會根據前一列或一欄的顏色,填入 |
footerColorStyle
|
最後一列或欄的顏色。如果未設定這個欄位,系統會根據前一列或一欄的顏色,填入 |
DimensionGroup
試算表中一組相鄰的資料列或資料欄,可包含或包含在其他群組內。群組可在工作表中以單位形式展開或收合。
JSON 表示法 |
---|
{
"range": {
object ( |
欄位 | |
---|---|
range
|
這個群組的範圍。 |
depth
|
群組的深度,代表有多少個群組的範圍完全包含這個群組的範圍。 |
collapsed
|
如果這個群組已摺疊,則這個欄位為「是」。如果展開較淺層級的重疊群組,已收合的群組仍會保持收合狀態。 值為「是」並不表示群組中的所有維度都會隱藏,因為維度的顯示設定可以獨立於這個群組屬性變更。不過,如果這個屬性更新,當這個欄位設為 true 時,其中的所有維度都會設為隱藏,如果設為 false 則會設為可見。 |
切片器
試算表中的切片器。
JSON 表示法 |
---|
{ "slicerId": integer, "spec": { object ( |
欄位 | |
---|---|
slicerId
|
切片器的 ID。 |
spec
|
切片器的規格。 |
position
|
切片器的位置。請注意,切片器只能放在現有工作表中。此外,切片器的寬度和高度也可以自動調整,以便維持在允許的範圍內。 |
SlicerSpec
切片器的規格。
JSON 表示法 |
---|
{ "dataRange": { object ( |
欄位 | |
---|---|
dataRange
|
切片器的資料範圍。 |
filterCriteria
|
切片器的篩選條件。 |
columnIndex
|
資料表中要套用篩選器的資料欄,以 0 為索引。 |
applyToPivotTables
|
如果篩選器應套用至資料透視表,則為 True。如果未設定,預設為 |
title
|
切片器的標題。 |
textFormat
|
切片器中標題的文字格式。不支援連結欄位。 |
backgroundColor
|
切片器的背景顏色。已淘汰:請改用 |
backgroundColorStyle
|
切片器的背景顏色。如果同時設定了 |
horizontalAlignment
|
切片器中標題的水平對齊方式。如未指定,則預設為 |
表格
表格。
JSON 表示法 |
---|
{ "tableId": string, "name": string, "range": { object ( |
欄位 | |
---|---|
tableId
|
資料表的 ID。 |
name
|
資料表名稱。這個值在同一試算表的所有資料表中皆不重複。 |
range
|
表格範圍。 |
rowsProperties
|
表格資料列的屬性。 |
columnProperties[]
|
表格資料欄屬性。 |
TableRowsProperties
表格列屬性。
JSON 表示法 |
---|
{ "headerColorStyle": { object ( |
欄位 | |
---|---|
headerColorStyle
|
標頭列的顏色。如果設定此欄位,標題列就會填入指定的顏色。否則,系統會以預設顏色填入標頭列。 |
firstBandColorStyle
|
第一個交替顏色。如果設定這個欄位,系統會使用指定的顏色填入第一個帶狀列。否則,系統會使用預設顏色填入第一個帶狀資料列。 |
secondBandColorStyle
|
交錯的第二個顏色。如果設定此欄位,系統會使用指定的顏色填入第二個帶狀列。否則,第二個帶狀列會填入預設顏色。 |
footerColorStyle
|
最後一行的顏色。如果未設定這個欄位,系統就不會新增頁尾,而是根據前一列的顏色,將最後一列填入 |
TableColumnProperties
表格欄。
JSON 表示法 |
---|
{ "columnIndex": integer, "columnName": string, "columnType": enum ( |
欄位 | |
---|---|
columnIndex
|
以 0 為基底的欄索引。這個索引是相對於表格中的位置,不一定與工作表中的欄索引相同。 |
columnName
|
資料欄名稱。 |
columnType
|
資料欄類型。 |
dataValidationRule
|
資料欄資料驗證規則。僅適用於下拉式選單欄類型。 |
ColumnType
資料表中特定資料欄的資料欄類型。
列舉 | |
---|---|
COLUMN_TYPE_UNSPECIFIED
|
未指定的資料欄類型。 |
DOUBLE
|
數字欄類型。 |
CURRENCY
|
貨幣資料欄類型。 |
PERCENT
|
百分比資料欄類型。 |
DATE
|
日期欄類型。 |
TIME
|
時間欄類型。 |
DATE_TIME
|
日期和時間欄類型。 |
TEXT
|
文字資料欄類型。 |
BOOLEAN
|
布林值資料欄類型。 |
DROPDOWN
|
下拉式選單欄類型。 |
FILES_CHIP
|
檔案方塊資料欄類型 |
PEOPLE_CHIP
|
使用者方塊欄類型 |
FINANCE_CHIP
|
財經方塊資料欄類型 |
PLACE_CHIP
|
地點方塊欄類型 |
RATINGS_CHIP
|
評分方塊資料欄類型 |
TableColumnDataValidationRule
資料表中資料欄的資料驗證規則。
JSON 表示法 |
---|
{
"condition": {
object ( |
欄位 | |
---|---|
condition
|
儲存格中資料必須相符的條件。只有在 [BooleanCondition.type] 為 ONE_OF_LIST 時才有效。 |