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)

关于取消数据源对象刷新的回复。

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 未能对 Google 表格进行 API 调用以取消刷新。

RefreshCancellationErrorCode

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

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