请求
要应用于电子表格的单一更新类型。
| JSON 表示法 | 
|---|
| { // Union field | 
| 字段 | |
|---|---|
| 联合字段 kind。更新类型。只需正好映射一个字段。kind只能是以下其中一项: | |
| updateSpreadsheetProperties | 
        更新电子表格的属性。 | 
| updateSheetProperties | 
        更新工作表的属性。 | 
| updateDimensionProperties | 
        更新维度的属性。 | 
| updateNamedRange | 
        更新命名的范围。 | 
| repeatCell | 
        在范围内重复单个单元格。 | 
| addNamedRange | 
        添加命名范围。 | 
| deleteNamedRange | 
        删除命名的范围。 | 
| addSheet | 
        添加工作表。 | 
| deleteSheet | 
        删除工作表。 | 
| autoFill | 
        根据现有数据自动填充更多数据。 | 
| cutPaste | 
        剪切某个区域的数据并将其粘贴到另一个区域。 | 
| copyPaste | 
        从一个区域复制数据并将其粘贴到另一个区域。 | 
| mergeCells | 
        合并单元格。 | 
| unmergeCells | 
        取消合并单元格。 | 
| updateBorders | 
        更新单元格范围中的边框。 | 
| updateCells | 
        一次更新多个单元格。 | 
| addFilterView | 
        添加过滤视图。 | 
| appendCells | 
        在工作表中包含数据的最后一行后面附加单元格。 | 
| clearBasicFilter | 
        清除工作表的基本过滤条件。 | 
| deleteDimension | 
        删除工作表中的行或列。 | 
| deleteEmbeddedObject | 
        删除工作表中的嵌入对象(例如图表、图片)。 | 
| deleteFilterView | 
        从工作表中删除过滤视图。 | 
| duplicateFilterView | 
        复制过滤视图。 | 
| duplicateSheet | 
        复制工作表。 | 
| findReplace | 
        查找某些文本并将其替换为其他文本。 | 
| insertDimension | 
        在工作表中插入新行或新列。 | 
| insertRange | 
        在工作表中插入新单元格,并使现有单元格向右移动。 | 
| moveDimension | 
        将行或列移至工作表中的其他位置。 | 
| updateEmbeddedObjectPosition | 
        更新嵌入对象(例如图表、图片)的位置。 | 
| pasteData | 
        将数据(HTML 或分隔格式)粘贴到工作表中。 | 
| textToColumns | 
        将一列文本转换为多列文本。 | 
| updateFilterView | 
        更新过滤器视图的属性。 | 
| deleteRange | 
        从工作表中删除单元格范围,并将剩余单元格向右或向左移动。 | 
| appendDimension | 
        将尺寸附加到工作表的末尾。 | 
| addConditionalFormatRule | 
        添加新的条件格式规则。 | 
| updateConditionalFormatRule | 
        更新现有条件格式规则。 | 
| deleteConditionalFormatRule | 
        删除现有条件格式规则。 | 
| sortRange | 
        对某一范围内的数据进行排序。 | 
| setDataValidation | 
        为一个或多个单元格设置数据验证。 | 
| setBasicFilter | 
        设置工作表的基本过滤条件。 | 
| addProtectedRange | 
        添加受保护的范围。 | 
| updateProtectedRange | 
        更新受保护的范围。 | 
| deleteProtectedRange | 
        删除受保护的范围。 | 
| autoResizeDimensions | 
        根据该维度中单元格的内容自动调整一个或多个维度的大小。 | 
| addChart | 
        添加图表。 | 
| updateChartSpec | 
        更新图表的规范。 | 
| updateBanding | 
        更新带状范围 | 
| addBanding | 
        添加了新的带状范围 | 
| deleteBanding | 
        移除带状范围 | 
| createDeveloperMetadata | 
        创建新的开发者元数据 | 
| updateDeveloperMetadata | 
        更新现有开发者元数据条目 | 
| deleteDeveloperMetadata | 
        删除开发者元数据 | 
| randomizeRange | 
        对范围内的行进行随机排序。 | 
| addDimensionGroup | 
        在指定范围内创建组。 | 
| deleteDimensionGroup | 
        删除指定范围内的组。 | 
| updateDimensionGroup | 
        更新指定组的状态。 | 
| trimWhitespace | 
        剪除单元格中的空白(例如空格、制表符或换行符)。 | 
| deleteDuplicates | 
        移除单元格范围中指定列中包含重复值的行。 | 
| updateEmbeddedObjectBorder | 
        更新嵌入对象的边框。 | 
| addSlicer | 
        添加了分屏。 | 
| updateSlicerSpec | 
        更新 Slicer 的规范。 | 
| addDataSource | 
        添加数据源。 | 
| updateDataSource | 
        更新数据源。 | 
| deleteDataSource | 
        删除数据源。 | 
| refreshDataSource | 
        刷新一个或多个数据源和关联的 dbobject。 | 
| cancelDataSourceRefresh | 
        取消刷新一个或多个数据源和关联的 dbobject。 | 
| addTable | 
        添加表格。 | 
| updateTable | 
        更新表。 | 
| deleteTable | 
        用于删除表的请求。 | 
UpdateSpreadsheetPropertiesRequest
更新电子表格的属性。
| JSON 表示法 | 
|---|
| {
  "properties": {
    object ( | 
| 字段 | |
|---|---|
| properties | 
        要更新的房源。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根“properties”是隐含的,不应指定。单个  | 
UpdateSheetPropertiesRequest
   使用指定的 sheetId 更新工作表的属性。
  
| JSON 表示法 | 
|---|
| {
  "properties": {
    object ( | 
| 字段 | |
|---|---|
| properties | 
        要更新的房源。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
UpdateDimensionPropertiesRequest
更新指定范围内的维度的属性。
| JSON 表示法 | 
|---|
| { "properties": { object ( | 
| 字段 | |
|---|---|
| properties | 
        要更新的房源。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
| 联合字段 dimension_range。维度范围。dimension_range只能是以下其中一项: | |
| range | 
        要更新的行或列。 | 
| dataSourceSheetRange | 
        要更新的数据源工作表中的列。 | 
DataSourceSheetDimensionRange
   DATA_SOURCE 工作表中沿单个维度的范围。
  
| JSON 表示法 | 
|---|
| {
  "sheetId": integer,
  "columnReferences": [
    {
      object ( | 
| 字段 | |
|---|---|
| sheetId | 
        相应范围所在的数据源工作表的 ID。 | 
| columnReferences[] | 
        数据源工作表中的列。 | 
UpdateNamedRangeRequest
   使用指定的 namedRangeId 更新命名范围的属性。
  
| JSON 表示法 | 
|---|
| {
  "namedRange": {
    object ( | 
| 字段 | |
|---|---|
| namedRange | 
        要使用新属性更新的命名范围。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
RepeatCellRequest
   将范围内的所有单元格更新为给定 Cell 对象中的值。只有 fields 字段中列出的字段会更新;其他字段保持不变。
  
   如果使用公式写入单元格,则公式的范围将自动递增范围中的每个字段。例如,如果将公式为 =A1 的单元格写入范围 B2:C4,则 B2 将为 =A1、B3 将为 =A2、B4 将为 =A3、C2 将为 =B1、C3 将为 =B2、C4 将为 =B3。
  
   如需使公式的范围保持不变,请使用 $ 指示器。例如,使用公式 =$A$1 可防止行和列递增。
| JSON 表示法 | 
|---|
| { "range": { object ( | 
| 字段 | |
|---|---|
| range | 
        要重复单元格的范围。 | 
| cell | 
        要写入的数据。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
AddNamedRangeRequest
向电子表格添加命名范围。
| JSON 表示法 | 
|---|
| {
  "namedRange": {
    object ( | 
| 字段 | |
|---|---|
| namedRange | 
        
       要添加的命名范围。 | 
DeleteNamedRangeRequest
从电子表格中移除具有指定 ID 的命名范围。
| JSON 表示法 | 
|---|
| { "namedRangeId": string } | 
| 字段 | |
|---|---|
| namedRangeId | 
        要删除的命名范围的 ID。 | 
AddSheetRequest
   添加新工作表。在给定索引处添加工作表后,所有后续工作表的索引都会递增。如需添加对象工作表,请改用 AddChartRequest,并指定 EmbeddedObjectPosition.sheetId 或 EmbeddedObjectPosition.newSheet。
  
| JSON 表示法 | 
|---|
| {
  "properties": {
    object ( | 
| 字段 | |
|---|---|
| properties | 
        
       新工作表应具有的属性。所有属性均为可选属性。 | 
DeleteSheetRequest
删除请求的工作表。
| JSON 表示法 | 
|---|
| { "sheetId": integer } | 
| 字段 | |
|---|---|
| sheetId | 
        要删除的工作表的 ID。 
       如果工作表的类型为  | 
AutoFillRequest
根据现有数据填充更多数据。
| JSON 表示法 | 
|---|
| { "useAlternateSeries": boolean, // Union field | 
| 字段 | |
|---|---|
| useAlternateSeries | 
        如果应使用“alternate”系列生成数据,则为 true。这因源数据的类型和数量而异。 | 
| 联合字段 area。要自动填充的区域。area只能是以下其中一项: | |
| range | 
        要自动填充的范围。这将检查范围并检测包含数据的位置,并自动将这些数据填充到范围的其余部分。 | 
| sourceAndDestination | 
        要自动填充的来源和目标区域。这会明确列出自动填充功能的来源以及扩展这些数据的位置。 | 
SourceAndDestination
来源范围及其扩展方式的组合。
| JSON 表示法 | 
|---|
| { "source": { object ( | 
| 字段 | |
|---|---|
| source | 
        要用作自动填充来源的数据的位置。 | 
| dimension | 
        应填充数据的维度。 | 
| fillLength | 
        应填充数据的行数或列数。正数会超出来源的最后一行或最后一列。负数会在来源的第一行或第一列之前展开。 | 
CutPasteRequest
将数据从源移动到目的地。
| JSON 表示法 | 
|---|
| { "source": { object ( | 
| 字段 | |
|---|---|
| source | 
        要剪裁的源数据。 | 
| destination | 
        应将数据粘贴到的左上角坐标。 | 
| pasteType | 
        要粘贴的数据类型。无论您粘贴的内容是什么,系统都会剪切所有源数据。 | 
PasteType
应粘贴哪类数据。
| 枚举 | |
|---|---|
| PASTE_NORMAL | 粘贴值、公式、格式和合并内容。 | 
| PASTE_VALUES | 仅粘贴值,不带格式、公式或合并。 | 
| PASTE_FORMAT | 仅粘贴格式和数据验证。 | 
| PASTE_NO_BORDERS | 类似于 PASTE_NORMAL,但没有边框。 | 
| PASTE_FORMULA | 仅粘贴公式。 | 
| PASTE_DATA_VALIDATION | 仅粘贴数据验证。 | 
| PASTE_CONDITIONAL_FORMATTING | 仅粘贴条件格式规则。 | 
CopyPasteRequest
将数据从源复制到目标。
| JSON 表示法 | 
|---|
| { "source": { object ( | 
| 字段 | |
|---|---|
| source | 
        要复制的源范围。 | 
| destination | 
        要粘贴到的位置。如果范围涵盖的跨度是源图像高度或宽度的倍数,则系统会重复数据以填充目标范围。如果范围小于来源范围,系统仍会复制整个来源数据(超出目的地范围的部分)。 | 
| pasteType | 
        要粘贴的数据类型。 | 
| pasteOrientation | 
        粘贴时数据的方向。 | 
PasteOrientation
应如何执行粘贴操作。
| 枚举 | |
|---|---|
| NORMAL | 正常粘贴。 | 
| TRANSPOSE | 粘贴转置,其中所有行都变为列,反之亦然。 | 
MergeCellsRequest
合并范围内的所有单元格。
| JSON 表示法 | 
|---|
| { "range": { object ( | 
| 字段 | |
|---|---|
| range | 
        要合并的单元格范围。 | 
| mergeType | 
        单元格应如何合并。 | 
MergeType
要创建的合并类型。
| 枚举 | |
|---|---|
| MERGE_ALL | 从范围创建单个合并 | 
| MERGE_COLUMNS | 为范围内的每个列创建一个合并 | 
| MERGE_ROWS | 为范围中的每一行创建一个合并 | 
UnmergeCellsRequest
取消合并给定范围内的单元格。
| JSON 表示法 | 
|---|
| {
  "range": {
    object ( | 
| 字段 | |
|---|---|
| range | 
        应取消合并其中所有单元格的范围。如果范围跨越多个合并,则所有合并都会解除。范围不得部分跨越任何合并单元。 | 
UpdateBordersRequest
更新范围的边界。如果请求中未设置某个字段,则表示相应边界保持不变。例如,对于两个后续的 UpdateBordersRequest:
- 
    范围:A1:A5
    { top: RED, bottom: WHITE }
- 
    范围:A1:A5
    { left: BLUE }
   这会导致 A1:A5 具有 { top: RED, bottom: WHITE, left: BLUE } 边框。如果您想清除边框,请将样式明确设置为 NONE。
  
| JSON 表示法 | 
|---|
| { "range": { object ( | 
| 字段 | |
|---|---|
| range | 
        应更新边框的范围。 | 
| top | 
        要放置在范围顶部的边框。 | 
| bottom | 
        要放置在范围底部的边框。 | 
| left | 
        要放置在范围左侧的边框。 | 
| right | 
        要放置在范围右侧的边框。 | 
| innerHorizontal | 
        要放置在范围内的水平边框。 | 
| innerVertical | 
        要放置在范围内的垂直边框。 | 
UpdateCellsRequest
使用新数据更新范围内的所有单元格。
| JSON 表示法 | 
|---|
| { "rows": [ { object ( | 
| 字段 | |
|---|---|
| rows[] | 
        要写入的数据。 | 
| fields | 
        
       应更新的 CellData 字段。必须至少指定一个字段。根是 CellData;不应指定“row.values”。单个  | 
| 联合字段 area。应写入位置数据。必须设置一个值。area只能是以下其中一项: | |
| start | 
        开始写入数据的坐标。可以写入任意数量的行和列(包括每行不同的列数)。 | 
| range | 
        要写入数据的范围。 
       如果行中的数据未涵盖请求的整个范围,系统会清除与  | 
AddFilterViewRequest
添加过滤视图。
| JSON 表示法 | 
|---|
| {
  "filter": {
    object ( | 
| 字段 | |
|---|---|
| filter | 
        
       要添加的过滤条件。 | 
AppendCellsRequest
在工作表中包含数据的最后一行后面添加新单元格,并根据需要将新行插入工作表中。
| JSON 表示法 | 
|---|
| { "sheetId": integer, "rows": [ { object ( | 
| 字段 | |
|---|---|
| sheetId | 
        要将数据附加到的工作表 ID。 | 
| rows[] | 
        要附加的数据。 | 
| fields | 
        
       应更新的 CellData 字段。必须至少指定一个字段。根是 CellData;不应指定“row.values”。单个  | 
| 联合字段 area。应写入位置数据。area只能是以下其中一项: | |
| tableId | 
        要将数据附加到的表的 ID。数据将仅附加到表格正文。 
       此字段的优先级也高于  | 
ClearBasicFilterRequest
清除工作表中的基本过滤条件(如果有)。
| JSON 表示法 | 
|---|
| { "sheetId": integer } | 
| 字段 | |
|---|---|
| sheetId | 
        应清除基本过滤条件的电子表格 ID。 | 
DeleteDimensionRequest
从工作表中删除维度。
| JSON 表示法 | 
|---|
| {
  "range": {
    object ( | 
| 字段 | |
|---|---|
| range | 
        要从工作表中删除的维度。 | 
DeleteEmbeddedObjectRequest
删除具有给定 ID 的嵌入对象。
| JSON 表示法 | 
|---|
| { "objectId": integer } | 
| 字段 | |
|---|---|
| objectId | 
        要删除的嵌入对象的 ID。 | 
DeleteFilterViewRequest
删除特定的过滤条件视图。
| JSON 表示法 | 
|---|
| { "filterId": integer } | 
| 字段 | |
|---|---|
| filterId | 
        要删除的过滤条件的 ID。 | 
DuplicateFilterViewRequest
复制特定过滤视图。
| JSON 表示法 | 
|---|
| { "filterId": integer } | 
| 字段 | |
|---|---|
| filterId | 
        要复制的过滤条件的 ID。 | 
DuplicateSheetRequest
复制工作表中的内容。
| JSON 表示法 | 
|---|
| { "sourceSheetId": integer, "insertSheetIndex": integer, "newSheetId": integer, "newSheetName": string } | 
| 字段 | |
|---|---|
| sourceSheetId | 
        要复制的工作表。 
       如果来源工作表的类型为  | 
| insertSheetIndex | 
        应插入新工作表的索引(从 0 开始)。此后,所有工作表的编号都会递增。 | 
| newSheetId | 
        如果已设置,则为新工作表的 ID。如果未设置,系统会选择一个 ID。如果设置了此 ID,则该 ID 不得与任何现有工作表 ID 冲突。如果设置,则必须为非负数。 | 
| newSheetName | 
        新工作表的名称。如果留空,系统会为您选择一个新名称。 | 
FindReplaceRequest
查找并替换单元格范围、工作表或所有工作表中的单元格数据。
| JSON 表示法 | 
|---|
| { "find": string, "replacement": string, "matchCase": boolean, "matchEntireCell": boolean, "searchByRegex": boolean, "includeFormulas": boolean, // Union field | 
| 字段 | |
|---|---|
| find | 
        要搜索的值。 | 
| replacement | 
        要用作替换项的值。 | 
| matchCase | 
        如果搜索区分大小写,则为 true。 | 
| matchEntireCell | 
        如果要查找的值应与整个单元格匹配,则为 true。 | 
| searchByRegex | 
        
       如果查找值是正则表达式,则为 true。正则表达式和替换项应遵循 https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html 中的 Java 正则表达式规则。替换字符串可以引用捕获组。例如,如果一个单元格的值为  | 
| includeFormulas | 
        如果搜索应包含包含公式的单元格,则为 true。为 False 时,会跳过包含公式的单元格。 | 
| 联合字段 scope。要查找/替换的范围 - 必须设置一个且仅一个。scope只能是以下其中一项: | |
| range | 
        要查找/替换的范围。 | 
| sheetId | 
        要查找/替换内容的表格。 | 
| allSheets | 
        为 true 时,在所有工作表中查找/替换。 | 
InsertDimensionRequest
在工作表中特定编号的位置插入行或列。
| JSON 表示法 | 
|---|
| {
  "range": {
    object ( | 
| 字段 | |
|---|---|
| range | 
        要插入的维度。起始索引和结束索引都必须有界。 | 
| inheritFromBefore | 
        维度属性是从新插入的维度之前还是之后的维度延伸。设为 true 以从前面的维度继承(在这种情况下,起始索引必须大于 0),设为 false 以从后面的维度继承。 
       例如,如果行索引 0 的背景为红色,行索引 1 的背景为绿色,那么在索引 1 处插入 2 行可以继承绿色或红色背景。如果  | 
InsertRangeRequest
将单元格插入到范围中,并将现有单元格向右或向下移动。
| JSON 表示法 | 
|---|
| { "range": { object ( | 
| 字段 | |
|---|---|
| range | 
        要插入新单元格的范围。范围受当前工作表边界限制。 | 
| shiftDimension | 
        | 
MoveDimensionRequest
移动一行或多行或一列或多列。
| JSON 表示法 | 
|---|
| {
  "source": {
    object ( | 
| 字段 | |
|---|---|
| source | 
        要移动的来源维度。 | 
| destinationIndex | 
        源数据移至何处(基于从网格中移除源数据之前的坐标)的从零开始的起始索引。现有数据将向下或向右(具体取决于维度)偏移,以便为移动的维度腾出空间。系统会从网格中移除来源维度,因此数据最终可能会出现在指定的索引之外。 
       例如,假设  | 
UpdateEmbeddedObjectPositionRequest
更新嵌入对象的位置(例如移动或调整图表或图片的大小)。
| JSON 表示法 | 
|---|
| {
  "objectId": integer,
  "newPosition": {
    object ( | 
| 字段 | |
|---|---|
| objectId | 
        要移动的对象的 ID。 | 
| newPosition | 
        
       要将嵌入对象移到的显式位置。如果设置了  | 
| fields | 
        
       设置新位置时应更新的  | 
PasteDataRequest
将数据插入到电子表格中,从指定的坐标开始。
| JSON 表示法 | 
|---|
| { "coordinate": { object ( | 
| 字段 | |
|---|---|
| coordinate | 
        应开始插入数据的坐标。 | 
| data | 
        要插入的数据。 | 
| type | 
        数据的粘贴方式。 | 
| 联合字段 kind。必须设置一个值,以便确定如何解读数据。kind只能是以下其中一项: | |
| delimiter | 
        数据中的分隔符。 | 
| html | 
        如果数据为 HTML,则为 true。 | 
TextToColumnsRequest
根据每个单元格中的分隔符,将一列文本拆分为多列。
| JSON 表示法 | 
|---|
| { "source": { object ( | 
| 字段 | |
|---|---|
| source | 
        源数据范围。此值必须仅占一列。 | 
| delimiter | 
        
       要使用的分隔符。仅当 delimiterType 为  | 
| delimiterType | 
        要使用的分隔符类型。 | 
DelimiterType
用于拆分的分隔符。
| 枚举 | |
|---|---|
| DELIMITER_TYPE_UNSPECIFIED | 默认值。不得使用此值。 | 
| COMMA | ”“ | 
| SEMICOLON | ";" | 
| PERIOD | "." | 
| SPACE | " " | 
| CUSTOM | 分隔符中定义的自定义值。 | 
| AUTODETECT | 自动检测列。 | 
UpdateFilterViewRequest
更新过滤器视图的属性。
| JSON 表示法 | 
|---|
| {
  "filter": {
    object ( | 
| 字段 | |
|---|---|
| filter | 
        过滤视图的新属性。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
DeleteRangeRequest
删除一组单元格,并将其他单元格移至已删除区域。
| JSON 表示法 | 
|---|
| { "range": { object ( | 
| 字段 | |
|---|---|
| range | 
        要删除的单元格范围。 | 
| shiftDimension | 
        
       要用来替换已删除单元格的维度。如果为  | 
AppendDimensionRequest
将行或列附加到工作表的末尾。
| JSON 表示法 | 
|---|
| {
  "sheetId": integer,
  "dimension": enum ( | 
| 字段 | |
|---|---|
| sheetId | 
        要附加行或列的工作表。 | 
| dimension | 
        是否应附加行或列。 | 
| length | 
        要附加的行数或列数。 | 
AddConditionalFormatRuleRequest
在给定索引处添加新的条件格式规则。所有后续规则的索引都会递增。
| JSON 表示法 | 
|---|
| {
  "rule": {
    object ( | 
| 字段 | |
|---|---|
| rule | 
        要添加的规则。 | 
| index | 
        应插入规则的索引(从零开始)。 | 
UpdateConditionalFormatRuleRequest
更新指定索引处的条件格式规则,或将条件格式规则移至另一个索引。
| JSON 表示法 | 
|---|
| { "index": integer, "sheetId": integer, // Union field | 
| 字段 | |
|---|---|
| index | 
        应替换或移动的规则的索引(从零开始)。 | 
| sheetId | 
        
       要移动的规则所在的表格。如果设置了  | 
| 联合字段 instruction。应发生的更新类型。instruction只能是以下其中一项: | |
| rule | 
        应替换给定索引处的规则的规则。 | 
| newIndex | 
        规则应在其中结束的新索引(从零开始)。 | 
DeleteConditionalFormatRuleRequest
删除指定索引处的条件格式规则。所有后续规则的编号都会递减。
| JSON 表示法 | 
|---|
| { "index": integer, "sheetId": integer } | 
| 字段 | |
|---|---|
| index | 
        要删除的规则的索引(从零开始)。 | 
| sheetId | 
        要删除规则所在的工作表。 | 
SortRangeRequest
根据每列的排序顺序对行数据进行排序。
| JSON 表示法 | 
|---|
| { "range": { object ( | 
| 字段 | |
|---|---|
| range | 
        要排序的范围。 | 
| sortSpecs[] | 
        每列的排序顺序。如果早期规范中的值相同,则使用较新的规范。 | 
SetDataValidationRequest
为范围中的每个单元格设置数据验证规则。如需清除某个范围内的验证,请在不指定规则的情况下调用此方法。
| JSON 表示法 | 
|---|
| { "range": { object ( | 
| 字段 | |
|---|---|
| range | 
        数据验证规则应应用到的范围。 | 
| rule | 
        要对范围中的每个单元格设置的数据验证规则,如果为空,则清除范围中的数据验证。 | 
| filteredRowsIncluded | 
        可选。如果为 true,则数据验证规则也会应用于过滤后的行。 | 
SetBasicFilterRequest
设置与工作表关联的基本过滤条件。
| JSON 表示法 | 
|---|
| {
  "filter": {
    object ( | 
| 字段 | |
|---|---|
| filter | 
        要设置的过滤条件。 | 
AddProtectedRangeRequest
添加了新的受保护范围。
| JSON 表示法 | 
|---|
| {
  "protectedRange": {
    object ( | 
| 字段 | |
|---|---|
| protectedRange | 
        
       要添加的受保护范围。 | 
UpdateProtectedRangeRequest
   使用指定的 protectedRangeId 更新现有的受保护范围。
  
| JSON 表示法 | 
|---|
| {
  "protectedRange": {
    object ( | 
| 字段 | |
|---|---|
| protectedRange | 
        要使用新属性更新的受保护范围。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
DeleteProtectedRangeRequest
删除具有指定 ID 的受保护范围。
| JSON 表示法 | 
|---|
| { "protectedRangeId": integer } | 
| 字段 | |
|---|---|
| protectedRangeId | 
        要删除的受保护范围的 ID。 | 
AutoResizeDimensionsRequest
根据该维度中单元格的内容自动调整一个或多个维度的大小。
| JSON 表示法 | 
|---|
| { // Union field | 
| 字段 | |
|---|---|
| 联合字段 dimension_range。维度范围。dimension_range只能是以下其中一项: | |
| dimensions | 
        要自动调整大小的尺寸。 | 
| dataSourceSheetDimensions | 
        数据源工作表上要自动调整大小的尺寸。 | 
AddChartRequest
将图表添加到电子表格中的工作表。
| JSON 表示法 | 
|---|
| {
  "chart": {
    object ( | 
| 字段 | |
|---|---|
| chart | 
        
       应添加到电子表格中的图表,包括其应放置的位置。 | 
UpdateChartSpecRequest
   更新图表的规范。(这不会移动或调整图表大小。如需移动或调整图表大小,请使用 UpdateEmbeddedObjectPositionRequest。)
  
| JSON 表示法 | 
|---|
| {
  "chartId": integer,
  "spec": {
    object ( | 
| 字段 | |
|---|---|
| chartId | 
        要更新的图表的 ID。 | 
| spec | 
        要应用于图表的规范。 | 
UpdateBandingRequest
更新所提供的带状范围的属性。
| JSON 表示法 | 
|---|
| {
  "bandedRange": {
    object ( | 
| 字段 | |
|---|---|
| bandedRange | 
        要使用新属性更新的带状范围。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
AddBandingRequest
向电子表格中添加新的带状范围。
| JSON 表示法 | 
|---|
| {
  "bandedRange": {
    object ( | 
| 字段 | |
|---|---|
| bandedRange | 
        
       要添加的带状范围。 | 
DeleteBandingRequest
从电子表格中移除具有指定 ID 的分组范围。
| JSON 表示法 | 
|---|
| { "bandedRangeId": integer } | 
| 字段 | |
|---|---|
| bandedRangeId | 
        要删除的分组范围的 ID。 | 
CreateDeveloperMetadataRequest
创建开发者元数据的请求。
| JSON 表示法 | 
|---|
| {
  "developerMetadata": {
    object ( | 
| 字段 | |
|---|---|
| developerMetadata | 
        要创建的开发者元数据。 | 
UpdateDeveloperMetadataRequest
   用于更新开发者元数据属性的请求。将过滤条件选择的开发者元数据的属性更新为 DeveloperMetadata 资源中提供的值。调用方必须在 fields 参数中指定要更新的属性,并指定至少一个与要更新的元数据匹配的 DataFilter。
| JSON 表示法 | 
|---|
| { "dataFilters": [ { object ( | 
| 字段 | |
|---|---|
| dataFilters[] | 
        与要更新的开发者元数据条目匹配的过滤条件。 | 
| developerMetadata | 
        数据过滤条件匹配的所有元数据将更新到的值。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
DeleteDeveloperMetadataRequest
删除开发者元数据的请求。
| JSON 表示法 | 
|---|
| {
  "dataFilter": {
    object ( | 
| 字段 | |
|---|---|
| dataFilter | 
        用于描述用于选择要删除的开发者元数据条目的条件的数据过滤器。 | 
RandomizeRangeRequest
对范围内的行进行随机排序。
| JSON 表示法 | 
|---|
| {
  "range": {
    object ( | 
| 字段 | |
|---|---|
| range | 
        要随机化的范围。 | 
AddDimensionGroupRequest
在指定范围内创建组。
如果请求的范围是现有组 G 的范围的超集,则 G 的深度会递增,并且这个新组 G' 的深度与该组相同。例如,组 [C:D, depth 1] + [B:E] 会生成组 [B:E, depth 1] 和 [C:D, depth 2]。如果请求的范围是现有组 G 的范围的子集,则新组 G' 的深度将比 G 的深度多 1。例如,组 [B:E,深度 1] + [C:D] 会生成组 [B:E,深度 1] 和 [C:D,深度 2]。如果请求的范围在现有组 G 的范围之前开始且在其范围内结束,或者在其范围内开始且在其范围之后结束,则现有组 G 的范围变为范围的并集,新组 G' 的深度比 G 的深度大 1,并且范围为范围的交集。例如,组 [B:D,深度 1] + [C:E] 会生成组 [B:E,深度 1] 和 [C:D,深度 2]。
| JSON 表示法 | 
|---|
| {
  "range": {
    object ( | 
| 字段 | |
|---|---|
| range | 
        要创建组的范围。 | 
DeleteDimensionGroupRequest
通过递减指定范围内维度的深度,删除指定范围内的组。
例如,假设工作表在 B:E 上有一个深度为 1 的组,在 C:D 上有一个深度为 2 的组。删除 D:E 上的组后,工作表中会保留 B:D 上的深度为 1 的组和 C:C 上的深度为 2 的组。
| JSON 表示法 | 
|---|
| {
  "range": {
    object ( | 
| 字段 | |
|---|---|
| range | 
        要删除的组的范围。 | 
UpdateDimensionGroupRequest
更新指定组的状态。
| JSON 表示法 | 
|---|
| {
  "dimensionGroup": {
    object ( | 
| 字段 | |
|---|---|
| dimensionGroup | 
        应更新状态的组。组的范围和深度应指定工作表上的有效组,并更新所有其他字段。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
TrimWhitespaceRequest
剪除指定范围中每个单元格中的空白(例如空格、制表符或换行符)。此请求会移除每个单元格文本开头和结尾的所有空格,并将剩余空格字符的任何子序列缩减为单个空格。如果截断后的文本以“+”或“=”字符开头,则文本将保持为字符串值,而不会被解读为公式。
| JSON 表示法 | 
|---|
| {
  "range": {
    object ( | 
| 字段 | |
|---|---|
| range | 
        要修剪单元格的范围。 | 
DeleteDuplicatesRequest
移除此范围内包含指定列中与任何前一行值重复的值的行。即使行内的值字母大小写、格式设置、所用公式不一样,但是值相同,则均会被视为重复内容。
此请求还会移除隐藏在视图之外的重复行(例如,由于过滤器)。移除重复项时,从上往下扫描每个重复行的第一个实例会保留在生成的范围内。系统不会移除指定范围之外的内容,并且被视为重复的行在范围内不必彼此相邻。
| JSON 表示法 | 
|---|
| { "range": { object ( | 
| 字段 | |
|---|---|
| range | 
        要从中移除重复行的范围。 | 
| comparisonColumns[] | 
        要分析是否存在重复值的范围中的列。如果未选择任何列,则系统会分析所有列以查找重复项。 | 
UpdateEmbeddedObjectBorderRequest
更新嵌入对象的边框属性。
| JSON 表示法 | 
|---|
| {
  "objectId": integer,
  "border": {
    object ( | 
| 字段 | |
|---|---|
| objectId | 
        要更新的嵌入对象的 ID。 | 
| border | 
        应用于嵌入对象的边框。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
AddSlicerRequest
向电子表格中的工作表添加切片器。
| JSON 表示法 | 
|---|
| {
  "slicer": {
    object ( | 
| 字段 | |
|---|---|
| slicer | 
        
       应添加到电子表格中的切片器,包括其应放置的位置。 | 
UpdateSlicerSpecRequest
   更新 Slicer 的规范。(这不会移动或调整 Slicer 的大小。如需移动或调整切片器的大小,请使用 UpdateEmbeddedObjectPositionRequest。
  
| JSON 表示法 | 
|---|
| {
  "slicerId": integer,
  "spec": {
    object ( | 
| 字段 | |
|---|---|
| slicerId | 
        要更新的分屏的 ID。 | 
| spec | 
        要应用于 Slicer 的规范。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
AddDataSourceRequest
   添加数据源。成功添加数据源后,系统会创建关联的 DATA_SOURCE 工作表,并触发执行以刷新工作表,以便从数据源读取数据。
  
   如果您要添加 BigQuery 数据源,则请求需要额外的 bigquery.readonly OAuth 范围。
  
| JSON 表示法 | 
|---|
| {
  "dataSource": {
    object ( | 
| 字段 | |
|---|---|
| dataSource | 
        要添加的数据源。 | 
UpdateDataSourceRequest
   更新数据源。成功更新数据源后,系统会触发执行操作以刷新关联的 DATA_SOURCE 工作表,以便从更新后的数据源读取数据。
  
   如果您要更新 BigQuery 数据源,则请求需要额外的 bigquery.readonly OAuth 范围。
| JSON 表示法 | 
|---|
| {
  "dataSource": {
    object ( | 
| 字段 | |
|---|---|
| dataSource | 
        要更新的数据源。 | 
| fields | 
        
       应更新的字段。必须至少指定一个字段。根  | 
DeleteDataSourceRequest
删除数据源。该请求还会删除关联的数据源工作表,并解除关联所有关联的数据源对象。
| JSON 表示法 | 
|---|
| { "dataSourceId": string } | 
| 字段 | |
|---|---|
| dataSourceId | 
        要删除的数据源的 ID。 | 
RefreshDataSourceRequest
根据指定的引用刷新电子表格中的一个或多个数据源对象。
   如果您要刷新 BigQuery 数据源,则请求需要额外的 bigquery.readonly OAuth 范围。
  
如果一个批次中包含多个引用同一数据源对象的刷新请求,系统只会处理最后一个刷新请求,并且所有这些请求都会收到相同的响应。
| JSON 表示法 | 
|---|
| { "force": boolean, // Union field | 
| 字段 | |
|---|---|
| force | 
        无论当前状态如何,都会刷新数据源对象。如果未设置,并且引用的数据源对象处于错误状态,刷新将立即失败。 | 
| 联合字段 target。指定要刷新的内容。target只能是以下其中一项: | |
| references | 
        对要刷新的数据源对象的引用。 | 
| dataSourceId | 
        
       对  | 
| isAll | 
        刷新电子表格中的所有现有数据源对象。 | 
DataSourceObjectReferences
对数据源对象的引用列表。
| JSON 表示法 | 
|---|
| {
  "references": [
    {
      object ( | 
| 字段 | |
|---|---|
| references[] | 
        参考文献。 | 
DataSourceObjectReference
对数据源对象的引用。
| JSON 表示法 | 
|---|
| { // Union field | 
| 字段 | |
|---|---|
| 联合字段 value。引用类型。value只能是以下其中一项: | |
| sheetId | 
        
       对  | 
| chartId | 
        对数据源图表的引用。 | 
| dataSourceTableAnchorCell | 
        
       对锚定到单元格的  | 
| dataSourcePivotTableAnchorCell | 
        
       对数据源的引用
        | 
| dataSourceFormulaCell | 
        
       对包含  | 
CancelDataSourceRefreshRequest
根据指定的引用取消对电子表格中一个或多个数据源对象的刷新。
   如果您要取消 BigQuery 数据源的刷新,则请求需要额外的 bigquery.readonly OAuth 范围。
| JSON 表示法 | 
|---|
| { // Union field | 
| 字段 | |
|---|---|
| 联合字段 target。指定要取消的内容。target只能是以下其中一项: | |
| references | 
        对要取消刷新的数据源对象的引用。 | 
| dataSourceId | 
        
       对  | 
| isAll | 
        取消电子表格中所有数据源的所有现有数据源对象刷新。 | 
AddTableRequest
向电子表格中添加新表格。
| JSON 表示法 | 
|---|
| {
  "table": {
    object ( | 
| 字段 | |
|---|---|
| table | 
        必需。要添加的表。 | 
UpdateTableRequest
更新电子表格中的表格。
| JSON 表示法 | 
|---|
| {
  "table": {
    object ( | 
| 字段 | |
|---|---|
| table | 
        必需。要更新的表。 | 
| fields | 
        
       必需。应更新的字段。必须至少指定一个字段。根  | 
DeleteTableRequest
从电子表格中移除具有指定 ID 的表格。
| JSON 表示法 | 
|---|
| { "tableId": string } | 
| 字段 | |
|---|---|
| tableId | 
        要删除的表的 ID。 |