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