Sheets

{
  "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)
    }
  ]
}

object (SheetProperties)

动作条的属性。

object (GridData)

以网格形式列出的数据（如果是网格工作表）。

返回的 GridData 对象数量取决于此工作表所请求的范围数量。例如，如果这表示 Sheet1，并且范围是 Sheet1!A1:C10 和 Sheet1!D15:E20 的电子表格，则第一个 GridData 的 startRow/startColumn 为 0，而第二个 GridData 的 startRow 14（基于零的行 15）和 startColumn 3（基于零的列 D）。

对于 DATA_SOURCE 工作表，您不能请求特定范围，GridData 包含所有值。

object (GridRange)

合并在一起的范围。

object (ConditionalFormatRule)

此表格中的条件格式规则。

object (FilterView)

此表格中的过滤视图。

object (ProtectedRange)

此表格中的受保护范围。

object (BasicFilter)

此工作表中的过滤条件（如有）。

object (EmbeddedChart)

此工作表中每个图表的规范。

object (BandedRange)

此工作表中的带带（交替颜色）范围。

object (DeveloperMetadata)

与工作表关联的开发者元数据。

object (DimensionGroup)

此工作表中的所有行组，按范围起始索引递增，然后按组深度排序。

object (DimensionGroup)

此工作表中的所有列组，按范围起始索引的升序排列，然后按组深度排序。

object (Slicer)

此工作表中的截剪器。

{
  "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)
  }
}

integer

工作表的 ID。必须为非负数。此字段一经设置便无法更改。

string

工作表的名称。

integer

电子表格中动作条的索引。添加或更新工作表属性时，如果排除此字段，则系统会添加工作表或将其移至工作表列表的末尾。更新动作条索引或插入动作条时，系统会考虑“移动前”索引中的动作。例如，如果有 3 个工作表（S1、S2、S3），那么为了将 S1 移到 S2 之前，必须将这些索引设置为 2。如果请求的索引与工作表当前索引相同，或者请求的新索引等于当前工作表索引 + 1，则系统将忽略工作表索引更新请求。

enum (SheetType)

工作表的类型。默认为 GRID。此字段一经设置便无法更改。

object (GridProperties)

如果工作表是网格，则为工作表的其他属性。（如果工作表是包含图表或图片的对象工作表，则此字段将不存在。）在写入时，在非网格工作表上设置任何网格属性会出错。

如果此工作表是 DATA_SOURCE 工作表，则此字段仅输出，但包含反映数据源工作表在界面中的呈现方式的属性，例如 rowCount。

boolean

如果工作表在界面中处于隐藏状态，则为 true；如果工作表可见，则为 false。

object (Color)

界面中的标签页颜色。已弃用：使用 tabColorStyle。

object (ColorStyle)

界面中的标签页颜色。如果也设置了 tabColor，则以此字段为准。

boolean

如果工作表是 RTL 工作表而不是 LTR 工作表，则为 true。

object (DataSourceSheetProperties)

仅供输出。如果存在，则该字段包含 DATA_SOURCE 工作表特定的属性。

{
  "rowCount": integer,
  "columnCount": integer,
  "frozenRowCount": integer,
  "frozenColumnCount": integer,
  "hideGridlines": boolean,
  "rowGroupControlAfter": boolean,
  "columnGroupControlAfter": boolean
}

integer

网格中的行数。

integer

网格中的列数。

integer

网格中冻结的行数。

integer

网格中冻结的列数。

boolean

如果网格未在界面中显示网格线，则为 true。

boolean

如果组之后显示行分组控件切换开关，则为 true。

boolean

如果组分组控件切换开关在组后面显示，则为 true。

{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}

string

工作表连接到的 DataSource 的 ID。

object (DataSourceColumn)

工作表中显示的列，与 RowData 中的值对应。

object (DataExecutionStatus)

数据执行状态。

{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}

integer

此 GridData 的第一行（以 0 为起点）。

integer

此 GridData 的第一列（从零开始）。

object (RowData)

网格中的数据，每行一个条目，从 startRow 中的行开始。RowData 中的值与起始值为 startColumn 的列相对应。

