工作表
試算表中的工作表。
JSON 表示法 |
---|
{ "properties": { object ( |
欄位 | |
---|---|
properties
|
工作表的屬性。 |
data[]
|
格線中的資料 (如果是網格工作表)。
傳回的 GridData 物件數量取決於這份工作表要求的數量。舉例來說,如果代表
針對 |
merges[]
|
合併的範圍。 |
conditionalFormats[]
|
這份工作表中的條件式格式規則。 |
filterViews[]
|
這份試算表中的篩選器檢視畫面。 |
protectedRanges[]
|
這份工作表中的受保護範圍。 |
basicFilter
|
這份試算表的篩選器 (如果有的話)。 |
charts[]
|
這份工作表中各圖表的規格。 |
bandedRanges[]
|
這份工作表的頻帶 (配色) 範圍。 |
developerMetadata[]
|
與工作表相關聯的開發人員中繼資料。 |
rowGroups[]
|
依工作表的排序方式,排序此工作表中所有資料列群組。 |
columnGroups[]
|
這個工作表中的所有欄群組,排序範圍為範圍先遞增,再依群組深度排序。 |
slicers[]
|
這份工作表中的篩選器控制項。 |
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
|
UI 中分頁的顏色。如果同時設定了 |
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 中的格線,則為 True。 |
rowGroupControlAfter
|
如果資料列分組控制項顯示至群組後,則為 True。 |
columnGroupControlAfter
|
如果資料欄分組控制項在群組後顯示,則為 True。 |
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[]
|
資料列中的值,每個欄一個。 |
DimensionsProperties
維度的屬性。
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
|
內插點是指條件式範圍內範圍內所有儲存格的指定百分位數。這相當於 NUMBER ,前提是值為:
=PERCENTILE(FLATTEN(range), value / 100)
(分割時忽略該範圍內的錯誤)。
|
FilterView
篩選器檢視畫面。
JSON 表示法 |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
欄位 | |
---|---|
filterViewId
|
篩選器檢視畫面的 ID。 |
title
|
篩選器檢視畫面的名稱。 |
range
|
這個篩選器檢視畫面涵蓋的範圍。
寫入時,只能設定 |
namedRangeId
|
這個篩選器檢視畫面支援的已命名範圍 (如果有的話)。
寫入時,只能設定 |
sortSpecs[]
|
每一欄的排序順序。如果值採用較舊的規格,系統就會使用後續規格。 |
criteria
|
每一欄顯示/隱藏值的條件。地圖的索引鍵是資料欄索引,值則代表該資料欄的條件。
這個欄位已淘汰,並改用 |
filterSpecs[]
|
顯示/隱藏每一欄值的篩選條件。
在回應中,系統會填入 |
ProtectedRange
受保護的範圍。
JSON 表示法 |
---|
{ "protectedRangeId": integer, "range": { object ( |
欄位 | |
---|---|
protectedRangeId
|
受保護範圍的 ID。這是唯讀欄位。 |
range
|
受保護的範圍。範圍可能會完全不受限制,在這種情況下,系統會將其視為受保護的工作表。
寫入時,只能設定 |
namedRangeId
|
這個受保護的範圍使用的備份範圍 (如果有的話)。
寫入時,只能設定 |
description
|
這個受保護範圍的說明。 |
warningOnly
|
如果這個受保護的範圍在編輯時顯示警告,則傳回「是」。警告製的保護措施代表所有使用者皆可在受保護的範圍內編輯資料,但編輯提示會要求使用者確認編輯內容。
編寫時:如果這個欄位為「是」,系統會忽略 |
requestingUserCanEdit
|
如果要求這個保護範圍的使用者可以編輯受保護的範圍,則為 True。這是唯讀欄位。 |
unprotectedRanges[]
|
受保護工作表中的受保護範圍清單。受保護的工作表僅支援受保護的工作表。 |
editors
|
具備受保護範圍編輯權限的使用者和群組。只有具備保護範圍和文件編輯權限的使用者可以查看這個欄位。編輯器不支援 |
編輯器
受保護範圍的編輯者。
JSON 表示法 |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
欄位 | |
---|---|
users[]
|
受保護範圍編輯權限的使用者電子郵件地址。 |
groups[]
|
受保護範圍編輯權限群組的群組電子郵件地址。 |
domainUsersCanEdit
|
如果文件網域中的任何人具備受保護範圍的編輯權限,則為 True。網域保護功能僅適用於網域中的文件。 |
BasicFilter
與工作表相關聯的預設篩選器。
JSON 表示法 |
---|
{ "range": { object ( |
欄位 | |
---|---|
range
|
篩選器涵蓋的範圍。 |
sortSpecs[]
|
每一欄的排序順序。如果值採用較舊的規格,系統就會使用後續規格。 |
criteria
|
每一欄顯示/隱藏值的條件。地圖的索引鍵是資料欄索引,值則代表該資料欄的條件。
這個欄位已淘汰,並改用 |
filterSpecs[]
|
每個資料欄的篩選條件。
在回應中,系統會填入 |
BandedRange
工作表中的頻帶 (配色) 範圍。
JSON 表示法 |
---|
{ "bandedRangeId": integer, "range": { object ( |
欄位 | |
---|---|
bandedRangeId
|
頻帶範圍的 ID。 |
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
|
最後一列或欄的顏色。如未設定這個欄位,最後一列或欄的值就會填入 |
Dimensions Group
工作表上的資料列或資料欄間隔群組,可能包含或納入其他群組。工作表上的群組可收合或展開。
JSON 表示法 |
---|
{
"range": {
object (
|
欄位 | |
---|---|
range
|
這個群組所屬的範圍。 |
depth
|
群組深度,代表包含特定群組範圍的群組數量。 |
collapsed
|
如果收合此群組,則這個欄位為 true。如果收合了淺層深度的重疊群組,已收合的群組仍會保持收合狀態。 實際值不一定會表示群組中的所有維度都會隱藏,因為維度的瀏覽權限可能會與這個群組資源獨立運作。不過,更新這項屬性時,如果這個欄位為 true,則所有維度都會設為隱藏;如果這個欄位為 false,則會設為顯示。 |
篩選器控制項
工作表中的篩選器控制項。
JSON 表示法 |
---|
{ "slicerId": integer, "spec": { object ( |
欄位 | |
---|---|
slicerId
|
篩選器控制項的 ID。 |
spec
|
篩選器控制項的規格。 |
position
|
篩選器控制項的位置。請注意,尺規只能放置在現有工作表上。此外,系統會自動調整篩選器控制項的寬度和高度,使其超出允許的上限。 |
SlicerSpec
篩選器控制項的規格。
JSON 表示法 |
---|
{ "dataRange": { object ( |
欄位 | |
---|---|
dataRange
|
篩選器控制項的資料範圍。 |
filterCriteria
|
篩選器控制項的篩選條件。 |
columnIndex
|
要套用篩選器的資料表中以零為基礎的欄索引。 |
applyToPivotTables
|
如果篩選器應套用至資料透視表,則為 True。如果未設定,則預設為 |
title
|
篩選器控制項的標題。 |
textFormat
|
篩選器控制項中的標題格式。不支援連結欄位。 |
backgroundColor
|
篩選器控制項的背景顏色。已淘汰:使用 |
backgroundColorStyle
|
篩選器控制項的背景顏色。如果同時設定了 |
horizontalAlignment
|
篩選器控制項中的標題水平對齊方式。如未指定,則預設為 |