Requests

请求

要应用于电子表格的单一更新类型。

JSON 表示法 
{

  // Union field kind can be only one of the following:
  "updateSpreadsheetProperties": {
    object (UpdateSpreadsheetPropertiesRequest)
  },
  "updateSheetProperties": {
    object (UpdateSheetPropertiesRequest)
  },
  "updateDimensionProperties": {
    object (UpdateDimensionPropertiesRequest)
  },
  "updateNamedRange": {
    object (UpdateNamedRangeRequest)
  },
  "repeatCell": {
    object (RepeatCellRequest)
  },
  "addNamedRange": {
    object (AddNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "addSheet": {
    object (AddSheetRequest)
  },
  "deleteSheet": {
    object (DeleteSheetRequest)
  },
  "autoFill": {
    object (AutoFillRequest)
  },
  "cutPaste": {
    object (CutPasteRequest)
  },
  "copyPaste": {
    object (CopyPasteRequest)
  },
  "mergeCells": {
    object (MergeCellsRequest)
  },
  "unmergeCells": {
    object (UnmergeCellsRequest)
  },
  "updateBorders": {
    object (UpdateBordersRequest)
  },
  "updateCells": {
    object (UpdateCellsRequest)
  },
  "addFilterView": {
    object (AddFilterViewRequest)
  },
  "appendCells": {
    object (AppendCellsRequest)
  },
  "clearBasicFilter": {
    object (ClearBasicFilterRequest)
  },
  "deleteDimension": {
    object (DeleteDimensionRequest)
  },
  "deleteEmbeddedObject": {
    object (DeleteEmbeddedObjectRequest)
  },
  "deleteFilterView": {
    object (DeleteFilterViewRequest)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewRequest)
  },
  "duplicateSheet": {
    object (DuplicateSheetRequest)
  },
  "findReplace": {
    object (FindReplaceRequest)
  },
  "insertDimension": {
    object (InsertDimensionRequest)
  },
  "insertRange": {
    object (InsertRangeRequest)
  },
  "moveDimension": {
    object (MoveDimensionRequest)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionRequest)
  },
  "pasteData": {
    object (PasteDataRequest)
  },
  "textToColumns": {
    object (TextToColumnsRequest)
  },
  "updateFilterView": {
    object (UpdateFilterViewRequest)
  },
  "deleteRange": {
    object (DeleteRangeRequest)
  },
  "appendDimension": {
    object (AppendDimensionRequest)
  },
  "addConditionalFormatRule": {
    object (AddConditionalFormatRuleRequest)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleRequest)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleRequest)
  },
  "sortRange": {
    object (SortRangeRequest)
  },
  "setDataValidation": {
    object (SetDataValidationRequest)
  },
  "setBasicFilter": {
    object (SetBasicFilterRequest)
  },
  "addProtectedRange": {
    object (AddProtectedRangeRequest)
  },
  "updateProtectedRange": {
    object (UpdateProtectedRangeRequest)
  },
  "deleteProtectedRange": {
    object (DeleteProtectedRangeRequest)
  },
  "autoResizeDimensions": {
    object (AutoResizeDimensionsRequest)
  },
  "addChart": {
    object (AddChartRequest)
  },
  "updateChartSpec": {
    object (UpdateChartSpecRequest)
  },
  "updateBanding": {
    object (UpdateBandingRequest)
  },
  "addBanding": {
    object (AddBandingRequest)
  },
  "deleteBanding": {
    object (DeleteBandingRequest)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataRequest)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataRequest)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataRequest)
  },
  "randomizeRange": {
    object (RandomizeRangeRequest)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupRequest)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupRequest)
  },
  "updateDimensionGroup": {
    object (UpdateDimensionGroupRequest)
  },
  "trimWhitespace": {
    object (TrimWhitespaceRequest)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesRequest)
  },
  "updateEmbeddedObjectBorder": {
    object (UpdateEmbeddedObjectBorderRequest)
  },
  "addSlicer": {
    object (AddSlicerRequest)
  },
  "updateSlicerSpec": {
    object (UpdateSlicerSpecRequest)
  },
  "addDataSource": {
    object (AddDataSourceRequest)
  },
  "updateDataSource": {
    object (UpdateDataSourceRequest)
  },
  "deleteDataSource": {
    object (DeleteDataSourceRequest)
  },
  "refreshDataSource": {
    object (RefreshDataSourceRequest)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshRequest)
  }
  // End of list of possible types for union field kind.
}
字段
联合字段 kind。更新类型。只需正好映射一个字段。 kind只能是以下其中一项：
updateSpreadsheetProperties

object (UpdateSpreadsheetPropertiesRequest)

更新电子表格的属性。

updateSheetProperties

object (UpdateSheetPropertiesRequest)

更新工作表的属性。

updateDimensionProperties

object (UpdateDimensionPropertiesRequest)

更新维度的属性。

updateNamedRange

object (UpdateNamedRangeRequest)

更新命名的范围。

repeatCell

object (RepeatCellRequest)

在范围内重复单个单元格。

addNamedRange

object (AddNamedRangeRequest)

添加命名范围。

deleteNamedRange

object (DeleteNamedRangeRequest)

删除命名的范围。

addSheet

object (AddSheetRequest)

添加工作表。

deleteSheet

object (DeleteSheetRequest)

删除工作表。

autoFill

