工作表
电子表格中的工作表。
| 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),则必须将索引设置为 2,才能将 S1 移到 S2 前面。如果请求的索引与工作表的当前索引相同,或者请求的新索引等于当前工作表索引 + 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,则其中的所有维度都会设为“可见”。  | 
    
切片器
工作表中的切片器。
| JSON 表示法 | 
|---|
      { "slicerId": integer, "spec": { object (  | 
    
| 字段 | |
|---|---|
      slicerId
      | 
     
       
        切片器的 ID。  | 
    
      spec
      | 
     
       
        切片器的规范。  | 
    
      position
      | 
     
       
        切片器的位置。请注意,只有在现有工作表中才能放置切片器。此外,系统还可以自动调整 Slicer 的宽度和高度,使其保持在允许的限制范围内。  | 
    
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 时有效。  |