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)
  }
  // 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)

刷新一个或多个数据源以及关联的数据库对象。

Update 电子表格 PropertiesRequest

更新电子表格的属性。

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。(指定已存在的范围的 ID 是错误的。)

DeleteNamedRangeRequest

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

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

string

要删除的已命名范围的 ID。

AddSheetRequest

添加新工作表。当某个工作表被添加到给定索引中时,所有后续工作表的索引都会递增。如需添加对象工作表,请改用 AddChartRequest 并指定 EmbeddedObjectPosition.sheetIdEmbeddedObjectPosition.newSheet

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

object (SheetProperties)

新工作表应具有的属性。所有房源均为可选属性。sheetId 字段是可选的;如果未设置任何 ID,系统会随机生成 ID。(指定已存在的工作表的 ID 是错误的。)

DeleteSheetRequest

删除所请求的工作表。

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

integer

要删除的工作表的 ID。

如果工作表的类型为 DATA_SOURCE,关联的 DataSource 也会被删除。

自动填充请求

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

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)

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

来源和目标

来源范围以及如何扩展来源。

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)

要粘贴的数据类型。所有源数据都会被剪切,无论粘贴的是哪个数据。

粘贴类型

应粘贴哪些类型的数据。

枚举
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)

粘贴时该如何定向数据。

粘贴方向

应如何执行粘贴操作。

枚举
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。(指定已存在的过滤条件的 ID 是错误的。)

附加单元格请求

在工作表中最后一行后添加新的单元格,必要时在表格中插入新行。

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)

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

删除嵌入式对象请求

删除具有指定 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 冲突。如果设置此参数,它必须是非负数。

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, 4A1..A5 希望将 "1""2" 移动到 "3""4" 之间,源位置将为 ROWS [1..3),目标索引将为 "4"(第 5 行从零开始的索引)。最终结果为 A1..A5 (共 0, 3, 1, 2, 4 个)。

更新嵌入式对象位置请求

更新嵌入对象的位置(例如移动图表或图片大小)。

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

integer

要移动的对象的 ID。

newPosition

object (EmbeddedObjectPosition)

将嵌入式对象移动到的明确位置。如果您设置了 newPosition.sheetId,系统会创建具有该 ID 的新工作表。如果 newPosition.newSheet 设为 true,系统会创建一个新 ID,其中包含为您选择的 ID。

fields

string (FieldMask format)

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

粘贴数据请求

以指定的坐标为起点,在电子表格中插入数据。

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

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

delimiterType

enum (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,则现有单元格会左移以替换已删除的单元格。

附加维度请求

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

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。(指定已存在的范围的 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。

AutoResizeDimensionRequest

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

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。(指定已存在的嵌入式对象的 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。(指定已存在的范围的 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, depth 1] + [C:D] 可生成组 [B:E, depth 1] 和 [C:D, depth 2]。如果请求的范围在现有群组 G 的范围之前开始、在 结束之前结束,或在 结束之后结束,则现有群组 G 的范围将变为范围的集合,并且新群组 G' 的深度大于 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 上具有 depth-1 组,在 C:D 上具有 depth-2 组。如果通过 D:E 删除组,那么在 B:D 上留下了 depth-1 组和 C:C 上 depth-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)

要分析是否存在重复值的范围的列。如果未选择任何列,则会分析所有列是否存在重复项。

UpdateEmbedObjectBorderRequest

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

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。(指定已存在的截剪器 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 范围。

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

object (DataSource)

要添加的数据源。

UpdateDataSourceRequest

更新数据源。数据源成功更新后,系统会触发执行来刷新关联的 DATA_SOURCE 表,以从更新后的数据源读取数据。该请求需要额外的 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.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)

引用。