Responses

回应

来自更新的单个响应。

JSON 表示法
{

  // Union field kind can be only one of the following:
  "addNamedRange": {
    object (AddNamedRangeResponse)
  },
  "addSheet": {
    object (AddSheetResponse)
  },
  "addFilterView": {
    object (AddFilterViewResponse)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewResponse)
  },
  "duplicateSheet": {
    object (DuplicateSheetResponse)
  },
  "findReplace": {
    object (FindReplaceResponse)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionResponse)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleResponse)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleResponse)
  },
  "addProtectedRange": {
    object (AddProtectedRangeResponse)
  },
  "addChart": {
    object (AddChartResponse)
  },
  "addBanding": {
    object (AddBandingResponse)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataResponse)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataResponse)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataResponse)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupResponse)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupResponse)
  },
  "trimWhitespace": {
    object (TrimWhitespaceResponse)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesResponse)
  },
  "addSlicer": {
    object (AddSlicerResponse)
  },
  "addDataSource": {
    object (AddDataSourceResponse)
  },
  "updateDataSource": {
    object (UpdateDataSourceResponse)
  },
  "refreshDataSource": {
    object (RefreshDataSourceResponse)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshResponse)
  }
  // End of list of possible types for union field kind.
}
田野
联合字段 kind。回复的类型。如果请求没有响应,则可能不会设置任何字段。 kind 只能是下列其中一项:
addNamedRange

object (AddNamedRangeResponse)

来自添加命名范围的回复。

addSheet

object (AddSheetResponse)

添加工作表后得到的回复。

addFilterView

object (AddFilterViewResponse)

添加过滤视图后得到的回复。

duplicateFilterView

object (DuplicateFilterViewResponse)

来自复制过滤视图的回复。

duplicateSheet

object (DuplicateSheetResponse)

因复制工作表而导致的回复。

findReplace

object (FindReplaceResponse)

通过查找/替换操作回复。

updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionResponse)

对嵌入对象位置更新生成的回复。

updateConditionalFormatRule

object (UpdateConditionalFormatRuleResponse)

对更新条件格式规则的回复。

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleResponse)

对删除条件格式规则的回复。

addProtectedRange

object (AddProtectedRangeResponse)

来自添加受保护范围的回复。

addChart

object (AddChartResponse)

添加图表后得到的回复。

addBanding

object (AddBandingResponse)

添加带条带范围的回复。

createDeveloperMetadata

object (CreateDeveloperMetadataResponse)

针对创建开发者元数据条目而做出的回复。

updateDeveloperMetadata

object (UpdateDeveloperMetadataResponse)

针对更新开发者元数据条目的回复。

deleteDeveloperMetadata

object (DeleteDeveloperMetadataResponse)

针对删除开发者元数据条目的回复。

addDimensionGroup

object (AddDimensionGroupResponse)

添加维度组后给出的回复。

deleteDimensionGroup

object (DeleteDimensionGroupResponse)

针对删除维度组的回复。

trimWhitespace

object (TrimWhitespaceResponse)

剪除空格后生成的回复。

deleteDuplicates

object (DeleteDuplicatesResponse)

对移除包含重复值的行的回复。

addSlicer

object (AddSlicerResponse)

来自添加截剪器的回复。

addDataSource

object (AddDataSourceResponse)

来自添加数据源的回复。

updateDataSource

object (UpdateDataSourceResponse)

来自更新数据源的回复。

refreshDataSource

object (RefreshDataSourceResponse)

来自刷新数据源对象的回复。

cancelDataSourceRefresh

object (CancelDataSourceRefreshResponse)

系统会刷新来自取消数据源对象的回复。

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

AddNamedRangeResponse

将命名范围相加的结果。

JSON 表示法
{
  "namedRange": {
    object (NamedRange)
  }
}
田野
namedRange

object (NamedRange)

要添加的命名范围。

AddSheetResponse

添加工作表的结果。

JSON 表示法
{
  "properties": {
    object (SheetProperties)
  }
}
田野
properties

object (SheetProperties)

新添加工作表的属性。

AddFilterViewResponse

