Responses

Response

A single response from an update.

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

AddNamedRangeResponse

The result of adding a named range.

JSON representation
{
  "namedRange": {
    object(NamedRange)
  },
}
Fields
namedRange

object( NamedRange )

The named range to add.

AddSheetResponse

The result of adding a sheet.

JSON representation
{
  "properties": {
    object(SheetProperties)
  },
}
Fields
properties

object( SheetProperties )

The properties of the newly added sheet.

AddFilterViewResponse

The result of adding a filter view.

JSON representation
{
  "filter": {
    object(FilterView)
  },
}
Fields
filter

object( FilterView )

The newly added filter view.

DuplicateFilterViewResponse

The result of a filter view being duplicated.

JSON representation
{
  "filter": {
    object(FilterView)
  },
}
Fields
filter

object( FilterView )

The newly created filter.

DuplicateSheetResponse

The result of duplicating a sheet.

JSON representation
{
  "properties": {
    object(SheetProperties)
  },
}
Fields
properties

object( SheetProperties )

The properties of the duplicate sheet.

FindReplaceResponse

The result of the find/replace.

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

number

The number of non-formula cells changed.

formulasChanged

number

The number of formula cells changed.

rowsChanged

number

The number of rows changed.

sheetsChanged

number

The number of sheets changed.

occurrencesChanged

number

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
position

object( EmbeddedObjectPosition )

The new position of the embedded object.

UpdateConditionalFormatRuleResponse

The result of updating a conditional format rule.

JSON representation
{
  "newRule": {
    object(ConditionalFormatRule)
  },
  "newIndex": number,

  // Union field old_info can be only one of the following:
  "oldRule": {
    object(ConditionalFormatRule)
  },
  "oldIndex": number,
  // 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

number

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

number

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
rule

object( ConditionalFormatRule )

The rule that was deleted.

AddProtectedRangeResponse

The result of adding a new protected range.

JSON representation
{
  "protectedRange": {
    object(ProtectedRange)
  },
}
Fields
protectedRange

object( ProtectedRange )

The newly added protected range.

AddChartResponse

The result of adding a chart to a spreadsheet.

JSON representation
{
  "chart": {
    object(EmbeddedChart)
  },
}
Fields
chart

object( EmbeddedChart )

The newly added chart.

AddBandingResponse

The result of adding a banded range.

JSON representation
{
  "bandedRange": {
    object(BandedRange)
  },
}
Fields
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.

Send feedback about...