Sheets

片狀

試算表中的工作表。

JSON 表示法 
{
  "properties": {
    object (SheetProperties)
  },
  "data": [
    {
      object (GridData)
    }
  ],
  "merges": [
    {
      object (GridRange)
    }
  ],
  "conditionalFormats": [
    {
      object (ConditionalFormatRule)
    }
  ],
  "filterViews": [
    {
      object (FilterView)
    }
  ],
  "protectedRanges": [
    {
      object (ProtectedRange)
    }
  ],
  "basicFilter": {
    object (BasicFilter)
  },
  "charts": [
    {
      object (EmbeddedChart)
    }
  ],
  "bandedRanges": [
    {
      object (BandedRange)
    }
  ],
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "rowGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "columnGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "slicers": [
    {
      object (Slicer)
    }
  ]
}
欄位
properties

object (SheetProperties)

工作表的屬性。

data[]

object (GridData)

格狀檢視資料 (如果這是格狀工作表)。

系統傳回的 GridData 物件數量取決於這張工作表所要求的範圍數量。舉例來說，假設 Sheet1，並要求試算表的指定範圍 Sheet1!A1:C10 和 Sheet1!D15:E20，那麼第一個 GridData 會有 startRow / startColumn / 0，第二張則 startRow 14 (從零開始的第 15 列)；以及 startColumn 3 (以零為基礎的 D 欄)。

換 DATA_SOURCE 工作表，您無法要求特定範圍，GridData 會包含所有值。

merges[]

object (GridRange)

合併的範圍。

conditionalFormats[]

object (ConditionalFormatRule)

這份工作表中的條件式格式規則。

filterViews[]

object (FilterView)

這份工作表中的篩選器檢視畫面。

protectedRanges[]

object (ProtectedRange)

這份工作表中的受保護的範圍。

basicFilter

object (BasicFilter)

這份工作表上的篩選器 (如有)。

charts[]

object (EmbeddedChart)

這份工作表中每張圖表的規格。

bandedRanges[]

object (BandedRange)

這張工作表上的帶狀 (代表色) 範圍。

developerMetadata[]

object (DeveloperMetadata)

與工作表相關聯的開發人員中繼資料。

rowGroups[]

object (DimensionGroup)

這份工作表上的所有列群組，先調高範圍起始索引，再依群組深度排序。

columnGroups[]

object (DimensionGroup)

這份工作表上的所有欄群組，先調高範圍起始索引，再依群組深度排序。

slicers[]

object (Slicer)

這張工作表中的篩選器控制項。

SheetProperties

工作表屬性。

JSON 表示法 
{
  "sheetId": integer,
  "title": string,
  "index": integer,
  "sheetType": enum (SheetType),
  "gridProperties": {
    object (GridProperties)
  },
  "hidden": boolean,
  "tabColor": {
    object (Color)
  },
  "tabColorStyle": {
    object (ColorStyle)
  },
  "rightToLeft": boolean,
  "dataSourceSheetProperties": {
    object (DataSourceSheetProperties)
  }
}
欄位
sheetId

integer

工作表的 ID。不得為負數。這個欄位設定後即無法變更。

title

string

工作表名稱。

index

integer

試算表中的工作表索引。新增或更新工作表屬性時，如果排除了這個欄位，系統就會新增工作表或將其移至工作表清單末端。更新工作表索引或插入工作表時，移動會視為「移動之前」索引。舉例來說，如果有三個工作表 (S1、S2、S3)，如果要將 S1 移到 S2 之前，則索引必須設為 2。如果要求的索引與試算表目前的索引相同，或要求的新索引等於目前的工作表索引 + 1，系統會忽略工作表索引更新要求。

sheetType

enum (SheetType)

工作表類型。預設為 GRID。這個欄位設定後即無法變更。

gridProperties

object (GridProperties)