object (AutoFillRequest)

根据现有数据自动填充更多数据。

cutPaste

object (CutPasteRequest)

剪切某个区域的数据并将其粘贴到另一个区域。

copyPaste

object (CopyPasteRequest)

从一个区域复制数据并将其粘贴到另一个区域。

mergeCells

object (MergeCellsRequest)

合并单元格。

unmergeCells

object (UnmergeCellsRequest)

取消合并单元格。

updateBorders

object (UpdateBordersRequest)

更新单元格范围中的边框。

updateCells

object (UpdateCellsRequest)

一次更新多个单元格。

addFilterView

object (AddFilterViewRequest)

添加过滤视图。

appendCells

object (AppendCellsRequest)

在表格中包含数据的最后一行后面附加单元格。

clearBasicFilter

object (ClearBasicFilterRequest)

清除工作表的基本过滤条件。

deleteDimension

object (DeleteDimensionRequest)

删除工作表中的行或列。

deleteEmbeddedObject

object (DeleteEmbeddedObjectRequest)

删除工作表中的嵌入对象（例如图表、图片）。

deleteFilterView

object (DeleteFilterViewRequest)

从工作表中删除过滤视图。

duplicateFilterView

object (DuplicateFilterViewRequest)

复制过滤视图。

duplicateSheet

object (DuplicateSheetRequest)

复制工作表。

findReplace

object (FindReplaceRequest)

查找某些文本并将其替换为其他文本。

insertDimension

object (InsertDimensionRequest)

在工作表中插入新行或新列。

insertRange

object (InsertRangeRequest)

在工作表中插入新单元格，并使现有单元格向右移动。

moveDimension

object (MoveDimensionRequest)

将行或列移至工作表中的其他位置。

updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionRequest)

更新嵌入对象（例如图表、图片）的位置。

pasteData

object (PasteDataRequest)

将数据（HTML 或分隔格式）粘贴到工作表中。

textToColumns

object (TextToColumnsRequest)

将一列文本转换为多列文本。

updateFilterView

object (UpdateFilterViewRequest)

更新过滤器视图的属性。

deleteRange

object (DeleteRangeRequest)

从工作表中删除单元格范围，并将其余单元格向右或向左移动。

appendDimension

object (AppendDimensionRequest)

将尺寸附加到工作表的末尾。

addConditionalFormatRule

object (AddConditionalFormatRuleRequest)

添加了新的条件格式规则。

updateConditionalFormatRule

object (UpdateConditionalFormatRuleRequest)

更新现有条件格式规则。

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleRequest)

删除现有条件格式规则。

sortRange

object (SortRangeRequest)

对范围内的数据进行排序。

setDataValidation

object (SetDataValidationRequest)

为一个或多个单元格设置数据验证。

setBasicFilter

object (SetBasicFilterRequest)

设置工作表的基本过滤条件。

addProtectedRange

object (AddProtectedRangeRequest)

添加受保护的范围。

updateProtectedRange

object (UpdateProtectedRangeRequest)

更新受保护的范围。

deleteProtectedRange

object (DeleteProtectedRangeRequest)

删除受保护的范围。

autoResizeDimensions

object (AutoResizeDimensionsRequest)

根据该维度中单元格的内容自动调整一个或多个维度的大小。

addChart

object (AddChartRequest)

添加图表。

updateChartSpec

object (UpdateChartSpecRequest)

更新图表的规范。

updateBanding

object (UpdateBandingRequest)

更新带状范围

addBanding

object (AddBandingRequest)

添加了新的带状范围

deleteBanding

object (DeleteBandingRequest)

移除带状范围

createDeveloperMetadata

object (CreateDeveloperMetadataRequest)

创建新的开发者元数据

updateDeveloperMetadata

object (UpdateDeveloperMetadataRequest)

更新现有开发者元数据条目

deleteDeveloperMetadata

object (DeleteDeveloperMetadataRequest)

删除开发者元数据

randomizeRange

object (RandomizeRangeRequest)

对范围内的行进行随机排序。

addDimensionGroup

object (AddDimensionGroupRequest)

在指定范围内创建组。

deleteDimensionGroup

object (DeleteDimensionGroupRequest)

删除指定范围内的组。

updateDimensionGroup

object (UpdateDimensionGroupRequest)

更新指定组的状态。

trimWhitespace

object (TrimWhitespaceRequest)

剪除单元格中的空白（例如空格、制表符或换行符）。

deleteDuplicates

object (DeleteDuplicatesRequest)

移除单元格范围中指定列中包含重复值的行。

updateEmbeddedObjectBorder

object (UpdateEmbeddedObjectBorderRequest)

更新嵌入对象的边框。

addSlicer

object (AddSlicerRequest)

添加了分屏。

updateSlicerSpec

object (UpdateSlicerSpecRequest)

更新 Slicer 的规范。

addDataSource

object (AddDataSourceRequest)

添加数据源。

updateDataSource

object (UpdateDataSourceRequest)

更新数据源。

deleteDataSource

object (DeleteDataSourceRequest)

删除数据源。

refreshDataSource

object (RefreshDataSourceRequest)

刷新一个或多个数据源和关联的 dbobject。

cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

取消刷新一个或多个数据源和关联的 dbobject。

UpdateSpreadsheetPropertiesRequest

更新电子表格的属性。

