表格
电子表格中的工作表。
JSON 表示法 |
---|
{ "properties": { object ( |
字段 | |
---|---|
properties
|
动作条的属性。 |
data[]
|
以网格形式列出的数据(如果是网格工作表)。
返回的 GridData 对象数量取决于此工作表所请求的范围数量。例如,如果这表示
对于 |
merges[]
|
合并在一起的范围。 |
conditionalFormats[]
|
此表格中的条件格式规则。 |
filterViews[]
|
此表格中的过滤视图。 |
protectedRanges[]
|
此表格中的受保护范围。 |
basicFilter
|
此工作表中的过滤条件(如有)。 |
charts[]
|
此工作表中每个图表的规范。 |
bandedRanges[]
|
此工作表中的带带(交替颜色)范围。 |
developerMetadata[]
|
与工作表关联的开发者元数据。 |
rowGroups[]
|
此工作表中的所有行组,按范围起始索引递增,然后按组深度排序。 |
columnGroups[]
|
此工作表中的所有列组,按范围起始索引的升序排列,然后按组深度排序。 |
slicers[]
|
此工作表中的截剪器。 |
工作表属性
动作条的属性。
JSON 表示法 |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
字段 | |
---|---|
sheetId
|
工作表的 ID。必须为非负数。此字段一经设置便无法更改。 |
title
|
工作表的名称。 |
index
|
电子表格中动作条的索引。添加或更新工作表属性时,如果排除此字段,则系统会添加工作表或将其移至工作表列表的末尾。更新动作条索引或插入动作条时,系统会考虑“移动前”索引中的动作。例如,如果有 3 个工作表(S1、S2、S3),那么为了将 S1 移到 S2 之前,必须将这些索引设置为 2。如果请求的索引与工作表当前索引相同,或者请求的新索引等于当前工作表索引 + 1,则系统将忽略工作表索引更新请求。 |
sheetType
|
工作表的类型。默认为 |
gridProperties
|
如果工作表是网格,则为工作表的其他属性。(如果工作表是包含图表或图片的对象工作表,则此字段将不存在。)在写入时,在非网格工作表上设置任何网格属性会出错。
如果此工作表是 |
tabColor
|
界面中的标签页颜色。已弃用:使用 |
tabColorStyle
|
界面中的标签页颜色。如果也设置了 |
rightToLeft
|
如果工作表是 RTL 工作表而不是 LTR 工作表,则为 true。 |
dataSourceSheetProperties
|
仅供输出。如果存在,则该字段包含 |
工作表类型
动作条的类型。
枚举 | |
---|---|
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 的第一行(以 0 为起点)。 |
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[]
|
满足相应条件时,用于设置格式的范围。所有范围都必须位于同一网格上。 |
联合字段 rule 。控制此条件格式的规则,必须且只能设置一条。rule 只能是下列其中一项:
|
|
booleanRule
|
根据规则,格式为“开启”或“关闭”。 |
gradientRule
|
格式会因规则中的渐变而异。 |
布尔值规则
一条规则,不一定匹配,具体取决于条件。
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
|
如果此受保护的范围会在修改时显示警告,则为 true。基于警告的保护措施意味着每位用户都可以修改受保护范围内的数据,但修改时系统会发出警告,要求用户确认修改内容。
写入时:如果此字段为 true,则会忽略 |
requestingUserCanEdit
|
如果请求此受保护范围的用户可以修改受保护的区域,则为 true。此字段是只读字段。 |
unprotectedRanges[]
|
受保护工作表中不受保护的范围列表。只有受保护的工作表才支持不受保护的范围。 |
editors
|
对受保护的范围拥有编辑权限的用户和群组。只有对受保护的范围和文档拥有编辑权限的用户才能看到此字段。编辑器不受 |
编辑者
受保护的范围的编辑者。
JSON 表示法 |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
字段 | |
---|---|
users[]
|
对受保护的范围拥有编辑权限的用户的电子邮件地址。 |
groups[]
|
对受保护的范围拥有编辑权限的群组的电子邮件地址。 |
domainUsersCanEdit
|
如果文档网域中的任何人对受保护的范围拥有编辑权限,则为 true。只有网域内的文档才支持网域保护。 |
基本过滤条件
与工作表相关联的默认过滤条件。
JSON 表示法 |
---|
{ "range": { object ( |
字段 | |
---|---|
range
|
过滤器涵盖的范围。 |
sortSpecs[]
|
每列的排序顺序。如果前面的规范中的值相等,系统会使用更晚的规范。 |
criteria
|
每列显示/隐藏值的条件。映射的键是列索引,值是该列的条件。
此字段已弃用,取而代之的是 |
filterSpecs[]
|
每列的过滤条件。
系统会在响应中填充 |
频段
工作表中的带色(交替颜色)范围。
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
|
最后一行或该列的颜色。如果未设置此字段,则最后一个行或列填充为 |
维度组
某个组上按一定行数或列数划分的工作表,可包含或包含在其他组中。组可以在工作表中收起或展开。
JSON 表示法 |
---|
{
"range": {
object (
|
字段 | |
---|---|
range
|
此群组的存在范围。 |
depth
|
组的深度,表示有多少组的范围完全包含该组的范围。 |
collapsed
|
如果此群组已收起,此字段将为 true。如果展开深度较浅的重叠组,折叠组将保持收起状态。 值为 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
|
截剪器中标题的水平对齐。如果未指定,则默认为 |