如果這張工作表是格狀檢視畫面，工作表的其他屬性。(如果工作表是包含圖表或圖片的物件工作表，就不會顯示這個欄位)。編寫非格狀工作表時，設定任何格線屬性會發生錯誤。

如果這份工作表是 DATA_SOURCE 工作表，而是包含相關屬性，反映資料來源工作表在 UI 中的算繪方式，例如 rowCount。

hidden

boolean

如果工作表未顯示在 UI 中，則為「true」，如果顯示出來，則為「false」。

tabColor
(deprecated)

object (Color)

UI 中的分頁顏色。已淘汰：使用 tabColorStyle。

tabColorStyle

object (ColorStyle)

UI 中的分頁顏色。如果 tabColor 也會設定這個欄位，這個欄位的優先順序最高。

rightToLeft

boolean

如果工作表是 RTL 工作表而非 LTR 工作表，則為「true」。

dataSourceSheetProperties

object (DataSourceSheetProperties)

僅供輸出。如果有該欄位，則欄位會包含 DATA_SOURCE 工作表專屬屬性。

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

integer

格狀檢視畫面中的列數。

columnCount

integer

格狀檢視畫面中的欄數。

frozenRowCount

integer

格狀檢視畫面中凍結的列數。

frozenColumnCount

integer

格狀檢視畫面中凍結的欄數。

hideGridlines

boolean

如果格線不會在 UI 中顯示格線，則為「是」。

rowGroupControlAfter

boolean

如果列分組控制項切換鈕顯示在群組之後，則為「是」。

columnGroupControlAfter

boolean

如果欄分組控制項切換鈕顯示在群組後面，則為「是」。

DataSourceSheetProperties

其他 DATA_SOURCE 工作表。