JSON 表示法 
{
  "properties": {
    object (SpreadsheetProperties)
  },
  "fields": string
}
字段
properties

object (SpreadsheetProperties)

要更新的房源。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根“properties”是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

UpdateSheetPropertiesRequest

使用指定的 sheetId 更新工作表的属性。

JSON 表示法 
{
  "properties": {
    object (SheetProperties)
  },
  "fields": string
}
字段
properties

object (SheetProperties)

要更新的房源。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 properties 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

UpdateDimensionPropertiesRequest

更新指定范围内的维度的属性。

JSON 表示法 
{
  "properties": {
    object (DimensionProperties)
  },
  "fields": string,

  // Union field dimension_range can be only one of the following:
  "range": {
    object (DimensionRange)
  },
  "dataSourceSheetRange": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
字段
properties

object (DimensionProperties)

要更新的房源。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 properties 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

联合字段 dimension_range。维度范围。 dimension_range只能是以下其中一项：
range

object (DimensionRange)

要更新的行或列。

dataSourceSheetRange

object (DataSourceSheetDimensionRange)

要更新的数据源工作表中的列。

DataSourceSheetDimensionRange

DATA_SOURCE 工作表中沿单个维度的范围。

JSON 表示法 
{
  "sheetId": integer,
  "columnReferences": [
    {
      object (DataSourceColumnReference)
    }
  ]
}
字段
sheetId

integer

相应范围所在的数据源工作表的 ID。

columnReferences[]

object (DataSourceColumnReference)

数据源工作表中的列。

UpdateNamedRangeRequest

使用指定的 namedRangeId 更新命名范围的属性。

JSON 表示法 
{
  "namedRange": {
    object (NamedRange)
  },
  "fields": string
}
字段
namedRange

object (NamedRange)

要使用新属性更新的命名范围。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 namedRange 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

RepeatCellRequest

将范围内的所有单元格更新为给定 Cell 对象中的值。只有 fields 字段中列出的字段会更新；其他字段保持不变。

如果使用公式写入单元格，则公式的范围将自动递增范围中的每个字段。例如，如果将公式为 =A1 的单元格写入范围 B2:C4，则 B2 将为 =A1、B3 将为 =A2、B4 将为 =A3、C2 将为 =B1、C3 将为 =B2、C4 将为 =B3。

如需使公式的范围保持不变，请使用 $ 指示器。例如，使用公式 =$A$1 可防止行和列递增。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "cell": {
    object (CellData)
  },
  "fields": string
}
字段
range

object (GridRange)

要重复单元格的范围。

cell

object (CellData)

要写入的数据。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 cell 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

AddNamedRangeRequest

向电子表格添加命名范围。

JSON 表示法 
{
  "namedRange": {
    object (NamedRange)
  }
}
字段
namedRange

object (NamedRange)

要添加的命名范围。namedRangeId 字段是可选字段；如果未设置，系统会随机生成 ID。（指定已存在的范围的 ID 是错误的。）

DeleteNamedRangeRequest

从电子表格中移除具有指定 ID 的命名范围。

JSON 表示法 
{
  "namedRangeId": string
}
字段
namedRangeId

string

要删除的命名范围的 ID。

AddSheetRequest

添加新工作表。在给定索引处添加工作表后，所有后续工作表的索引都会递增。如需添加对象工作表，请改用 AddChartRequest，并指定 EmbeddedObjectPosition.sheetId 或 EmbeddedObjectPosition.newSheet。

JSON 表示法 
{
  "properties": {
    object (SheetProperties)
  }
}
字段
properties

object (SheetProperties)

新工作表应具有的属性。所有属性均为可选属性。sheetId 字段是可选字段；如果未设置，系统会随机生成 ID。（如果指定已存在的工作表的 ID，则会出错。）

DeleteSheetRequest

删除请求的工作表。

JSON 表示法 
{
  "sheetId": integer
}
字段
sheetId

integer

要删除的工作表的 ID。

如果工作表的类型为 DATA_SOURCE，则关联的 DataSource 也会一并删除。

AutoFillRequest

根据现有数据填充更多数据。

JSON 表示法 
{
  "useAlternateSeries": boolean,

  // Union field area can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sourceAndDestination": {
    object (SourceAndDestination)
  }
  // End of list of possible types for union field area.
}
字段
useAlternateSeries

boolean

如果应使用“alternate”系列生成数据，则为 true。这因源数据的类型和数量而异。

联合字段 area。要自动填充的区域。 area只能是以下其中一项：
range

object (GridRange)

要自动填充的范围。这会检查范围并检测包含数据的位置，然后自动将这些数据填充到范围的其余部分。

sourceAndDestination

object (SourceAndDestination)

要自动填充的来源和目标区域。这会明确列出自动填充功能的来源以及扩展这些数据的位置。

SourceAndDestination

来源范围及其扩展方式的组合。

JSON 表示法 
{
  "source": {
    object (GridRange)
  },
  "dimension": enum (Dimension),
  "fillLength": integer
}
字段
source

object (GridRange)

要用作自动填充来源的数据的位置。

dimension

enum (Dimension)

应填充数据的维度。

fillLength

integer

应填充数据的行数或列数。正数会超出来源的最后一行或最后一列。负数会在来源的第一行或第一列之前展开。

CutPasteRequest

将数据从源移动到目的地。

JSON 表示法 
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridCoordinate)
  },
  "pasteType": enum (PasteType)
}
字段
source

