Responses

Resposta

Uma única resposta de uma atualização.

Representação JSON 
{

  "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)
  },
  "addTable": {
    object (AddTableResponse)
  }
}
Campos
Campo de união kind. O tipo de resposta. Pode não ter campos definidos se a solicitação não tiver uma resposta. kind pode ser apenas um dos seguintes:
addNamedRange

object (AddNamedRangeResponse)

Uma resposta ao adicionar um intervalo nomeado.

addSheet

object (AddSheetResponse)

Uma resposta ao adicionar uma planilha.

addFilterView

object (AddFilterViewResponse)

Uma resposta ao adicionar uma visualização com filtro.
duplicateFilterView

object (DuplicateFilterViewResponse)

Uma resposta da duplicação de uma visualização de filtro.

duplicateSheet

object (DuplicateSheetResponse)

Uma resposta da duplicação de uma planilha.

findReplace

object (FindReplaceResponse)

Uma resposta de uma ação de localizar/substituir.

updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionResponse)

Uma resposta da atualização da posição de um objeto incorporado.

updateConditionalFormatRule

object (UpdateConditionalFormatRuleResponse)

Uma resposta da atualização de uma regra de formatação condicional.

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleResponse)

Uma resposta da exclusão de uma regra de formatação condicional.

addProtectedRange

object (AddProtectedRangeResponse)

Uma resposta ao adicionar um intervalo protegido.

addChart

object (AddChartResponse)

Uma resposta ao adicionar um gráfico.

addBanding

object (AddBandingResponse)

Uma resposta ao adicionar um intervalo agrupado.

createDeveloperMetadata

object (CreateDeveloperMetadataResponse)

Uma resposta da criação de uma entrada de metadados do desenvolvedor.

updateDeveloperMetadata

object (UpdateDeveloperMetadataResponse)

Uma resposta da atualização de uma entrada de metadados do desenvolvedor.

deleteDeveloperMetadata

object (DeleteDeveloperMetadataResponse)

Uma resposta da exclusão de uma entrada de metadados do desenvolvedor.

addDimensionGroup

object (AddDimensionGroupResponse)

Uma resposta ao adicionar um grupo de dimensões.

deleteDimensionGroup

object (DeleteDimensionGroupResponse)

Uma resposta da exclusão de um grupo de dimensões.

trimWhitespace

object (TrimWhitespaceResponse)

Uma resposta do corte de espaços em branco.

deleteDuplicates

object (DeleteDuplicatesResponse)

Uma resposta da remoção de linhas que contêm valores duplicados.

addSlicer

object (AddSlicerResponse)

Uma resposta ao adicionar um controle de filtros.

addDataSource

object (AddDataSourceResponse)

Uma resposta ao adicionar uma fonte de dados.

updateDataSource

object (UpdateDataSourceResponse)

Uma resposta da atualização de uma fonte de dados.

refreshDataSource

object (RefreshDataSourceResponse)

Uma resposta da atualização de objetos da fonte de dados.

cancelDataSourceRefresh

object (CancelDataSourceRefreshResponse)

Uma resposta do cancelamento de atualizações de objetos da fonte de dados.

addTable

object (AddTableResponse)

Uma resposta ao adicionar uma tabela.

DataSourceObjectReference

Referência a um objeto de fonte de dados.

Representação JSON 
{

  "sheetId": string,
  "chartId": integer,
  "dataSourceTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourcePivotTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourceFormulaCell": {
    object (GridCoordinate)
  }
}
Campos
Campo de união value. O tipo de referência. value pode ser apenas um dos seguintes:
sheetId

string

Referências a uma página DATA_SOURCE.

chartId

integer

Referências a um gráfico de fonte de dados.

dataSourceTableAnchorCell

object (GridCoordinate)

Referências a um DataSourceTable ancorado na célula.

dataSourcePivotTableAnchorCell

object (GridCoordinate)

Referências a uma fonte de dados PivotTable ancoradas na célula.

dataSourceFormulaCell

object (GridCoordinate)

Referências a uma célula que contém DataSourceFormula.

AddNamedRangeResponse

O resultado da adição de um intervalo nomeado.

Representação JSON 
{
  "namedRange": {
    object (NamedRange)
  }
}
Campos
namedRange

object (NamedRange)

O intervalo nomeado a ser adicionado.

AddSheetResponse

O resultado da adição de uma planilha.

Representação JSON 
{
  "properties": {
    object (SheetProperties)
  }
}
Campos
properties

object (SheetProperties)

As propriedades da planilha recém-adicionada.

AddFilterViewResponse

O resultado da adição de uma visualização com filtro.

Representação JSON 
{
  "filter": {
    object (FilterView)
  }
}
Campos
filter

object (FilterView)

A visualização com filtro recém-adicionada.

DuplicateFilterViewResponse