JSON 表示法 
{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
欄位
dataSourceId

string

的 ID DataSource

columns[]

object (DataSourceColumn)

工作表上顯示的資料欄，對應 RowData。

dataExecutionStatus

object (DataExecutionStatus)

資料執行狀態。

GridData

格狀檢視中的資料，以及維度的相關中繼資料。

JSON 表示法 
{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}
欄位
startRow

integer

這個 GridData 參照的第一列，以 0 為基礎。

startColumn

integer

這個 GridData 要參照的第一欄 (從零開始)。

rowData[]

object (RowData)

格狀檢視中的資料，每列一個項目，從 startRow 列開始。RowData 中的值會與以下值開始的資料欄： startColumn。

rowMetadata[]

object (DimensionProperties)

與格狀檢視畫面中所要求資料列的相關中繼資料 (從以下列的列開始) startRow。

columnMetadata[]

object (DimensionProperties)

格狀檢視畫面中要求資料欄的中繼資料 (從 startColumn。

RowData

資料列中每個儲存格的相關資料。

JSON 表示法 
{
  "values": [
    {
      object (CellData)
    }
  ]
}
欄位
values[]

object (CellData)

列中的值，每欄一個值。

DimensionProperties

維度的屬性。

JSON 表示法 
{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}
欄位
hiddenByFilter

boolean

如果要篩選這個維度，則為「是」。這是唯讀欄位。

hiddenByUser

boolean

如果這個維度明確隱藏，則為「是」。

pixelSize

integer

尺寸的高度 (如果是列) 或寬度 (如果是欄的話)，以像素為單位。

developerMetadata[]

object (DeveloperMetadata)

與單一資料列或資料欄相關聯的開發人員中繼資料。

dataSourceColumnReference

object (DataSourceColumnReference)

僅供輸出。如有設定，則這是資料來源工作表中的資料欄。

ConditionalFormatRule

描述條件式格式的規則。

JSON 表示法 
{
  "ranges": [
    {
      object (GridRange)
    }
  ],

  // Union field rule can be only one of the following:
  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
  // End of list of possible types for union field rule.
}
欄位
ranges[]

object (GridRange)

條件為 true 時格式化的範圍。所有範圍都必須位於同一個網格。

聯集欄位 rule。控制此條件式格式的規則，必須設定一個。 rule 只能為下列其中一項：
booleanRule

object (BooleanRule)

格式為「on」或「關閉」您可指定遵守此規則

gradientRule

object (GradientRule)

格式會因規則的漸層而有所不同。

BooleanRule

視條件而定，不一定符合規則。

JSON 表示法 
{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}
欄位
condition

object (BooleanCondition)

規則的條件。如果條件評估為 True，就會套用格式。

format

object (CellFormat)

要套用的格式。條件式格式設定只能套用部分格式設定： bold, italic, strikethrough, foreground color 和 background color。

GradientRule

這項規則會根據列出的內插點，套用漸層色階格式。儲存格的格式會因內插點的值而不同，

JSON 表示法 
{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}
欄位
minpoint

object (InterpolationPoint)

起始內插點。

midpoint

object (InterpolationPoint)

選用的中段內插點。

maxpoint

object (InterpolationPoint)

最後一個內插點。

InterpolationPoint

漸層條件式格式的單一內插點。這類會根據選擇的顏色、類型和值，固定漸層色彩比例。

JSON 表示法 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}
欄位
color
(deprecated)

object (Color)

此內插點應使用的顏色。已淘汰：使用 colorStyle。

colorStyle

object (ColorStyle)

此內插點應使用的顏色。如果 color 也會設定這個欄位，這個欄位的優先順序最高。

type

enum (InterpolationPointType)

應如何解讀這個值。

value

string

這個內插點使用的值。可以是公式。未使用 ( type 為 MIN 或 MAX。

InterpolationPointType

內插點的種類。

列舉
INTERPOLATION_POINT_TYPE_UNSPECIFIED 預設值，不使用。
MIN 內插點會使用條件格式範圍內儲存格的最小值。
MAX 內插點會使用條件格式範圍內儲存格中的最大值。
NUMBER 內插點會完全使用 InterpolationPoint.value。
PERCENT

內插點是條件式格式範圍內所有儲存格的指定百分比。這相當於 NUMBER 如果值為： =(MAX(FLATTEN(range)) * (value / 100)) + (MIN(FLATTEN(range)) * (1 - (value / 100))) (在這種情況下，簡化範圍時會略過範圍中的錯誤)。

PERCENTILE 內插點是條件格式範圍中所有儲存格的指定百分位數。這相當於 NUMBER 如果值為： =PERCENTILE(FLATTEN(range), value / 100) (在這種情況下，簡化範圍時會略過範圍中的錯誤)。

FilterView

篩選器檢視畫面。

JSON 表示法 
{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
欄位
filterViewId

integer

篩選器檢視畫面的 ID。

title

string

篩選器檢視畫面的名稱。

range

object (GridRange)

這個篩選器檢視畫面涵蓋的範圍。

編寫時 range 或 namedRangeId 可能已設定。

namedRangeId

string

這個篩選器檢視畫面支援的已命名範圍 (如有)。

編寫時 range 或 namedRangeId 可能已設定。

sortSpecs[]

object (SortSpec)

各欄的排序順序。當值與先前規格相同時，系統會使用較新的規格。

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria))

各欄顯示/隱藏值的條件。對應的索引鍵是資料欄索引，值則是該資料欄的條件。

這個欄位已淘汰，並改用 filterSpecs。

filterSpecs[]

object (FilterSpec)

用來顯示/隱藏各欄值的篩選條件。

兩者皆有 criteria 和 filterSpecs 填入回應中的 Pod如果在更新要求中指定這兩個欄位，系統會優先採用這個欄位。

ProtectedRange

受保護的範圍。

JSON 表示法 
{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}
欄位
protectedRangeId

integer

受保護的範圍 ID。這是唯讀欄位。

range

object (GridRange)

要保護的範圍。範圍可能沒有限制，在這種情況下，系統會將其視為受保護工作表。

編寫時 range 或 namedRangeId 可能已設定。

namedRangeId

string

這個受保護範圍的已命名範圍 (如果有的話)。

編寫時 range 或 namedRangeId 可能已設定。

description

string

此受保護範圍的說明。

warningOnly

boolean

如果這個保護範圍在編輯時顯示警告，則為「是」。警告依據的保護措施是指所有使用者都能編輯保護範圍中的資料，除了編輯以外，系統會出現警告，要求使用者確認編輯內容。

寫入時：如果這個欄位為 true， editors 系統會忽略此值。此外，如果這個欄位從 true 變更為 false， editors 未設定欄位 (也不會納入欄位遮罩)，那麼系統會將編輯者設為文件中的所有編輯者。

requestingUserCanEdit

boolean

如果要求這個保護範圍的使用者可以編輯受保護的區域，則為「是」。這是唯讀欄位。

unprotectedRanges[]

object (GridRange)

受保護工作表中未受保護的範圍的清單。只有受保護的工作表支援未受保護的範圍。

editors

object (Editors)

具備受保護範圍編輯權限的使用者和群組。只有具備受保護範圍和文件編輯權限的使用者，才能看見這個欄位。編輯器不支援下列項目： warningOnly 以及防護

編輯

受保護範圍的編輯者。

JSON 表示法 
{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}
欄位
users[]

string

擁有受保護範圍編輯權限的使用者電子郵件地址。

groups[]

string

具備受保護範圍編輯權限的群組電子郵件地址。

domainUsersCanEdit

boolean

如果文件網域中的任何人具備受保護範圍的編輯權限，則為「是」。網域保護功能僅支援網域中的文件。

BasicFilter

與工作表相關聯的預設篩選器。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
欄位
range

object (GridRange)

篩選器涵蓋的範圍。

sortSpecs[]

object (SortSpec)

各欄的排序順序。當值與先前規格相同時，系統會使用較新的規格。

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria))