object (GridRange)

要剪裁的源数据。

destination

object (GridCoordinate)

应将数据粘贴到的左上角坐标。

pasteType

enum (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 (GridRange)
  },
  "destination": {
    object (GridRange)
  },
  "pasteType": enum (PasteType),
  "pasteOrientation": enum (PasteOrientation)
}
字段
source

object (GridRange)

要复制的源范围。

destination

object (GridRange)

要粘贴到的位置。如果范围涵盖的跨度是源图像高度或宽度的倍数，则系统会重复数据以填充目标范围。如果范围小于来源范围，系统仍会复制整个来源数据（超出目的地范围的部分）。

pasteType

enum (PasteType)

要粘贴的数据类型。

pasteOrientation

enum (PasteOrientation)

粘贴时数据的方向。

PasteOrientation

应如何执行粘贴操作。

枚举
NORMAL 正常粘贴。
TRANSPOSE 粘贴转置，其中所有行都变为列，反之亦然。

MergeCellsRequest

合并范围内的所有单元格。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "mergeType": enum (MergeType)
}
字段
range

object (GridRange)

要合并的单元格范围。

mergeType

enum (MergeType)

单元格应如何合并。

MergeType

要创建的合并类型。

枚举
MERGE_ALL 从范围创建单个合并
MERGE_COLUMNS 为范围内的每个列创建一个合并
MERGE_ROWS 为范围中的每一行创建一个合并

UnmergeCellsRequest

取消合并给定范围内的单元格。

JSON 表示法 
{
  "range": {
    object (GridRange)
  }
}
字段
range

object (GridRange)

要取消合并的所有单元格所在的范围。如果范围跨越多个合并，则所有合并都会解除。范围不得部分跨越任何合并单元。

UpdateBordersRequest

更新范围的边界。如果请求中未设置某个字段，则表示相应边界保持不变。例如，对于两个后续的 UpdateBordersRequest：

  1. 范围：A1:A5 { top: RED, bottom: WHITE }
  2. 范围：A1:A5 { left: BLUE }

这会导致 A1:A5 具有 { top: RED, bottom: WHITE, left: BLUE } 边框。如果您想清除边框，请将样式明确设置为 NONE。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  },
  "innerHorizontal": {
    object (Border)
  },
  "innerVertical": {
    object (Border)
  }
}
字段
range

object (GridRange)

应更新边框的范围。

top

object (Border)

要放置在范围顶部的边框。

bottom

object (Border)

要放置在范围底部的边框。

left

object (Border)

要放置在范围左侧的边框。

right

object (Border)

要放置在范围右侧的边框。

innerHorizontal

object (Border)

要放置在范围内的水平边框。

innerVertical

object (Border)

要放置在范围内的垂直边框。

UpdateCellsRequest

使用新数据更新范围内的所有单元格。

JSON 表示法 
{
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string,

  // Union field area can be only one of the following:
  "start": {
    object (GridCoordinate)
  },
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field area.
}
字段
rows[]

object (RowData)

要写入的数据。

fields

string (FieldMask format)

应更新的 CellData 字段。必须至少指定一个字段。根是 CellData；不应指定“row.values”。单个 "*" 可用作列出每个字段的简写形式。

联合字段 area。应写入位置数据。必须设置一个值。 area只能是以下其中一项：
start

object (GridCoordinate)

开始写入数据的坐标。可以写入任意数量的行和列（包括每行不同的列数）。

range

object (GridRange)

要写入数据的范围。

如果行中的数据未涵盖请求的整个范围，系统会清除与 fields 中设置的字段匹配的字段。

AddFilterViewRequest

添加过滤视图。

JSON 表示法 
{
  "filter": {
    object (FilterView)
  }
}
字段
filter

object (FilterView)

要添加的过滤条件。filterViewId 字段是可选字段；如果未设置，系统会随机生成 ID。（指定已存在的过滤条件的 ID 会出错。）

AppendCellsRequest

在工作表中包含数据的最后一行后面添加新单元格，并根据需要将新行插入工作表中。

JSON 表示法 
{
  "sheetId": integer,
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string
}
字段
sheetId

integer

要将数据附加到的工作表 ID。

rows[]

object (RowData)

要附加的数据。

fields

string (FieldMask format)

应更新的 CellData 字段。必须至少指定一个字段。根是 CellData；不应指定“row.values”。单个 "*" 可用作列出每个字段的简写形式。

ClearBasicFilterRequest

清除工作表中的基本过滤条件（如果有）。

JSON 表示法 
{
  "sheetId": integer
}
字段
sheetId

integer

应清除基本过滤条件的电子表格 ID。

DeleteDimensionRequest

从工作表中删除维度。

JSON 表示法 
{
  "range": {
    object (DimensionRange)
  }
}
字段
range

object (DimensionRange)

要从工作表中删除的维度。

DeleteEmbeddedObjectRequest

删除具有给定 ID 的嵌入对象。

JSON 表示法 
{
  "objectId": integer
}
字段
objectId

integer

要删除的嵌入对象的 ID。

DeleteFilterViewRequest

删除特定的过滤条件视图。

JSON 表示法 
{
  "filterId": integer
}
字段
filterId

integer

要删除的过滤条件的 ID。

DuplicateFilterViewRequest

复制特定过滤视图。

