工作表
电子表格中的工作表。
| 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
|
界面中标签页的颜色。已弃用:请使用 |
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
|
如果网格未在界面中显示网格线,则为 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[]
|
行中的值,每列一个值。 |
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。如果展开较浅深度的重叠组,收起的组仍会保持收起状态。 true 值并不意味着组中的所有维度都处于隐藏状态,因为维度的可见性可以独立于此组属性而发生变化。不过,更新此属性时,如果此字段为 true,则其中的所有维度都会设置为隐藏;如果此字段为 false,则其中的所有维度都会设置为显示。 |
Slicer
工作表中的切片器。
| JSON 表示法 |
|---|
{ "slicerId": integer, "spec": { object ( |
| 字段 | |
|---|---|
slicerId
|
切片的 ID。 |
spec
|
切片的规范。 |
position
|
切片器的位置。请注意,切片器只能放置在现有工作表中。此外,切片器的宽度和高度可以自动调整,以使其保持在允许的限制范围内。 |
SlicerSpec
切片器的规范。
| JSON 表示法 |
|---|
{ "dataRange": { object ( |
| 字段 | |
|---|---|
dataRange
|
切片器的数据范围。 |
filterCriteria
|
切片器的过滤条件。 |
columnIndex
|
应用过滤条件的数据表中的从零开始的列索引。 |
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 时有效。 |