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

出现次数（单个单元格内可能有多个）发生了变化。例如，如果在 "Google Sheets" 中将 "e" 替换为 "o"，结果将为 "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 用于取消刷新的 Google 表格 API 调用已成功。这并不意味着已成功执行取消，而是表示调用已成功发出。
CANCEL_FAILED 用于取消刷新的 Sheets API 调用失败。

RefreshCancellationErrorCode

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

枚举
REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED 默认值，请勿使用。
EXECUTION_NOT_FOUND 在查询引擎或 Google 表格中未找到要取消的执行。
CANCEL_PERMISSION_DENIED 用户无权取消查询。
QUERY_EXECUTION_COMPLETED 查询已执行完毕，因此无法取消。
CONCURRENT_CANCELLATION 另一项取消操作正在进行中。
CANCEL_OTHER_ERROR 所有其他错误。