Responses

Resposta

Uma única resposta de uma atualização.

Representação 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.
}
Campos
Campo de união kind. O tipo de resposta. Talvez não tenha campos definidos se a solicitação não tiver resposta. kind pode ser apenas um dos seguintes:
addNamedRange

object (AddNamedRangeResponse)

Uma resposta da adição de um intervalo nomeado.

addSheet

object (AddSheetResponse)

Uma resposta ao adicionar uma planilha.

addFilterView

object (AddFilterViewResponse)

Resposta ao adicionar uma visualização com filtro.

duplicateFilterView

object (DuplicateFilterViewResponse)

Uma resposta de 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 pesquisa/substituição.

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 da adição de um intervalo protegido.

addChart

object (AddChartResponse)

Uma resposta da adição de um gráfico.

addBanding

object (AddBandingResponse)

Uma resposta da adição de um intervalo em intervalos.

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 da adição de um grupo de dimensões.

deleteDimensionGroup

object (DeleteDimensionGroupResponse)

Resposta da exclusão de um grupo de dimensão.

trimWhitespace

object (TrimWhitespaceResponse)

Uma resposta de corte de espaço em branco.

deleteDuplicates

object (DeleteDuplicatesResponse)

Uma resposta na remoção de linhas contendo valores duplicados.

addSlicer

object (AddSlicerResponse)

Uma resposta da adição de um fatiador.

addDataSource

object (AddDataSourceResponse)

Uma resposta da adição de 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 dos objetos da fonte de dados.

cancelDataSourceRefresh

object (CancelDataSourceRefreshResponse)

Uma resposta do objeto da fonte de dados de cancelamento é atualizada.

DataSourceObjectReference

Referência a um objeto de origem de dados.

Representação JSON 
{

  // Union field value can be only one of the following:
  "sheetId": string,
  "chartId": integer,
  "dataSourceTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourcePivotTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourceFormulaCell": {
    object (GridCoordinate)
  }
  // End of list of possible types for union field value.
}
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 origem de dados PivotTable ancorada 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 página.

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 de 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 planilha.

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

object (SheetProperties)

As propriedades da página duplicada.

FindReplaceResponse

O resultado da pesquisa/substituição.

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 foi alterado.

sheetsChanged

integer

O número de planilhas mudou.

occurrencesChanged

integer

O número de ocorrências (possivelmente várias em uma célula) mudou. Por exemplo, se substituir "e" por "o" em "Google Sheets", esse valor 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,

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

object (ConditionalFormatRule)

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

newIndex

integer

O índice da nova regra.

Campo de união old_info. Informações sobre a regra anterior. 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

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

Resultado da adição de um novo intervalo protegido.

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

object (ProtectedRange)

O intervalo protegido que foi adicionado.

AddChartResponse

O resultado da adição de 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 com faixas.

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

object (BandedRange)

O intervalo de faixas 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 do desenvolvedor atualizados.

DeleteDeveloperMetadataResponse

A resposta da exclusão de metadados do desenvolvedor.

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

object (DeveloperMetadata)

Os metadados que foram 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 após a exclusão de um grupo dessa dimensão.

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 em que o espaço em branco foi removido.

DeleteDuplicatesResponse

O resultado da remoção de cópias em um intervalo.

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

integer

O número de linhas duplicadas removidas.

AddSlicerResponse

O resultado da adição de um seletor a uma planilha.

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

object (Slicer)

Controle de filtros adicionado recentemente.

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 que foi criada.

dataExecutionStatus

object (DataExecutionStatus)

O status de execução dos 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 de execução dos 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 das referências do objeto da fonte de dados especificados na solicitação. Se isAll for especificado, o campo vai conter apenas os que estiverem no status de falha.

RefreshDataSourceObjectExecutionStatus

O status de 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 sendo atualizado.

dataExecutionStatus

object (DataExecutionStatus)

O status de execução dos dados.

CancelDataSourceRefreshResponse

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

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

object (CancelDataSourceRefreshStatus)

Os status de cancelamento das atualizações de todos os objetos da fonte de dados especificados na solicitação. Se isAll for especificado, o campo conterá apenas aqueles em status de falha. A atualização e o cancelamento da atualização do mesmo objeto de fonte de dados também não são permitidos no mesmo batchUpdate.

CancelDataSourceRefreshStatus

Status de 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.

É possível 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.

errorCode

enum (RefreshCancellationErrorCode)

O código do erro.

RefreshCancellationState

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

Enums
REFRESH_CANCELLATION_STATE_UNSPECIFIED Valor padrão. Não use.
CANCEL_SUCCEEDED A chamada de API para as Planilhas para cancelar uma atualização foi bem-sucedida. Isso não significa que o cancelamento foi feito, mas que a chamada foi feita.
CANCEL_FAILED A chamada de API para as Planilhas para cancelar uma atualização falhou.

RefreshCancellationErrorCode

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

Enums
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 nas 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 pode ser cancelada.
CONCURRENT_CANCELLATION Já há outro cancelamento em andamento.
CANCEL_OTHER_ERROR Todos os outros erros.