JSON 表示法 
{
  "filterId": integer
}
字段
filterId

integer

要复制的过滤条件的 ID。

DuplicateSheetRequest

复制工作表中的内容。

JSON 表示法 
{
  "sourceSheetId": integer,
  "insertSheetIndex": integer,
  "newSheetId": integer,
  "newSheetName": string
}
字段
sourceSheetId

integer

要复制的工作表。

如果来源工作表的类型为 DATA_SOURCE，则其背后的 DataSource 也会复制并与工作表的新副本相关联。系统不会触发任何数据执行，此工作表的网格数据也会复制过来，但只有在批量请求完成后才可用。

insertSheetIndex

integer

应插入新工作表的位置（从零开始的索引）。此后，所有工作表的编号都会递增。

newSheetId

integer

如果已设置，则为新工作表的 ID。如果未设置，系统会选择一个 ID。如果设置了此 ID，则该 ID 不得与任何现有工作表 ID 冲突。如果设置，则必须为非负数。

newSheetName

string

新工作表的名称。如果留空，系统会为您选择一个新名称。

FindReplaceRequest

查找并替换单元格范围、工作表或所有工作表中的单元格数据。

JSON 表示法 
{
  "find": string,
  "replacement": string,
  "matchCase": boolean,
  "matchEntireCell": boolean,
  "searchByRegex": boolean,
  "includeFormulas": boolean,

  // Union field scope can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sheetId": integer,
  "allSheets": boolean
  // End of list of possible types for union field scope.
}
字段
find

string

要搜索的值。

replacement

string

要用作替换项的值。

matchCase

boolean

如果搜索区分大小写，则为 true。

matchEntireCell

boolean

如果要查找的值应与整个单元格匹配，则为 true。

searchByRegex

boolean

如果查找值是正则表达式，则为 true。正则表达式和替换项应遵循 https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html 中的 Java 正则表达式规则。替换字符串可以引用捕获组。例如，如果一个单元格的值为 "Google Sheets"，另一个单元格的值为 "Google Docs"，那么搜索 "o.* (.*)" 并将其替换为 "$1 Rocks" 会将这两个单元格的值分别更改为 "GSheets Rocks" 和 "GDocs Rocks"。

includeFormulas

boolean

如果搜索应包含包含公式的单元格，则为 True。为 False 时，会跳过包含公式的单元格。

联合字段 scope。要查找/替换的范围 - 必须设置一个且仅一个。 scope只能是以下其中一项：
range

object (GridRange)

要查找/替换的范围。

sheetId

integer

要查找/替换内容的表格。

allSheets

boolean

为 true 时，在所有工作表中查找/替换。

InsertDimensionRequest

在工作表中特定编号的位置插入行或列。

JSON 表示法 
{
  "range": {
    object (DimensionRange)
  },
  "inheritFromBefore": boolean
}
字段
range

object (DimensionRange)

要插入的维度。起始索引和结束索引都必须有界。

inheritFromBefore

boolean

维度属性是从新插入的维度之前还是之后的维度延伸。设为 true 以从前面的维度继承（在这种情况下，起始索引必须大于 0），设为 false 以从后面的维度继承。

例如，如果行索引 0 的背景为红色，行索引 1 的背景为绿色，那么在索引 1 处插入 2 行可以继承绿色或红色背景。如果 inheritFromBefore 为 true，则两个新行将为红色（因为插入点前面的行为红色），而如果 inheritFromBefore 为 false，则两个新行将为绿色（因为插入点后面的行为绿色）。

InsertRangeRequest

将单元格插入到范围中，并将现有单元格向右或向下移动。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
字段
range

object (GridRange)

要插入新单元格的范围。范围受当前工作表边界限制。

shiftDimension

enum (Dimension)

插入单元格时要偏移的维度。如果为 ROWS，则现有单元格会向下移。如果为 COLUMNS，则现有单元格将向右移。

MoveDimensionRequest

移动一行或多行或一列或多列。

JSON 表示法 
{
  "source": {
    object (DimensionRange)
  },
  "destinationIndex": integer
}
字段
source

object (DimensionRange)

要移动的来源维度。

destinationIndex

integer

源数据移至何处（基于从网格中移除源数据之前的坐标）的从零开始的起始索引。现有数据将向下或向右（具体取决于维度）偏移，以便为移动的维度腾出空间。系统会从网格中移除来源维度，因此数据最终可能会出现在指定的索引之外。

例如，假设 0, 1, 2, 3, 4 的 A1..A5 为 1，并且您希望将 "1" 和 "2" 移至 "3" 和 "4" 之间，则来源为 ROWS [1..3)，目标索引为 "4"（第 5 行的从零开始的索引）。最终结果将是 0, 3, 1, 2, 4 的 A1..A5。

UpdateEmbeddedObjectPositionRequest

更新嵌入对象的位置（例如移动或调整图表或图片的大小）。

JSON 表示法 
{
  "objectId": integer,
  "newPosition": {
    object (EmbeddedObjectPosition)
  },
  "fields": string
}
字段
objectId

integer

要移动的对象的 ID。

newPosition

object (EmbeddedObjectPosition)

要将嵌入对象移到的显式位置。如果设置了 newPosition.sheetId，系统会创建一个使用该 ID 的新工作表。如果 newPosition.newSheet 设为 true，系统会创建一个新工作表，并为其选择一个 ID。