O resultado da duplicação de uma visualização com filtro.

Representação JSON 
{
  "filter": {
    object (FilterView)
  }
}
Campos
filter

object (FilterView)

O filtro recém-criado.

DuplicateSheetResponse

O resultado da duplicação de uma página.

Representação JSON 
{
  "properties": {
    object (SheetProperties)
  }
}
Campos
properties

object (SheetProperties)

As propriedades da planilha duplicada.

FindReplaceResponse

O resultado da ação de localizar/substituir.

Representação JSON 
{
  "valuesChanged": integer,
  "formulasChanged": integer,
  "rowsChanged": integer,
  "sheetsChanged": integer,
  "occurrencesChanged": integer
}
Campos
valuesChanged

integer

O número de células sem fórmulas mudou.

formulasChanged

integer

O número de células de fórmula mudou.

rowsChanged

integer

O número de linhas mudadas.

sheetsChanged

integer

O número de páginas mudou.

occurrencesChanged

integer

O número de ocorrências (possivelmente várias em uma célula) mudou. Por exemplo, se você substituir "e" por "o" em "Google Sheets", o resultado será "3" porque "Google Sheets" -> "Googlo Shoots".

UpdateEmbeddedObjectPositionResponse

O resultado da atualização da posição de um objeto incorporado.

Representação JSON 
{
  "position": {
    object (EmbeddedObjectPosition)
  }
}
Campos
position

object (EmbeddedObjectPosition)

A nova posição do objeto incorporado.

UpdateConditionalFormatRuleResponse

O resultado da atualização de uma regra de formatação condicional.

Representação JSON 
{
  "newRule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer,

  "oldRule": {
    object (ConditionalFormatRule)
  },
  "oldIndex": integer
}
Campos
newRule

object (ConditionalFormatRule)

A nova regra que substituiu a antiga (se houver substituição) ou a regra que foi movida (se houver movimentação)

newIndex

integer

O índice da nova regra.

Campo de união old_info. Informações sobre a regra de distribuição a priori. old_info pode ser apenas um dos seguintes:
oldRule

object (ConditionalFormatRule)

A regra antiga (excluída). Não definido se uma regra foi movida (porque é igual a newRule).

oldIndex

integer

O índice antigo da regra. Não definido se uma regra foi substituída (porque é igual a newIndex).

DeleteConditionalFormatRuleResponse

O resultado da exclusão de uma regra de formatação condicional.

Representação JSON 
{
  "rule": {
    object (ConditionalFormatRule)
  }
}
Campos
rule

object (ConditionalFormatRule)

A regra que foi excluída.

AddProtectedRangeResponse

O resultado da adição de um novo intervalo protegido.

Representação JSON 
{
  "protectedRange": {
    object (ProtectedRange)
  }
}
Campos
protectedRange

object (ProtectedRange)

O intervalo protegido recém-adicionado.

AddChartResponse

O resultado de adicionar um gráfico a uma planilha.

Representação JSON 
{
  "chart": {
    object (EmbeddedChart)
  }
}
Campos
chart

object (EmbeddedChart)

O gráfico recém-adicionado.

AddBandingResponse

O resultado da adição de um intervalo agrupado.

Representação JSON 
{
  "bandedRange": {
    object (BandedRange)
  }
}
Campos
bandedRange

object (BandedRange)

O intervalo agrupado que foi adicionado.

CreateDeveloperMetadataResponse

A resposta da criação de metadados do desenvolvedor.

Representação JSON 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
Campos
developerMetadata

object (DeveloperMetadata)

Os metadados do desenvolvedor que foram criados.

UpdateDeveloperMetadataResponse

A resposta da atualização dos metadados do desenvolvedor.

