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. Pode não ter campos definidos se a solicitação não tiver resposta. kind pode ser apenas de um dos tipos a seguir:
addNamedRange

object (AddNamedRangeResponse)

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

addSheet

object (AddSheetResponse)

Uma resposta da adição de uma planilha.

addFilterView

object (AddFilterViewResponse)

Uma resposta da adição de uma visualização com filtro.

duplicateFilterView

object (DuplicateFilterViewResponse)

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

duplicateSheet

object (DuplicateSheetResponse)

Uma resposta de duplicar uma página.

findReplace

object (FindReplaceResponse)

Uma resposta de uma operaçã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 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 de faixas.

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 de 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)

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

trimWhitespace

object (TrimWhitespaceResponse)

Uma resposta de cortar espaços em branco.

deleteDuplicates

object (DeleteDuplicatesResponse)

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

addSlicer

object (AddSlicerResponse)

Uma resposta da adição de um controle de filtros.

addDataSource

object (AddDataSourceResponse)

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

updateDataSource

object (UpdateDataSourceResponse)

Uma resposta de 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 das atualizações do objeto da fonte de dados.

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 página 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 página duplicada.

FindReplaceResponse

O resultado 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 que não são da fórmula foi alterado.

formulasChanged

integer

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

rowsChanged

integer

O número de linhas foi alterado.

sheetsChanged

integer

O número de páginas foi alterado.

occurrencesChanged

integer

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

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 for substituída) 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 de um dos tipos a seguir:
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

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 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 de 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 de metadados do desenvolvedor.

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

object (DeveloperMetadata)

Os metadados atualizados do desenvolvedor.

DeleteDeveloperMetadataResponse

A resposta da exclusão dos 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 após 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 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 foram removidas do espaço em branco.

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 da adição de 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 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 vários 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 especificadas na solicitação. Se isAll for especificado, o campo conterá apenas aqueles em status de falha.

RefreshDataSourceObjectExecutionStatus

O status de execução da atualização de um objeto de 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 de execução dos 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)

O status de cancelamento das atualizações de todos os objetos de fonte de dados especificados na solicitação. Se isAll for especificado, o campo conterá apenas aqueles em 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 de cancelamento de uma única atualização do 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 de 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 no app Planilhas.

errorCode

enum (RefreshCancellationErrorCode)

O código do erro.

RefreshCancellationState

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

Enums
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 concluído, mas que a chamada foi feita.
CANCEL_FAILED Falha na chamada de API para o Planilhas Google para cancelar uma atualização.

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 nem no app 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.