fields

string (FieldMask format)

设置新位置时应更新的 OverlayPosition 字段。仅在设置了 newPosition.overlayPosition 时使用，在这种情况下，必须指定至少一个字段。根 newPosition.overlayPosition 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

PasteDataRequest

将数据插入到电子表格中，从指定的坐标开始。

JSON 表示法 
{
  "coordinate": {
    object (GridCoordinate)
  },
  "data": string,
  "type": enum (PasteType),

  // Union field kind can be only one of the following:
  "delimiter": string,
  "html": boolean
  // End of list of possible types for union field kind.
}
字段
coordinate

object (GridCoordinate)

应开始插入数据的坐标。

data

string

要插入的数据。

type

enum (PasteType)

数据的粘贴方式。

联合字段 kind。必须设置一个值，以便确定如何解读数据。 kind只能是以下其中一项：
delimiter

string

数据中的分隔符。

html

boolean

如果数据为 HTML，则为 true。

TextToColumnsRequest

根据每个单元格中的分隔符，将一列文本拆分为多列。

JSON 表示法 
{
  "source": {
    object (GridRange)
  },
  "delimiter": string,
  "delimiterType": enum (DelimiterType)
}
字段
source

object (GridRange)

源数据范围。此值必须仅占一列。

delimiter

string

要使用的分隔符。仅当 delimiterType 为 CUSTOM 时使用。

delimiterType

enum (DelimiterType)

要使用的分隔符类型。

DelimiterType

拆分时使用的分隔符。

枚举
DELIMITER_TYPE_UNSPECIFIED 默认值。请勿使用此值。
COMMA ”“
SEMICOLON ";"
PERIOD "."
SPACE " "
CUSTOM 分隔符中定义的自定义值。
AUTODETECT 自动检测列。

UpdateFilterViewRequest

更新过滤器视图的属性。

JSON 表示法 
{
  "filter": {
    object (FilterView)
  },
  "fields": string
}
字段
filter

object (FilterView)

过滤视图的新属性。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 filter 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

DeleteRangeRequest

删除一组单元格，并将其他单元格移至已删除区域。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
字段
range

object (GridRange)

要删除的单元格范围。

shiftDimension

enum (Dimension)

用于替换已删除单元格的维度。如果为 ROWS，则现有单元格会向上移动以替换已删除的单元格。如果为 COLUMNS，则现有单元格会向左移，以替换被删除的单元格。

AppendDimensionRequest

将行或列附加到工作表的末尾。

JSON 表示法 
{
  "sheetId": integer,
  "dimension": enum (Dimension),
  "length": integer
}
字段
sheetId

integer

要附加行或列的工作表。

dimension

enum (Dimension)

是否应附加行或列。

length

integer

要附加的行数或列数。

AddConditionalFormatRuleRequest

在给定索引处添加新的条件格式规则。所有后续规则的索引都会递增。

JSON 表示法 
{
  "rule": {
    object (ConditionalFormatRule)
  },
  "index": integer
}
字段
rule

object (ConditionalFormatRule)

要添加的规则。

index

integer

应插入规则的位置（从零开始的索引）。

UpdateConditionalFormatRuleRequest

更新指定索引处的条件格式规则，或将条件格式规则移至另一个索引。

JSON 表示法 
{
  "index": integer,
  "sheetId": integer,

  // Union field instruction can be only one of the following:
  "rule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer
  // End of list of possible types for union field instruction.
}
字段
index

integer

应替换或移动的规则的索引（从零开始）。

sheetId

integer

要移动的规则所在的表格。如果设置了 newIndex，则此字段为必填字段；否则不使用。

联合字段 instruction。应发生的更新类型。 instruction只能是以下其中一项：
rule

object (ConditionalFormatRule)

应替换给定索引处规则的规则。

newIndex

integer

规则应在其中结束的新索引（从零开始）。

DeleteConditionalFormatRuleRequest

删除指定索引处的条件格式规则。所有后续规则的编号都会递减。

JSON 表示法 
{
  "index": integer,
  "sheetId": integer
}
字段
index

integer

要删除的规则的索引（从零开始）。

sheetId

integer

要删除规则所在的工作表。

SortRangeRequest

根据每列的排序顺序对行数据进行排序。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ]
}
字段
range

object (GridRange)

要排序的范围。

sortSpecs[]

object (SortSpec)

每列的排序顺序。如果早期规范中的值相同，则使用较新的规范。

SetDataValidationRequest

为范围中的每个单元格设置数据验证规则。如需清除某个范围内的验证，请在不指定规则的情况下调用此方法。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "rule": {
    object (DataValidationRule)
  },
  "filteredRowsIncluded": boolean
}
字段
range

object (GridRange)

数据验证规则应应用到的范围。

rule

object (DataValidationRule)

要对范围中的每个单元格设置的数据验证规则，如果为空，则清除范围中的数据验证。

filteredRowsIncluded

boolean

可选。如果为 true，则数据验证规则也会应用于过滤后的行。

SetBasicFilterRequest

设置与工作表关联的基本过滤条件。

JSON 表示法 
{
  "filter": {
    object (BasicFilter)
  }
}
字段
filter

object (BasicFilter)

要设置的过滤条件。

AddProtectedRangeRequest

添加了新的受保护范围。

JSON 表示法 
{
  "protectedRange": {
    object (ProtectedRange)
  }
}
字段
protectedRange