Representação JSON 
{
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
Campos
developerMetadata[]

object (DeveloperMetadata)

Os metadados de desenvolvedor atualizados.

DeleteDeveloperMetadataResponse

A resposta da exclusão de metadados do desenvolvedor.

Representação JSON 
{
  "deletedDeveloperMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
Campos
deletedDeveloperMetadata[]

object (DeveloperMetadata)

Os metadados excluídos.

AddDimensionGroupResponse

O resultado da adição de um grupo.

Representação JSON 
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
Campos
dimensionGroups[]

object (DimensionGroup)

Todos os grupos de uma dimensão depois de adicionar um grupo a ela.

DeleteDimensionGroupResponse

O resultado da exclusão de um grupo.

Representação JSON 
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
Campos
dimensionGroups[]

object (DimensionGroup)

Todos os grupos de uma dimensão depois de excluir um grupo dela.

TrimWhitespaceResponse

O resultado do corte de espaços em branco nas células.

Representação JSON 
{
  "cellsChangedCount": integer
}
Campos
cellsChangedCount

integer

O número de células que tiveram o espaço em branco cortado.

DeleteDuplicatesResponse

O resultado da remoção de duplicatas em um intervalo.

Representação JSON 
{
  "duplicatesRemovedCount": integer
}
Campos
duplicatesRemovedCount

integer

O número de linhas duplicadas removidas.

AddSlicerResponse

O resultado de adicionar um controle de filtros a uma planilha.

Representação JSON 
{
  "slicer": {
    object (Slicer)
  }
}
Campos
slicer

object (Slicer)

O controle de filtros recém-adicionado.

AddDataSourceResponse

O resultado da adição de uma fonte de dados.

Representação JSON 
{
  "dataSource": {
    object (DataSource)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Campos
dataSource

object (DataSource)

A fonte de dados criada.

dataExecutionStatus

object (DataExecutionStatus)

O status da execução de dados.

UpdateDataSourceResponse

A resposta da atualização da fonte de dados.

Representação JSON 
{
  "dataSource": {
    object (DataSource)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Campos
dataSource

object (DataSource)

A fonte de dados atualizada.

dataExecutionStatus

object (DataExecutionStatus)

O status da execução de dados.

RefreshDataSourceResponse

A resposta da atualização de um ou mais objetos de fonte de dados.

Representação JSON 
{
  "statuses": [
    {
      object (RefreshDataSourceObjectExecutionStatus)
    }
  ]
}
Campos
statuses[]

object (RefreshDataSourceObjectExecutionStatus)

Todos os status de atualização para as referências de objetos da fonte de dados especificadas na solicitação. Se isAll for especificado, o campo vai conter apenas aqueles com status de falha.

RefreshDataSourceObjectExecutionStatus

O status da execução da atualização de um objeto da fonte de dados.

Representação JSON 
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Campos
reference

object (DataSourceObjectReference)

Referência a um objeto de fonte de dados que está sendo atualizado.

dataExecutionStatus

object (DataExecutionStatus)

O status da execução de dados.

CancelDataSourceRefreshResponse

A resposta do cancelamento de uma ou várias atualizações de objetos de fonte de dados.

Representação JSON 
{
  "statuses": [
    {
      object (CancelDataSourceRefreshStatus)
    }
  ]
}
Campos
statuses[]

object (CancelDataSourceRefreshStatus)

Os status de cancelamento das atualizações de todos os objetos de fonte de dados especificados na solicitação. Se isAll for especificado, o campo vai conter apenas aqueles com status de falha. Também não é permitido atualizar e cancelar a atualização do mesmo objeto de fonte de dados no mesmo batchUpdate.

CancelDataSourceRefreshStatus

O status do cancelamento de uma única atualização de objeto da fonte de dados.

Representação JSON 
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "refreshCancellationStatus": {
    object (RefreshCancellationStatus)
  }
}
Campos
reference

object (DataSourceObjectReference)

Referência ao objeto da fonte de dados cuja atualização está sendo cancelada.

refreshCancellationStatus

object (RefreshCancellationStatus)

O status do cancelamento.

RefreshCancellationStatus

O status de um cancelamento de atualização.

Você pode enviar um cancel request para cancelar explicitamente uma ou várias atualizações de objetos de fonte de dados.

Representação JSON 
{
  "state": enum (RefreshCancellationState),
  "errorCode": enum (RefreshCancellationErrorCode)
}
Campos
state

enum (RefreshCancellationState)

O estado de uma chamada para cancelar uma atualização nas Planilhas Google.

errorCode

enum (RefreshCancellationErrorCode)

O código do erro.

RefreshCancellationState

Uma enumeração de estados de cancelamento de atualização.

Tipos enumerados
REFRESH_CANCELLATION_STATE_UNSPECIFIED Valor padrão. Não usar.
CANCEL_SUCCEEDED A chamada de API para o Planilhas Google para cancelar uma atualização foi concluída. Isso não significa que o cancelamento foi feito, mas que a chamada foi realizada.
CANCEL_FAILED A chamada de API para o Google Sheets para cancelar uma atualização falhou.

RefreshCancellationErrorCode

Uma enumeração dos códigos de erro de cancelamento da atualização.

Tipos enumerados
REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED Valor padrão. Não usar.
EXECUTION_NOT_FOUND A execução a ser cancelada não foi encontrada no mecanismo de consulta ou no Google Planilhas.
CANCEL_PERMISSION_DENIED O usuário não tem permissão para cancelar a consulta.
QUERY_EXECUTION_COMPLETED A execução da consulta já foi concluída e, portanto, não pôde ser cancelada.
CONCURRENT_CANCELLATION Já há outro cancelamento em andamento.
CANCEL_OTHER_ERROR Todos os outros erros.

AddTableResponse

O resultado da adição de uma tabela.

Representação JSON 
{
  "table": {
    object (Table)
  }
}
Campos
table

object (Table)

Apenas saída. A tabela que foi adicionada.