各欄顯示/隱藏值的條件。對應的索引鍵是資料欄索引，值則是該資料欄的條件。

這個欄位已淘汰，並改用 filterSpecs。

filterSpecs[]

object (FilterSpec)

每個資料欄的篩選條件。

兩者皆有 criteria 和 filterSpecs 填入回應中的 Pod如果在更新要求中指定這兩個欄位，系統會優先採用這個欄位。

BandedRange

工作表中的帶狀 (交替顏色) 範圍。

JSON 表示法 
{
  "bandedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}
欄位
bandedRangeId

integer

帶狀範圍的 ID。

range

object (GridRange)

這些屬性的套用範圍。

rowProperties

object (BandingProperties)

列帶屬性。這些屬性會在範圍內的所有資料列中逐一套用。至少一個 rowProperties 或 columnProperties 。

columnProperties

object (BandingProperties)

柱狀線屬性。這類屬性會在範圍內的所有資料欄依個別資料欄套用。至少一個 rowProperties 或 columnProperties 。

BandingProperties

參照單一維度的資源 (列或欄)。如果兩者皆是 BandedRange.row_properties 和 BandedRange.column_properties 的填滿顏色會根據下列規則套用至儲存格：

舉例來說，第一列的顏色優先於第一欄的顏色，但第一欄的顏色優先於第二列的顏色。同樣地，列標頭的優先度會高於左上方儲存格的欄標題，但如果未設定列標題，則欄標題優先於第一列顏色。

JSON 表示法 
{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
欄位
headerColor
(deprecated)

object (Color)

第一列或第一欄的顏色。如果設定這個欄位，第一列或第一欄就會填入該顏色，並在兩個欄位之間交替使用的顏色 firstBandColor 和 secondBandColor 從第二列或第二欄開始否則第一列或第一欄就會填滿 firstBandColor 顏色就會繼續依原樣變換已淘汰：使用 headerColorStyle。

headerColorStyle

object (ColorStyle)

第一列或第一欄的顏色。如果設定這個欄位，第一列或第一欄就會填入該顏色，並在兩個欄位之間交替使用的顏色 firstBandColor 和 secondBandColor 從第二列或第二欄開始否則第一列或第一欄就會填滿 firstBandColor 顏色就會繼續依原樣變換如果 headerColor 也會設定這個欄位，這個欄位的優先順序最高。

firstBandColor
(deprecated)

object (Color)

第一個交替的顏色。(必要) 已淘汰：使用 firstBandColorStyle。

firstBandColorStyle

object (ColorStyle)

第一個交替的顏色。(必填) 如果 firstBandColor 也會設定這個欄位，這個欄位的優先順序最高。

secondBandColor
(deprecated)

object (Color)

交替的第二個顏色。(必要) 已淘汰：使用 secondBandColorStyle。

secondBandColorStyle

object (ColorStyle)

交替的第二個顏色。(必填) 如果 secondBandColor 也會設定這個欄位，這個欄位的優先順序最高。

footerColor
(deprecated)

object (Color)

最後一列或最後一列的顏色。如果不設定這個欄位，系統就會在最後一列或最後一列 firstBandColor 或 secondBandColor (視前一列或前欄的顏色而定)。已淘汰：使用 footerColorStyle。

footerColorStyle

object (ColorStyle)

最後一列或最後一列的顏色。如果不設定這個欄位，系統就會在最後一列或最後一列 firstBandColor 或 secondBandColor (視前一列或前欄的顏色而定)。如果 footerColor 也會設定這個欄位，這個欄位的優先順序最高。

DimensionGroup

工作表中資料列或資料欄的間隔群組，這些群組可以包含或包含在其他群組內。您可以在工作表上收合或展開群組。

JSON 表示法 
{
  "range": {
    object (DimensionRange)
  },
  "depth": integer,
  "collapsed": boolean
}
欄位
range

object (DimensionRange)

這個群組存在的範圍。

depth

integer

群組深度，代表有多少群組的範圍完全包含此群組的範圍。

collapsed

boolean

如果這個群組處於收合狀態，則這個欄位為 true。如果位於淺層深度的重疊群組展開時，收合的群組仍會維持收合狀態。

True 值不代表群組內的所有維度已隱藏，因為維度的瀏覽權限可能會與群組資源分開變更。不過，更新這個屬性後，此屬性內的所有維度都會在這個欄位為 true 時設為隱藏，如果這個欄位為 false，則會設為顯示。

篩選器控制項

工作表中的篩選器控制項。

JSON 表示法 
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  }
}
欄位
slicerId