object (ProtectedRange)

要添加的受保护范围。protectedRangeId 字段是可选字段；如果未设置，系统会随机生成 ID。（指定已存在的范围的 ID 是错误的。）

UpdateProtectedRangeRequest

使用指定的 protectedRangeId 更新现有的受保护范围。

JSON 表示法 
{
  "protectedRange": {
    object (ProtectedRange)
  },
  "fields": string
}
字段
protectedRange

object (ProtectedRange)

要使用新属性更新的受保护范围。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 protectedRange 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

DeleteProtectedRangeRequest

删除具有指定 ID 的受保护范围。

JSON 表示法 
{
  "protectedRangeId": integer
}
字段
protectedRangeId

integer

要删除的受保护范围的 ID。

AutoResizeDimensionsRequest

根据该维度中单元格的内容自动调整一个或多个维度的大小。

JSON 表示法 
{

  // Union field dimension_range can be only one of the following:
  "dimensions": {
    object (DimensionRange)
  },
  "dataSourceSheetDimensions": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
字段
联合字段 dimension_range。维度范围。 dimension_range只能是以下其中一项：
dimensions

object (DimensionRange)

要自动调整大小的尺寸。

dataSourceSheetDimensions

object (DataSourceSheetDimensionRange)

数据源工作表上要自动调整大小的尺寸。

AddChartRequest

将图表添加到电子表格中的工作表。

JSON 表示法 
{
  "chart": {
    object (EmbeddedChart)
  }
}
字段
chart

object (EmbeddedChart)

应添加到电子表格中的图表，包括其应放置的位置。chartId 字段是可选字段；如果未设置，系统会随机生成 ID。（指定已存在的嵌入对象的 ID 会出错。）

UpdateChartSpecRequest

更新图表的规范。（这不会移动或调整图表大小。如需移动或调整图表大小，请使用 UpdateEmbeddedObjectPositionRequest。)

JSON 表示法 
{
  "chartId": integer,
  "spec": {
    object (ChartSpec)
  }
}
字段
chartId

integer

要更新的图表的 ID。

spec

object (ChartSpec)

要应用于图表的规范。

UpdateBandingRequest

更新所提供的带状范围的属性。

JSON 表示法 
{
  "bandedRange": {
    object (BandedRange)
  },
  "fields": string
}
字段
bandedRange

object (BandedRange)

要使用新属性更新的带状范围。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 bandedRange 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

AddBandingRequest

向电子表格中添加新的带状范围。

JSON 表示法 
{
  "bandedRange": {
    object (BandedRange)
  }
}
字段
bandedRange

object (BandedRange)

要添加的带状范围。bandedRangeId 字段是可选字段；如果未设置，系统会随机生成 ID。（指定已存在的范围的 ID 是错误的。）

DeleteBandingRequest

从电子表格中移除具有指定 ID 的分组范围。

JSON 表示法 
{
  "bandedRangeId": integer
}
字段
bandedRangeId

integer

要删除的分组范围的 ID。

CreateDeveloperMetadataRequest

创建开发者元数据的请求。

JSON 表示法 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
字段
developerMetadata

object (DeveloperMetadata)

要创建的开发者元数据。

UpdateDeveloperMetadataRequest

用于更新开发者元数据属性的请求。将过滤条件选择的开发者元数据的属性更新为 DeveloperMetadata 资源中提供的值。调用方必须在 fields 参数中指定要更新的属性，并指定至少一个与要更新的元数据匹配的 DataFilter。

JSON 表示法 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "fields": string
}
字段
dataFilters[]

object (DataFilter)

与要更新的开发者元数据条目匹配的过滤条件。

developerMetadata

object (DeveloperMetadata)

数据过滤条件匹配的所有元数据将更新到的值。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 developerMetadata 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

DeleteDeveloperMetadataRequest

删除开发者元数据的请求。

JSON 表示法 
{
  "dataFilter": {
    object (DataFilter)
  }
}
字段
dataFilter

object (DataFilter)

用于描述用于选择要删除的开发者元数据条目的条件的数据过滤器。

RandomizeRangeRequest

对范围内的行进行随机排序。

JSON 表示法 
{
  "range": {
    object (GridRange)
  }
}
字段
range

object (GridRange)

要随机化的范围。

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 (DimensionRange)
  }
}
字段
range

object (DimensionRange)

要创建组的范围。

DeleteDimensionGroupRequest

通过递减指定范围内维度的深度，删除指定范围内的组。

例如，假设工作表在 B:E 上有一个深度为 1 的组，在 C:D 上有一个深度为 2 的组。删除 D:E 上的组后，工作表中会保留 B:D 上的深度为 1 的组和 C:C 上的深度为 2 的组。

JSON 表示法 
{
  "range": {
    object (DimensionRange)
  }
}
字段
range

object (DimensionRange)

要删除的组的范围。

UpdateDimensionGroupRequest

更新指定组的状态。

JSON 表示法 
{
  "dimensionGroup": {
    object (DimensionGroup)
  },
  "fields": string
}
字段
dimensionGroup

object (DimensionGroup)

应更新状态的组。组的范围和深度应指定工作表上的有效组，并更新所有其他字段。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 dimensionGroup 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

TrimWhitespaceRequest

