Responses

Response

A single response from an update.

JSON representation

JSON representation
{ // 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`) } // End of list of possible types for union field `kind`. }

{

  // 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)
  }
  // End of list of possible types for union field kind.
}

Fields
Union field `kind`. The kind of reply. May have no fields set if the request had no response. `kind` can be only one of the following:
`addNamedRange`	`object (AddNamedRangeResponse)` A reply from adding a named range.
`addSheet`	`object (AddSheetResponse)` A reply from adding a sheet.
`addFilterView`	`object (AddFilterViewResponse)` A reply from adding a filter view.
`duplicateFilterView`	`object (DuplicateFilterViewResponse)` A reply from duplicating a filter view.
`duplicateSheet`	`object (DuplicateSheetResponse)` A reply from duplicating a sheet.
`findReplace`	`object (FindReplaceResponse)` A reply from doing a find/replace.
`updateEmbeddedObjectPosition`	`object (UpdateEmbeddedObjectPositionResponse)` A reply from updating an embedded object's position.
`updateConditionalFormatRule`	`object (UpdateConditionalFormatRuleResponse)` A reply from updating a conditional format rule.
`deleteConditionalFormatRule`	`object (DeleteConditionalFormatRuleResponse)` A reply from deleting a conditional format rule.
`addProtectedRange`	`object (AddProtectedRangeResponse)` A reply from adding a protected range.
`addChart`	`object (AddChartResponse)` A reply from adding a chart.
`addBanding`	`object (AddBandingResponse)` A reply from adding a banded range.
`createDeveloperMetadata`	`object (CreateDeveloperMetadataResponse)` A reply from creating a developer metadata entry.
`updateDeveloperMetadata`	`object (UpdateDeveloperMetadataResponse)` A reply from updating a developer metadata entry.
`deleteDeveloperMetadata`	`object (DeleteDeveloperMetadataResponse)` A reply from deleting a developer metadata entry.
`addDimensionGroup`	`object (AddDimensionGroupResponse)` A reply from adding a dimension group.
`deleteDimensionGroup`	`object (DeleteDimensionGroupResponse)` A reply from deleting a dimension group.
`trimWhitespace`	`object (TrimWhitespaceResponse)` A reply from trimming whitespace.
`deleteDuplicates`	`object (DeleteDuplicatesResponse)` A reply from removing rows containing duplicate values.
`addSlicer`	`object (AddSlicerResponse)` A reply from adding a slicer.
`addDataSource`	`object (AddDataSourceResponse)` A reply from adding a data source.
`updateDataSource`	`object (UpdateDataSourceResponse)` A reply from updating a data source.
`refreshDataSource`	`object (RefreshDataSourceResponse)` A reply from refreshing data source objects.

AddNamedRangeResponse

The result of adding a named range.

JSON representation
{ "namedRange": { object (`NamedRange`) } }

Fields

Fields
`namedRange`	`object (NamedRange)` The named range to add.

namedRange

object (NamedRange)

The named range to add.

AddSheetResponse

The result of adding a sheet.

JSON representation
{ "properties": { object (`SheetProperties`) } }

Fields

Fields
`properties`	`object (SheetProperties)` The properties of the newly added sheet.

properties

object (SheetProperties)

The properties of the newly added sheet.

AddFilterViewResponse

The result of adding a filter view.

JSON representation
{ "filter": { object (`FilterView`) } }

Fields

Fields
`filter`	`object (FilterView)` The newly added filter view.

filter

object (FilterView)

The newly added filter view.

DuplicateFilterViewResponse

The result of a filter view being duplicated.

JSON representation
{ "filter": { object (`FilterView`) } }

Fields

Fields
`filter`	`object (FilterView)` The newly created filter.

filter

object (FilterView)

The newly created filter.

DuplicateSheetResponse

The result of duplicating a sheet.

JSON representation
{ "properties": { object (`SheetProperties`) } }

Fields

Fields
`properties`	`object (SheetProperties)` The properties of the duplicate sheet.

properties

object (SheetProperties)

The properties of the duplicate sheet.

FindReplaceResponse

The result of the find/replace.

JSON representation
{ "valuesChanged": integer, "formulasChanged": integer, "rowsChanged": integer, "sheetsChanged": integer, "occurrencesChanged": integer }

