Response
A single response from an update.
JSON representation |
---|
{ // Union field |
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
|
A reply from adding a named range. |
addSheet
|
A reply from adding a sheet. |
addFilterView
|
A reply from adding a filter view. |
duplicateFilterView
|
A reply from duplicating a filter view. |
duplicateSheet
|
A reply from duplicating a sheet. |
findReplace
|
A reply from doing a find/replace. |
updateEmbeddedObjectPosition
|
A reply from updating an embedded object's position. |
updateConditionalFormatRule
|
A reply from updating a conditional format rule. |
deleteConditionalFormatRule
|
A reply from deleting a conditional format rule. |
addProtectedRange
|
A reply from adding a protected range. |
addChart
|
A reply from adding a chart. |
addBanding
|
A reply from adding a banded range. |
createDeveloperMetadata
|
A reply from creating a developer metadata entry. |
updateDeveloperMetadata
|
A reply from updating a developer metadata entry. |
deleteDeveloperMetadata
|
A reply from deleting a developer metadata entry. |
addDimensionGroup
|
A reply from adding a dimension group. |
deleteDimensionGroup
|
A reply from deleting a dimension group. |
trimWhitespace
|
A reply from trimming whitespace. |
deleteDuplicates
|
A reply from removing rows containing duplicate values. |
addSlicer
|
A reply from adding a slicer. |
addDataSource
|
A reply from adding a data source. |
updateDataSource
|
A reply from updating a data source. |
refreshDataSource
|
A reply from refreshing data source objects. |
cancelDataSourceRefresh
|
A reply from cancelling data source object refreshes. |
DataSourceObjectReference
Reference to a data source object.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
value . The reference type.
value
can be only one of the following:
|
|
sheetId
|
References to a
|
chartId
|
References to a data source chart. |
dataSourceTableAnchorCell
|
References to a
|
dataSourcePivotTableAnchorCell
|
References to a data source
|
dataSourceFormulaCell
|
References to a cell containing
|
AddNamedRangeResponse
The result of adding a named range.
JSON representation |
---|
{
"namedRange": {
object (
|
Fields | |
---|---|
namedRange
|
The named range to add. |
AddSheetResponse
The result of adding a sheet.
JSON representation |
---|
{
"properties": {
object (
|
Fields | |
---|---|
properties
|
The properties of the newly added sheet. |
AddFilterViewResponse
The result of adding a filter view.
JSON representation |
---|
{
"filter": {
object (
|
Fields | |
---|---|
filter
|
The newly added filter view. |
DuplicateFilterViewResponse
The result of a filter view being duplicated.
JSON representation |
---|
{
"filter": {
object (
|
Fields | |
---|---|
filter
|
The newly created filter. |
DuplicateSheetResponse
The result of duplicating a sheet.
JSON representation |
---|
{
"properties": {
object (
|
Fields | |
---|---|
properties
|
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
|
The number of non-formula cells changed. |
formulasChanged
|
The number of formula cells changed. |
rowsChanged
|
The number of rows changed. |
sheetsChanged
|
The number of sheets changed. |
occurrencesChanged
|
The number of occurrences (possibly multiple within a cell) changed. For example, if replacing
|
UpdateEmbeddedObjectPositionResponse
The result of updating an embedded object's position.
JSON representation |
---|
{
"position": {
object (
|
Fields | |
---|---|
position
|
The new position of the embedded object. |
UpdateConditionalFormatRuleResponse
The result of updating a conditional format rule.
JSON representation |
---|
{ "newRule": { object ( |
Fields | |
---|---|
newRule
|
The new rule that replaced the old rule (if replacing), or the rule that was moved (if moved) |
newIndex
|
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
|
The old (deleted) rule. Not set if a rule was moved (because it is the same as
|
oldIndex
|
The old index of the rule. Not set if a rule was replaced (because it is the same as
|
DeleteConditionalFormatRuleResponse
The result of deleting a conditional format rule.
JSON representation |
---|
{
"rule": {
object (
|
Fields | |
---|---|
rule
|
The rule that was deleted. |
AddProtectedRangeResponse
The result of adding a new protected range.
JSON representation |
---|
{
"protectedRange": {
object (
|
Fields | |
---|---|
protectedRange
|
The newly added protected range. |
AddChartResponse
The result of adding a chart to a spreadsheet.
JSON representation |
---|
{
"chart": {
object (
|
Fields | |
---|---|
chart
|
The newly added chart. |
AddBandingResponse
The result of adding a banded range.
JSON representation |
---|
{
"bandedRange": {
object (
|
Fields | |
---|---|
bandedRange
|
The banded range that was added. |
CreateDeveloperMetadataResponse
The response from creating developer metadata.
JSON representation |
---|
{
"developerMetadata": {
object (
|
Fields | |
---|---|
developerMetadata
|
The developer metadata that was created. |
UpdateDeveloperMetadataResponse
The response from updating developer metadata.
JSON representation |
---|
{
"developerMetadata": [
{
object (
|
Fields | |
---|---|
developerMetadata[]
|
The updated developer metadata. |
DeleteDeveloperMetadataResponse
The response from deleting developer metadata.
JSON representation |
---|
{
"deletedDeveloperMetadata": [
{
object (
|
Fields | |
---|---|
deletedDeveloperMetadata[]
|
The metadata that was deleted. |
AddDimensionGroupResponse
The result of adding a group.
JSON representation |
---|
{
"dimensionGroups": [
{
object (
|
Fields | |
---|---|
dimensionGroups[]
|
All groups of a dimension after adding a group to that dimension. |
DeleteDimensionGroupResponse
The result of deleting a group.
JSON representation |
---|
{
"dimensionGroups": [
{
object (
|
Fields | |
---|---|
dimensionGroups[]
|
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 | |
---|---|
cellsChangedCount
|
The number of cells that were trimmed of whitespace. |
DeleteDuplicatesResponse
The result of removing duplicates in a range.
JSON representation |
---|
{ "duplicatesRemovedCount": integer } |
Fields | |
---|---|
duplicatesRemovedCount
|
The number of duplicate rows removed. |
AddSlicerResponse
The result of adding a slicer to a spreadsheet.
JSON representation |
---|
{
"slicer": {
object (
|
Fields | |
---|---|
slicer
|
The newly added slicer. |
AddDataSourceResponse
The result of adding a data source.
JSON representation |
---|
{ "dataSource": { object ( |
Fields | |
---|---|
dataSource
|
The data source that was created. |
dataExecutionStatus
|
The data execution status. |
UpdateDataSourceResponse
The response from updating data source.
JSON representation |
---|
{ "dataSource": { object ( |
Fields | |
---|---|
dataSource
|
The updated data source. |
dataExecutionStatus
|
The data execution status. |
RefreshDataSourceResponse
The response from refreshing one or multiple data source objects.
JSON representation |
---|
{
"statuses": [
{
object (
|
Fields | |
---|---|
statuses[]
|
All the refresh status for the data source object references specified in the request. If
|
RefreshDataSourceObjectExecutionStatus
The execution status of refreshing one data source object.
JSON representation |
---|
{ "reference": { object ( |
Fields | |
---|---|
reference
|
Reference to a data source object being refreshed. |
dataExecutionStatus
|
The data execution status. |
CancelDataSourceRefreshResponse
The response from cancelling one or multiple data source object refreshes.
JSON representation |
---|
{
"statuses": [
{
object (
|
Fields | |
---|---|
statuses[]
|
The cancellation statuses of refreshes of all data source objects specified in the request. If
|
CancelDataSourceRefreshStatus
The status of cancelling a single data source object refresh.
JSON representation |
---|
{ "reference": { object ( |
Fields | |
---|---|
reference
|
Reference to the data source object whose refresh is being cancelled. |
refreshCancellationStatus
|
The cancellation status. |
RefreshCancellationStatus
The status of a refresh cancellation.
You can send a
cancel request
to explicitly cancel one or multiple data source object refreshes.
JSON representation |
---|
{ "state": enum ( |
Fields | |
---|---|
state
|
The state of a call to cancel a refresh in Sheets. |
errorCode
|
The error code. |
RefreshCancellationState
An enumeration of refresh cancellation states.
Enums | |
---|---|
REFRESH_CANCELLATION_STATE_UNSPECIFIED
|
Default value, do not use. |
CANCEL_SUCCEEDED
|
The API call to Sheets to cancel a refresh has succeeded. This does not mean that the cancel happened successfully, but that the call has been made successfully. |
CANCEL_FAILED
|
The API call to Sheets to cancel a refresh has failed. |
RefreshCancellationErrorCode
An enumeration of the refresh cancellation error codes.
Enums | |
---|---|
REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED
|
Default value, do not use. |
EXECUTION_NOT_FOUND
|
Execution to be cancelled not found in the query engine or in Sheets. |
CANCEL_PERMISSION_DENIED
|
The user does not have permission to cancel the query. |
QUERY_EXECUTION_COMPLETED
|
The query execution has already completed and thus could not be cancelled. |
CONCURRENT_CANCELLATION
|
There is already another cancellation in process. |
CANCEL_OTHER_ERROR
|
All other errors. |