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)

更新截剪器的规范。

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

如果我们应使用“备用”属性生成数据，系列视频这因源数据的类型和数量而异。

联合字段 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 type 及其支持 DataSource 也会被复制并与该工作表的新副本相关联。系统不会触发任何数据执行，此工作表的网格数据也会复制，但只有在批量请求完成后才可用。

insertSheetIndex

integer

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

newSheetId

integer

新工作表的 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。正则表达式和替换应遵循 Java 正则表达式规则，位于 https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.替换字符串可以引用捕获组。例如，如果一个单元格包含 "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)
  }
}
田野
range

object (GridRange)

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

rule

object (DataValidationRule)

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

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 的深度。例如，组 [B:E, 深度 1] + [C:D] 会生成组 [B:E, 深度 1] 和 [C:D, 深度 2]。如果请求的范围在现有组 G 的范围之前结束，或结束于现有组 G 的范围之内，则现有组 G 的范围会成为这些范围的并集，而新组 G'深度为 1，大于 G 深度，范围为两个范围的交集。例如，组 [B:D, depth 1] + [C:E] 会生成组 [B:E, depth 1] 和 [C:D, depth 2]。

JSON 表示法 
{
  "range": {
    object (DimensionRange)
  }
}
田野
range

object (DimensionRange)

要创建组的范围。

DeleteDimensionGroupRequest

通过减小指定范围内的维度深度来删除指定范围内的某个组。

例如，假设工作表在 B:E 上有一个深度为 1 的组，在 C:D 上有一个深度为 2 组。通过 D:E 删除群组会使工作表中的深度为 1 的群组在 B:D 之上，而深度为 2 的群组在 C:C 之上。

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.readonly OAuth 范围（如果您要添加 BigQuery 数据源）。

JSON 表示法 
{
  "dataSource": {
    object (DataSource)
  }
}
田野
dataSource

object (DataSource)

要添加的数据源。

UpdateDataSourceRequest

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

该请求需要 bigquery.readonly OAuth 范围（如果您要更新 BigQuery 数据源）。

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

object (DataSource)

要更新的数据源。

fields

string (FieldMask format)

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

DeleteDataSourceRequest

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

JSON 表示法 
{
  "dataSourceId": string
}
田野
dataSourceId

string

要删除的数据源的 ID。

RefreshDataSourceRequest

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

该请求需要 bigquery.readonly OAuth 范围（如果要刷新 BigQuery 数据源）。

如果在一个批次中有多个刷新请求引用同一数据源对象，则仅处理最后一个刷新请求，所有这些请求都将相应地获得相同的响应。

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.readonly OAuth 范围（如果要取消对 BigQuery 数据源的刷新）。

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

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