剪除指定范围中每个单元格中的空白（例如空格、制表符或换行符）。此请求会移除每个单元格文本开头和结尾的所有空格，并将剩余空格字符的任何子序列缩减为一个空格。如果截断后的文本以“+”或“=”字符开头，则文本将保持为字符串值，而不会被解读为公式。

JSON 表示法 
{
  "range": {
    object (GridRange)
  }
}
字段
range

object (GridRange)

要修剪单元格的范围。

DeleteDuplicatesRequest

移除此范围内包含指定列中与任何前一行值重复的值的行。即使行内的值字母大小写、格式设置、所用公式不一样，但是值相同，则均会被视为重复内容。

此请求还会移除隐藏在视图之外的重复行（例如，由于过滤器）。移除重复项时，从上往下扫描每个重复行，系统会保留第一个实例，并将其纳入到生成的范围中。系统不会移除指定范围之外的内容，并且被视为重复的行在范围内不必彼此相邻。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}
字段
range

object (GridRange)

要从中移除重复行的范围。

comparisonColumns[]

object (DimensionRange)

要分析是否存在重复值的范围中的列。如果未选择任何列，则系统会分析所有列以查找重复项。

UpdateEmbeddedObjectBorderRequest

更新嵌入对象的边框属性。

JSON 表示法 
{
  "objectId": integer,
  "border": {
    object (EmbeddedObjectBorder)
  },
  "fields": string
}
字段
objectId

integer

要更新的嵌入对象的 ID。

border

object (EmbeddedObjectBorder)

应用于嵌入对象的边框。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 border 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

AddSlicerRequest

向电子表格中的工作表添加切片器。

JSON 表示法 
{
  "slicer": {
    object (Slicer)
  }
}
字段
slicer

object (Slicer)

应添加到电子表格中的切片器，包括其应放置的位置。slicerId 字段是可选字段；如果未设置，系统会随机生成 ID。（指定已存在的切片器的 ID 会出错。）

UpdateSlicerSpecRequest

更新 Slicer 的规范。（这不会移动或调整 Slicer 的大小。如需移动或调整切片器的大小，请使用 UpdateEmbeddedObjectPositionRequest。

JSON 表示法 
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "fields": string
}
字段
slicerId

integer

要更新的分屏的 ID。

spec

object (SlicerSpec)

要应用于 Slicer 的规范。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 SlicerSpec 是隐含的，不应指定。单个“*”可用作列出每个字段的简写形式。

AddDataSourceRequest

添加数据源。成功添加数据源后，系统会创建关联的 DATA_SOURCE 工作表，并触发执行以刷新工作表，以便从数据源读取数据。

如果您要添加 BigQuery 数据源，则请求需要额外的 bigquery.readonly OAuth 范围。

JSON 表示法 
{
  "dataSource": {
    object (DataSource)
  }
}
字段
dataSource

object (DataSource)

要添加的数据源。

UpdateDataSourceRequest

更新数据源。成功更新数据源后，系统会触发执行操作以刷新关联的 DATA_SOURCE 工作表，以便从更新后的数据源读取数据。

如果您要更新 BigQuery 数据源，则请求需要额外的 bigquery.readonly OAuth 范围。

JSON 表示法 
{
  "dataSource": {
    object (DataSource)
  },
  "fields": string
}
字段
dataSource

object (DataSource)

要更新的数据源。

fields

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 dataSource 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

DeleteDataSourceRequest

删除数据源。该请求还会删除关联的数据源工作表，并解除关联所有关联的数据源对象。

JSON 表示法 
{
  "dataSourceId": string
}
字段
dataSourceId

string

要删除的数据源的 ID。

RefreshDataSourceRequest

根据指定的引用刷新电子表格中的一个或多个数据源对象。

如果您要刷新 BigQuery 数据源，则请求需要额外的 bigquery.readonly OAuth 范围。

如果一个批次中存在多个引用同一数据源对象的刷新请求，系统只会处理最后一个刷新请求，并且所有这些请求都会收到相同的响应。

JSON 表示法 
{
  "force": boolean,

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}
字段
force

boolean

无论当前状态如何，都会刷新数据源对象。如果未设置，并且引用的数据源对象处于错误状态，刷新将立即失败。

联合字段 target。指定要刷新的内容。 target只能是以下其中一项：
references

object (DataSourceObjectReferences)

对要刷新的数据源对象的引用。

dataSourceId

string

对 DataSource 的引用。如果指定，则会刷新数据源的所有关联数据源对象。

isAll

boolean

刷新电子表格中的所有现有数据源对象。

DataSourceObjectReferences

对数据源对象的引用列表。

JSON 表示法 
{
  "references": [
    {
      object (DataSourceObjectReference)
    }
  ]
}
字段
references[]

object (DataSourceObjectReference)

参考文献。

CancelDataSourceRefreshRequest

根据指定的引用取消对电子表格中一个或多个数据源对象的刷新。

如果您要取消 BigQuery 数据源的刷新，则请求需要额外的 bigquery.readonly OAuth 范围。

JSON 表示法 
{

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}
字段
联合字段 target。指定要取消的内容。 target只能是以下其中一项：
references

object (DataSourceObjectReferences)

对要取消刷新的数据源对象的引用。

dataSourceId

string

对 DataSource 的引用。如果指定，则取消此数据源的所有关联数据源对象刷新。

isAll

boolean

取消电子表格中所有数据源的所有现有数据源对象刷新。