integer

篩選器控制項的 ID。

spec

object (SlicerSpec)

篩選器控制項的規格。

position

object (EmbeddedObjectPosition)

篩選器控制項的位置。請注意，您只能將篩選器控制項放置在現有工作表上。此外，您可以自動調整篩選器控制項的寬度和高度，避免超出允許的上限。

SlicerSpec

篩選器控制項的規格。

JSON 表示法 
{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}
欄位
dataRange

object (GridRange)

篩選器控制項的資料範圍。

filterCriteria

object (FilterCriteria)

篩選器控制項的篩選條件。

columnIndex

integer

套用篩選器的資料表中，從零開始的資料欄索引。

applyToPivotTables

boolean

如果篩選器應套用至資料透視表，則為「是」。如未設定，則預設為 True。

title

string

篩選器控制項的名稱。

textFormat

object (TextFormat)

篩選器控制項中的標題文字格式。不支援連結欄位。

backgroundColor
(deprecated)

object (Color)

篩選器控制項的背景顏色。已淘汰：使用 backgroundColorStyle。

backgroundColorStyle

object (ColorStyle)

篩選器控制項的背景顏色。如果 backgroundColor 也會設定這個欄位，這個欄位的優先順序最高。

horizontalAlignment

enum (HorizontalAlign)

篩選器控制項中標題的水平對齊方式。如未指定，則預設為 LEFT