添加过滤视图的结果。

JSON 表示法
{
  "filter": {
    object (FilterView)
  }
}
田野
filter

object (FilterView)

新添加的过滤视图。

DuplicateFilterViewResponse

过滤视图被复制的结果。

JSON 表示法
{
  "filter": {
    object (FilterView)
  }
}
田野
filter

object (FilterView)

新创建的过滤条件。

DuplicateSheetResponse

复制工作表的结果。

JSON 表示法
{
  "properties": {
    object (SheetProperties)
  }
}
田野
properties

object (SheetProperties)

所复制工作表的属性。

FindReplaceResponse

查找/替换的结果。

JSON 表示法
{
  "valuesChanged": integer,
  "formulasChanged": integer,
  "rowsChanged": integer,
  "sheetsChanged": integer,
  "occurrencesChanged": integer
}
田野
valuesChanged

integer

非公式单元格的数量已更改。

formulasChanged

integer

公式单元格的数量已更改。

rowsChanged

integer

行数已更改。

sheetsChanged

integer

工作表数量已更改。

occurrencesChanged

integer

出现次数(可能在一个单元格内多次)发生了变化。例如,如果将 "e" 替换为 "o""Google Sheets",则应该为 "3" 因为 "Google Sheets" -> "Googlo Shoots"

UpdateEmbeddedObjectPositionResponse

更新嵌入对象位置的结果。

JSON 表示法
{
  "position": {
    object (EmbeddedObjectPosition)
  }
}
田野
position

object (EmbeddedObjectPosition)

嵌入对象的新位置。

UpdateConditionalFormatRuleResponse

更新条件格式规则的结果。

JSON 表示法
{
  "newRule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer,

  // Union field old_info can be only one of the following:
  "oldRule": {
    object (ConditionalFormatRule)
  },
  "oldIndex": integer
  // End of list of possible types for union field old_info.
}
田野
newRule

object (ConditionalFormatRule)

用于替换旧规则的新规则(如果替换)或被移动的规则(如果被移动)

newIndex

integer

新规则的索引。

联合字段 old_info。有关上一条规则的信息。 old_info 只能是下列其中一项:
oldRule

object (ConditionalFormatRule)

旧(已删除)规则。如果移动规则,则未设置(因为它与 newRule)。

oldIndex

integer

规则的旧索引。如果规则被替换,则未设置(因为它与 newIndex)。

DeleteConditionalFormatRuleResponse

删除条件格式规则的结果。

JSON 表示法
{
  "rule": {
    object (ConditionalFormatRule)
  }
}
田野
rule

object (ConditionalFormatRule)

已删除的规则。

AddProtectedRangeResponse

添加新受保护的范围的结果。

JSON 表示法
{
  "protectedRange": {
    object (ProtectedRange)
  }
}
田野
protectedRange

object (ProtectedRange)

新添加的受保护范围。

AddChartResponse

将图表添加到电子表格的结果。

JSON 表示法
{
  "chart": {
    object (EmbeddedChart)
  }
}
田野
chart

object (EmbeddedChart)

新添加的图表。

AddBandingResponse

带条带范围添加的结果。

JSON 表示法
{
  "bandedRange": {
    object (BandedRange)
  }
}
田野
bandedRange

object (BandedRange)

添加的带范围范围。

CreateDeveloperMetadataResponse

创建开发者元数据而得到的响应。

JSON 表示法
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
田野
developerMetadata

object (DeveloperMetadata)

创建的开发者元数据。

UpdateDeveloperMetadataResponse

更新开发者元数据的响应。