object (DimensionProperties)

有关网格中请求行的元数据，从 startRow 中的行开始。

object (DimensionProperties)

有关网格中请求列的元数据，从 startColumn 中的列开始。

{
  "values": [
    {
      object (CellData)
    }
  ]
}

object (CellData)

每行中的值，每列一个。

{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}

boolean

如果此维度被滤除，则为 true。此字段是只读字段。

boolean

如果此维度已明确隐藏，则为 true。

integer

维度的高度（如果是行）或宽度（如果是列）。

object (DeveloperMetadata)

与单个行或列关联的开发者元数据。

object (DataSourceColumnReference)

仅供输出。如果设置此参数，则会是数据源工作表中的一列。

{
  "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.
}

object (GridRange)

满足相应条件时，用于设置格式的范围。所有范围都必须位于同一网格上。

object (BooleanRule)

根据规则，格式为“开启”或“关闭”。

object (GradientRule)

格式会因规则中的渐变而异。

{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}

object (BooleanCondition)

规则的条件。如果条件的计算结果为 true，则应用格式。

object (CellFormat)

要应用的格式。条件格式设置只能应用一部分格式：bold、italic、strikethrough、foreground color 和 background color。

{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}

object (InterpolationPoint)

起始插值点。

object (InterpolationPoint)

可选的中途插值点。

object (InterpolationPoint)

最终插值点。

{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}

object (Color)

此插值点应使用的颜色。已弃用：使用 colorStyle。

object (ColorStyle)

此插值点应使用的颜色。如果也设置了 color，则以此字段为准。

enum (InterpolationPointType)

应如何解读该值。

string

此插值点使用的值。可以是公式。如果 type 为 MIN 或 MAX，则未使用。

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

integer

过滤视图的 ID。

string

过滤视图的名称。

object (GridRange)

此过滤视图涵盖的范围。

写入时，只能设置 range 或 namedRangeId 中的一个。

string

此过滤视图支持的命名范围（如果有）。

写入时，只能设置 range 或 namedRangeId 中的一个。

object (SortSpec)

每列的排序顺序。如果前面的规范中的值相等，系统会使用更晚的规范。

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

每列显示/隐藏值的条件。映射的键是列索引，值是该列的条件。

此字段已弃用，取而代之的是 filterSpecs。

object (FilterSpec)

按列显示/隐藏值的过滤条件。

系统会在响应中填充 criteria 和 filterSpecs。如果在更新请求中同时指定了这两个字段，则以此字段为准。

{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}

integer

受保护范围的 ID。此字段是只读字段。

object (GridRange)

要保护的范围。该范围可以是完全无界限的，在这种情况下，系统会将其视为受保护的工作表。

写入时，只能设置 range 或 namedRangeId 中的一个。

string

此受保护范围支持的命名范围（如果有）。

写入时，只能设置 range 或 namedRangeId 中的一个。

string

此受保护范围的说明。

boolean

如果此受保护的范围会在修改时显示警告，则为 true。基于警告的保护措施意味着每位用户都可以修改受保护范围内的数据，但修改时系统会发出警告，要求用户确认修改内容。

写入时：如果此字段为 true，则会忽略 editors。此外，如果此字段从 true 更改为 false 并且未设置 editors 字段（也未包含在字段掩码中），则编辑器将设置为文档中的所有编辑器。

boolean

如果请求此受保护范围的用户可以修改受保护的区域，则为 true。此字段是只读字段。

object (GridRange)

受保护工作表中不受保护的范围列表。只有受保护的工作表才支持不受保护的范围。

object (Editors)

对受保护的范围拥有编辑权限的用户和群组。只有对受保护的范围和文档拥有编辑权限的用户才能看到此字段。编辑器不受 warningOnly 保护。

{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}

string

对受保护的范围拥有编辑权限的用户的电子邮件地址。

string

对受保护的范围拥有编辑权限的群组的电子邮件地址。

boolean

如果文档网域中的任何人对受保护的范围拥有编辑权限，则为 true。只有网域内的文档才支持网域保护。