Fields
`valuesChanged`	`integer` The number of non-formula cells changed.
`formulasChanged`	`integer` The number of formula cells changed.
`rowsChanged`	`integer` The number of rows changed.
`sheetsChanged`	`integer` The number of sheets changed.
`occurrencesChanged`	`integer` The number of occurrences (possibly multiple within a cell) changed. For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`.

UpdateEmbeddedObjectPositionResponse

The result of updating an embedded object's position.

JSON representation
{ "position": { object (`EmbeddedObjectPosition`) } }

Fields

Fields
`position`	`object (EmbeddedObjectPosition)` The new position of the embedded object.

position

object (EmbeddedObjectPosition)

The new position of the embedded object.

UpdateConditionalFormatRuleResponse

The result of updating a conditional format rule.

JSON representation

JSON representation
{ "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,

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

Fields
`newRule`	`object (ConditionalFormatRule)` The new rule that replaced the old rule (if replacing), or the rule that was moved (if moved)
`newIndex`	`integer` The index of the new rule.
Union field `old_info`. Information about the prior rule. `old_info` can be only one of the following:
`oldRule`	`object (ConditionalFormatRule)` The old (deleted) rule. Not set if a rule was moved (because it is the same as `newRule`).
`oldIndex`	`integer` The old index of the rule. Not set if a rule was replaced (because it is the same as `newIndex`).

DeleteConditionalFormatRuleResponse

The result of deleting a conditional format rule.

JSON representation
{ "rule": { object (`ConditionalFormatRule`) } }

Fields

Fields
`rule`	`object (ConditionalFormatRule)` The rule that was deleted.

rule

object (ConditionalFormatRule)

The rule that was deleted.

AddProtectedRangeResponse

The result of adding a new protected range.

JSON representation
{ "protectedRange": { object (`ProtectedRange`) } }

Fields

Fields
`protectedRange`	`object (ProtectedRange)` The newly added protected range.

protectedRange

object (ProtectedRange)

The newly added protected range.

AddChartResponse

The result of adding a chart to a spreadsheet.

JSON representation
{ "chart": { object (`EmbeddedChart`) } }

Fields

Fields
`chart`	`object (EmbeddedChart)` The newly added chart.

chart

object (EmbeddedChart)

The newly added chart.

AddBandingResponse

The result of adding a banded range.

JSON representation
{ "bandedRange": { object (`BandedRange`) } }

Fields

Fields
`bandedRange`	`object (BandedRange)` The banded range that was added.

bandedRange

object (BandedRange)

The banded range that was added.

CreateDeveloperMetadataResponse

The response from creating developer metadata.

JSON representation
{ "developerMetadata": { object (`DeveloperMetadata`) } }

Fields

developerMetadata

object (DeveloperMetadata)

The developer metadata that was created.

UpdateDeveloperMetadataResponse

The response from updating developer metadata.

JSON representation
{ "developerMetadata": [ { object (`DeveloperMetadata`) } ] }

Fields

developerMetadata[]

object (DeveloperMetadata)

The updated developer metadata.

DeleteDeveloperMetadataResponse

The response from deleting developer metadata.

JSON representation
{ "deletedDeveloperMetadata": [ { object (`DeveloperMetadata`) } ] }

Fields

deletedDeveloperMetadata[]

object (DeveloperMetadata)

The metadata that was deleted.

AddDimensionGroupResponse

The result of adding a group.

JSON representation
{ "dimensionGroups": [ { object (`DimensionGroup`) } ] }

Fields

Fields
`dimensionGroups[]`	`object (DimensionGroup)` All groups of a dimension after adding a group to that dimension.

dimensionGroups[]

object (DimensionGroup)

All groups of a dimension after adding a group to that dimension.

DeleteDimensionGroupResponse

The result of deleting a group.

JSON representation
{ "dimensionGroups": [ { object (`DimensionGroup`) } ] }

Fields

Fields
`dimensionGroups[]`	`object (DimensionGroup)` All groups of a dimension after deleting a group from that dimension.

dimensionGroups[]

object (DimensionGroup)

All groups of a dimension after deleting a group from that dimension.

TrimWhitespaceResponse

The result of trimming whitespace in cells.

JSON representation
{ "cellsChangedCount": integer }

Fields

Fields
`cellsChangedCount`	`integer` The number of cells that were trimmed of whitespace.

cellsChangedCount

integer

The number of cells that were trimmed of whitespace.

DeleteDuplicatesResponse

The result of removing duplicates in a range.

JSON representation
{ "duplicatesRemovedCount": integer }

Fields

Fields
`duplicatesRemovedCount`	`integer` The number of duplicate rows removed.

duplicatesRemovedCount

integer

The number of duplicate rows removed.

AddSlicerResponse

The result of adding a slicer to a spreadsheet.

JSON representation
{ "slicer": { object (`Slicer`) } }

Fields

Fields
`slicer`	`object (Slicer)` The newly added slicer.

slicer

object (Slicer)

The newly added slicer.

AddDataSourceResponse

The result of adding a data source.

JSON representation
{ "dataSource": { object (`DataSource`) }, "dataExecutionStatus": { object (`DataExecutionStatus`) } }

Fields

Fields
`dataSource`	`object (DataSource)` The data source that was created.
`dataExecutionStatus`	`object (DataExecutionStatus)` The data execution status.

dataSource

object (DataSource)

The data source that was created.

dataExecutionStatus

object (DataExecutionStatus)

The data execution status.

UpdateDataSourceResponse

The response from updating data source.

JSON representation
{ "dataSource": { object (`DataSource`) }, "dataExecutionStatus": { object (`DataExecutionStatus`) } }

Fields

Fields
`dataSource`	`object (DataSource)` The updated data source.
`dataExecutionStatus`	`object (DataExecutionStatus)` The data execution status.

dataSource

object (DataSource)

The updated data source.

dataExecutionStatus

object (DataExecutionStatus)

The data execution status.

RefreshDataSourceResponse

The response from refreshing one or multiple data source objects.

JSON representation
{ "statuses": [ { object (`RefreshDataSourceObjectExecutionStatus`) } ] }

Fields

Fields
`statuses[]`	`object (RefreshDataSourceObjectExecutionStatus)` All the refresh status for the data source object references specified in the request. If `isAll` is specified, the field contains only those in failure status.

statuses[]

object (RefreshDataSourceObjectExecutionStatus)

All the refresh status for the data source object references specified in the request. If isAll is specified, the field contains only those in failure status.

RefreshDataSourceObjectExecutionStatus

The execution status of refreshing one data source object.

JSON representation
{ "reference": { object (`DataSourceObjectReference`) }, "dataExecutionStatus": { object (`DataExecutionStatus`) } }

Fields

Fields
`reference`	`object (DataSourceObjectReference)` Reference to a data source object being refreshed.
`dataExecutionStatus`	`object (DataExecutionStatus)` The data execution status.

reference

object (DataSourceObjectReference)

Reference to a data source object being refreshed.

dataExecutionStatus

object (DataExecutionStatus)

The data execution status.