JSON 表示法
{
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
田野
developerMetadata[]

object (DeveloperMetadata)

更新后的开发者元数据。

DeleteDeveloperMetadataResponse

删除开发者元数据时返回的响应。

JSON 表示法
{
  "deletedDeveloperMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
田野
deletedDeveloperMetadata[]

object (DeveloperMetadata)

已删除的元数据。

AddDimensionGroupResponse

添加群组的结果。

JSON 表示法
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
田野
dimensionGroups[]

object (DimensionGroup)

向某个维度添加组后该维度的所有组。

DeleteDimensionGroupResponse

删除群组的结果。

JSON 表示法
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
田野
dimensionGroups[]

object (DimensionGroup)

从某个维度中删除组后的所有组。

TrimWhitespaceResponse

修剪单元格中空格的结果。

JSON 表示法
{
  "cellsChangedCount": integer
}
田野
cellsChangedCount

integer

删除空格的单元格数量。

DeleteDuplicatesResponse

移除范围中的重复项的结果。

JSON 表示法
{
  "duplicatesRemovedCount": integer
}
田野
duplicatesRemovedCount

integer

已移除的重复行数。

AddSlicerResponse

将截剪器添加到电子表格的结果。

JSON 表示法
{
  "slicer": {
    object (Slicer)
  }
}
田野
slicer

object (Slicer)

新添加的截剪器。

AddDataSourceResponse

添加数据源的结果。

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

object (DataSource)

创建的数据源。

dataExecutionStatus

object (DataExecutionStatus)

数据执行状态。

UpdateDataSourceResponse

来自更新数据源的响应。

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

object (DataSource)

已更新的数据源。

dataExecutionStatus

object (DataExecutionStatus)

数据执行状态。

RefreshDataSourceResponse

刷新一个或多个数据源对象的响应。

JSON 表示法
{
  "statuses": [
    {
      object (RefreshDataSourceObjectExecutionStatus)
    }
  ]
}
田野
statuses[]

object (RefreshDataSourceObjectExecutionStatus)

请求中指定的数据源对象引用的所有刷新状态。如果 isAll 则该字段仅包含处于失败状态的条目。

RefreshDataSourceObjectExecutionStatus

刷新一个数据源对象的执行状态。

JSON 表示法
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
田野
reference

object (DataSourceObjectReference)

对正在刷新的数据源对象的引用。

dataExecutionStatus

object (DataExecutionStatus)

数据执行状态。

CancelDataSourceRefreshResponse

取消一个或多个数据源对象刷新时的响应。

JSON 表示法
{
  "statuses": [
    {
      object (CancelDataSourceRefreshStatus)
    }
  ]
}
田野
statuses[]

object (CancelDataSourceRefreshStatus)

请求中指定的所有数据源对象的取消刷新状态。如果 isAll 则该字段仅包含处于失败状态的条目。在同一数据源对象中,也不允许刷新和取消刷新 batchUpdate

CancelDataSourceRefreshStatus

取消单个数据源对象刷新的状态。

JSON 表示法
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "refreshCancellationStatus": {
    object (RefreshCancellationStatus)
  }
}
田野
reference

object (DataSourceObjectReference)

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

refreshCancellationStatus

object (RefreshCancellationStatus)

取消状态。

RefreshCancellationStatus

刷新取消的状态。

您可以发送 cancel request 以显式取消一个或多个数据源对象刷新。

JSON 表示法
{
  "state": enum (RefreshCancellationState),
  "errorCode": enum (RefreshCancellationErrorCode)
}
田野
state

enum (RefreshCancellationState)

在 Google 表格中取消刷新的调用的状态。

errorCode

enum (RefreshCancellationErrorCode)

错误代码。

RefreshCancellationState

刷新取消状态的枚举。

枚举
REFRESH_CANCELLATION_STATE_UNSPECIFIED 默认值,请勿使用。
CANCEL_SUCCEEDED 已成功通过 API 调用 Google 表格来取消刷新。但这并不意味着已成功执行取消操作,而是表示调用已成功进行。
CANCEL_FAILED 未能通过 API 调用 Google 表格来取消刷新。

RefreshCancellationErrorCode

刷新取消错误代码的枚举。

枚举
REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED 默认值,请勿使用。
EXECUTION_NOT_FOUND 在查询引擎或 Google 表格中找不到要取消的执行作业。
CANCEL_PERMISSION_DENIED 该用户无权取消查询。
QUERY_EXECUTION_COMPLETED 查询执行任务已完成,因此无法取消。
CONCURRENT_CANCELLATION 已有另一项取消正在处理中。
CANCEL_OTHER_ERROR 所有其他错误。