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) }, "addTable": { object (AddTableRequest) }, "updateTable": { object (UpdateTableRequest) }, "deleteTable": { object (DeleteTableRequest) } // 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) 更新切片器的规范。
addDataSource	object (AddDataSourceRequest) 添加数据源。
updateDataSource	object (UpdateDataSourceRequest) 更新数据源。
deleteDataSource	object (DeleteDataSourceRequest) 删除数据源。
refreshDataSource	object (RefreshDataSourceRequest) 刷新一个或多个数据源以及关联的数据库对象。
cancelDataSourceRefresh	object (CancelDataSourceRefreshRequest) 取消一个或多个数据源和关联的数据库对象的刷新。
addTable	object (AddTableRequest) 添加表格。
updateTable	object (UpdateTableRequest) 更新表。
deleteTable	object (DeleteTableRequest) 用于删除表的请求。

UpdateSpreadsheetPropertiesRequest

更新电子表格的属性。

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

字段
properties	object (SpreadsheetProperties) 要更新的属性。
fields	string (FieldMask format) 应更新的字段。必须至少指定一个字段。根“属性”是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

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 如果应生成“备选”序列的数据，则为 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, // Union field area can be only one of the following: "tableId": string // End of list of possible types for union field area. }

字段
sheetId	integer 要将数据附加到的工作表 ID。
rows[]	object (RowData) 要附加的数据。
fields	string (FieldMask format) 应更新的 CellData 的字段。必须至少指定一个字段。根是 CellData；不应指定“row.values.”。单个 "*" 可用作列出每个字段的简写形式。
联合字段 area。位置数据应写入。 area 只能是下列其中一项：
tableId	string 要向其中附加数据的表的 ID。数据将仅附加到表格正文中。 此字段的优先级也高于 sheetId 字段。

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 要将源数据移至的目标位置的从零开始的起始索引，基于从网格中移除源数据之前的坐标。现有数据将向下或向右（取决于维度）移动，以便为移动的维度腾出空间。来源维度会从网格中移除，因此数据最终可能会位于与指定索引不同的位置。 例如，假设有 A1..A5 个 0, 1, 2, 3, 4，并且想要将 "1" 和 "2" 移动到 "3" 和 "4" 之间，则源为 ROWS [1..3)，目标索引为 "4"（第 5 行的从零开始的索引）。最终结果将是 A1..A5 的 0, 3, 1, 2, 4。

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，深度 1] + [B:E] 会生成 [B:E，深度 1] 和 [C:D，深度 2] 这两个组。如果所请求的范围是现有组 G 的范围的子集，则新组 G' 的深度将比 G 的深度大 1。例如，[B:E，深度 1] + [C:D] 会生成 [B:E，深度 1] 和 [C:D，深度 2] 这两个组。如果所请求的范围在现有组 G 的范围之前开始并在其中结束，或者在现有组 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

更新切片器的规范。（此操作不会移动或调整切片器的位置或大小。如需移动或调整切片器的尺寸，请使用 UpdateEmbeddedObjectPositionRequest。

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

字段
slicerId	integer 要更新的切片的 ID。
spec	object (SlicerSpec) 要应用于切片的规范。
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) 参考资料。

DataSourceObjectReference

对数据源对象的引用。

JSON 表示法
{ // Union field value can be only one of the following: "sheetId": string, "chartId": integer, "dataSourceTableAnchorCell": { object (GridCoordinate) }, "dataSourcePivotTableAnchorCell": { object (GridCoordinate) }, "dataSourceFormulaCell": { object (GridCoordinate) } // End of list of possible types for union field value. }

字段
联合字段 value。引用类型。 value 只能是下列其中一项：
sheetId	string 对 DATA_SOURCE 工作表的引用。
chartId	integer 对数据源图表的引用。
dataSourceTableAnchorCell	object (GridCoordinate) 对锚定在单元格中的 DataSourceTable 的引用。
dataSourcePivotTableAnchorCell	object (GridCoordinate) 对数据源的引用 PivotTable 锚定在单元格中。
dataSourceFormulaCell	object (GridCoordinate) 对包含 DataSourceFormula 的单元格的引用。

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 取消电子表格中所有数据源的所有现有数据源对象刷新。

AddTableRequest

向电子表格添加新表格。

JSON 表示法
{ "table": { object (Table) } }

字段
table	object (Table) 必需。要添加的表格。

UpdateTableRequest

更新电子表格中的表格。

JSON 表示法
{ "table": { object (Table) }, "fields": string }

字段
table	object (Table) 必需。要更新的表。
fields	string (FieldMask format) 必需。应更新的字段。必须至少指定一个字段。根 table 是隐含的，不应指定。单个 "*" 可用作列出每个字段的简写形式。

DeleteTableRequest

从电子表格中移除具有指定 ID 的表格。

JSON 表示法
{ "tableId": string }

字段
tableId	string 要删除的表的 ID。