{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}

object (GridRange)

过滤器涵盖的范围。

object (SortSpec)

每列的排序顺序。如果前面的规范中的值相等，系统会使用更晚的规范。

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

每列显示/隐藏值的条件。映射的键是列索引，值是该列的条件。

此字段已弃用，取而代之的是 filterSpecs。

object (FilterSpec)

每列的过滤条件。

系统会在响应中填充 criteria 和 filterSpecs。如果在更新请求中同时指定了这两个字段，则以此字段为准。

{
  "bandedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}

integer

频段范围的 ID。

object (GridRange)

这些属性的应用范围。

object (BandingProperties)

行频段的属性。这些属性会逐行应用于范围中的所有行。必须至少指定 rowProperties 或 columnProperties 中的一个。

object (BandingProperties)

列频段的属性。这些属性逐列应用于范围内的所有列。必须至少指定 rowProperties 或 columnProperties 中的一个。

{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}

object (Color)

第一行或列的颜色。如果已设置此字段，则第一行或第一列会填充此颜色，并且颜色将在第二行 firstBandColor 和 secondBandColor 之间交替。否则，第一行或列会填充 firstBandColor，颜色会继续照常使用。已弃用：使用 headerColorStyle。

object (ColorStyle)

第一行或列的颜色。如果已设置此字段，则第一行或第一列会填充此颜色，并且颜色将在第二行 firstBandColor 和 secondBandColor 之间交替。否则，第一行或列会填充 firstBandColor，颜色会继续照常使用。如果也设置了 headerColor，则以此字段为准。

object (Color)

第一种颜色交替显示。（必需）已弃用：使用 firstBandColorStyle。

object (ColorStyle)

第一种颜色交替显示。（必需）如果还设置了 firstBandColor，则此字段优先。

object (Color)

交替使用的第二种颜色。（必需）已弃用：使用 secondBandColorStyle。

object (ColorStyle)

交替使用的第二种颜色。（必需）如果还设置了 secondBandColor，则此字段优先。

object (Color)

最后一行或该列的颜色。如果未设置此字段，则最后一个行或列填充为 firstBandColor 或 secondBandColor，具体取决于前一行或该列的颜色。已弃用：使用 footerColorStyle。

object (ColorStyle)

最后一行或该列的颜色。如果未设置此字段，则最后一个行或列填充为 firstBandColor 或 secondBandColor，具体取决于前一行或该列的颜色。如果也设置了 footerColor，则以此字段为准。

{
  "range": {
    object (DimensionRange)
  },
  "depth": integer,
  "collapsed": boolean
}

object (DimensionRange)

此群组的存在范围。

integer

组的深度，表示有多少组的范围完全包含该组的范围。

boolean

如果此群组已收起，此字段将为 true。如果展开深度较浅的重叠组，折叠组将保持收起状态。

值为 true 并不意味着组中的所有维度都处于隐藏状态，因为维度的可见性可能会独立于组属性发生变化。不过，更新此属性时，如果此字段为 true，则其中的所有维度均设置为“隐藏”；如果此字段为 false，则设置为“可见”。

{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  }
}

integer

截剪器的 ID。

object (SlicerSpec)

截剪器的规范。

object (EmbeddedObjectPosition)

截剪器的位置。请注意，截剪器只能放置在现有工作表上。此外，截剪器的宽度和高度可以自动调整，以便在允许的范围内。

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

object (GridRange)

截剪器的数据范围。

object (FilterCriteria)

截剪器的过滤条件。

integer

应用过滤条件的数据表中从零开始的列索引。

boolean

如果过滤器应应用于数据透视表，则为 true。如果未设置，则默认为 True。

string

截剪器的标题。

object (TextFormat)

截剪器中标题的文本格式。链接字段不受支持。

object (Color)

截剪器的背景颜色。已弃用：使用 backgroundColorStyle。

object (ColorStyle)

截剪器的背景颜色。如果也设置了 backgroundColor，则以此字段为准。

enum (HorizontalAlign)

截剪器中标题的水平对齐。如果未指定，则默认为 LEFT