Solicitação
Um único tipo de atualização a ser aplicada a uma planilha.
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união
kind. O tipo de atualização. É necessário especificar exatamente um campo.
kind
pode ser apenas um dos seguintes:
|
|
updateSpreadsheetProperties
|
Atualiza as propriedades da planilha. |
updateSheetProperties
|
Atualiza as propriedades de uma página. |
updateDimensionProperties
|
Atualiza as propriedades das dimensões. |
updateNamedRange
|
Atualiza um intervalo nomeado. |
repeatCell
|
Repete uma única célula em um intervalo. |
addNamedRange
|
Adiciona um intervalo nomeado. |
deleteNamedRange
|
Exclui um intervalo nomeado. |
addSheet
|
Adiciona uma página. |
deleteSheet
|
Exclui uma página. |
autoFill
|
Preenche automaticamente mais dados com base nos dados atuais. |
cutPaste
|
Recorta dados de uma área e os cola em outra. |
copyPaste
|
Copia dados de uma área e os cola em outra. |
mergeCells
|
Mescla células. |
unmergeCells
|
Desfaz a mesclagem de células. |
updateBorders
|
Atualiza as bordas em um intervalo de células. |
updateCells
|
Atualiza várias células de uma só vez. |
addFilterView
|
Adiciona uma visualização com filtro. |
appendCells
|
Anexa células após a última linha com dados em uma planilha. |
clearBasicFilter
|
Limpa o filtro básico em uma planilha. |
deleteDimension
|
Exclui linhas ou colunas em uma planilha. |
deleteEmbeddedObject
|
Exclui um objeto incorporado (por exemplo, gráfico, imagem) em uma planilha. |
deleteFilterView
|
Exclui uma visualização com filtro de uma planilha. |
duplicateFilterView
|
Duplica uma visualização com filtro. |
duplicateSheet
|
Duplica uma página. |
findReplace
|
Encontra e substitui ocorrências de um texto por outro. |
insertDimension
|
Insere novas linhas ou colunas em uma página. |
insertRange
|
Insere novas células em uma página, movendo as células atuais. |
moveDimension
|
Move linhas ou colunas para outro local em uma planilha. |
updateEmbeddedObjectPosition
|
Atualiza a posição de um objeto incorporado (por exemplo, gráfico, imagem). |
pasteData
|
Cola dados (HTML ou delimitados) em uma planilha. |
textToColumns
|
Converte uma coluna de texto em várias colunas de texto. |
updateFilterView
|
Atualiza as propriedades de uma visualização de filtro. |
deleteRange
|
Exclui um intervalo de células de uma planilha, deslocando as células restantes. |
appendDimension
|
Anexa dimensões ao final de uma planilha. |
addConditionalFormatRule
|
Adiciona uma regra de formatação condicional. |
updateConditionalFormatRule
|
Atualiza uma regra de formatação condicional. |
deleteConditionalFormatRule
|
Exclui uma regra de formatação condicional. |
sortRange
|
Classifica dados em um intervalo. |
setDataValidation
|
Define a validação de dados para uma ou mais células. |
setBasicFilter
|
Define o filtro básico em uma planilha. |
addProtectedRange
|
Adiciona um intervalo protegido. |
updateProtectedRange
|
Atualiza um intervalo protegido. |
deleteProtectedRange
|
Exclui um intervalo protegido. |
autoResizeDimensions
|
Redimensiona automaticamente uma ou mais dimensões com base no conteúdo das células. |
addChart
|
Adiciona um gráfico. |
updateChartSpec
|
Atualiza as especificações de um gráfico. |
updateBanding
|
Atualiza um intervalo agrupado |
addBanding
|
Adiciona um novo intervalo agrupado. |
deleteBanding
|
Remove um intervalo com bandas |
createDeveloperMetadata
|
Cria novos metadados de desenvolvedor. |
updateDeveloperMetadata
|
Atualiza uma entrada de metadados do desenvolvedor |
deleteDeveloperMetadata
|
Exclui metadados do desenvolvedor. |
randomizeRange
|
Coloca em ordem aleatória as linhas em um intervalo. |
addDimensionGroup
|
Cria um grupo no intervalo especificado. |
deleteDimensionGroup
|
Exclui um grupo no intervalo especificado. |
updateDimensionGroup
|
Atualiza o estado do grupo especificado. |
trimWhitespace
|
Corta o espaço em branco das células (como espaços, tabulações ou novas linhas). |
deleteDuplicates
|
Remove linhas que contêm valores duplicados nas colunas especificadas de um intervalo de células. |
updateEmbeddedObjectBorder
|
Atualiza a borda de um objeto incorporado. |
addSlicer
|
Adiciona um controle de filtros. |
updateSlicerSpec
|
Atualiza as especificações de um segmentador. |
addDataSource
|
Adiciona uma fonte de dados. |
updateDataSource
|
Atualiza uma fonte de dados. |
deleteDataSource
|
Exclui uma fonte de dados. |
refreshDataSource
|
Atualiza uma ou várias fontes de dados e dbobjects associados. |
cancelDataSourceRefresh
|
Cancela as atualizações de uma ou várias fontes de dados e dbobjects associados. |
addTable
|
Adiciona uma tabela. |
updateTable
|
Atualiza uma tabela. |
deleteTable
|
Uma solicitação para excluir uma tabela. |
UpdateSpreadsheetPropertiesRequest
Atualiza as propriedades de uma planilha.
| Representação JSON |
|---|
{
"properties": {
object ( |
| Campos | |
|---|---|
properties
|
As propriedades a serem atualizadas. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz "properties" está implícita e não precisa ser especificada. Um único
|
UpdateSheetPropertiesRequest
Atualiza as propriedades da planilha com o sheetId especificado.
| Representação JSON |
|---|
{
"properties": {
object ( |
| Campos | |
|---|---|
properties
|
As propriedades a serem atualizadas. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
UpdateDimensionPropertiesRequest
Atualiza as propriedades das dimensões no intervalo especificado.
| Representação JSON |
|---|
{ "properties": { object ( |
| Campos | |
|---|---|
properties
|
Propriedades a serem atualizadas. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
Campo de união
dimension_range. O intervalo de dimensão.
dimension_range
pode ser apenas um dos seguintes:
|
|
range
|
As linhas ou colunas a serem atualizadas. |
dataSourceSheetRange
|
As colunas em uma planilha de fonte de dados a serem atualizadas. |
DataSourceSheetDimensionRange
Um intervalo ao longo de uma única dimensão em uma página DATA_SOURCE.
| Representação JSON |
|---|
{
"sheetId": integer,
"columnReferences": [
{
object ( |
| Campos | |
|---|---|
sheetId
|
O ID da página de fonte de dados em que o intervalo está. |
columnReferences[]
|
As colunas na planilha da fonte de dados. |
UpdateNamedRangeRequest
Atualiza as propriedades do intervalo nomeado com o namedRangeId especificado.
| Representação JSON |
|---|
{
"namedRange": {
object ( |
| Campos | |
|---|---|
namedRange
|
O intervalo nomeado a ser atualizado com as novas propriedades. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
RepeatCellRequest
Atualiza todas as células no intervalo com os valores no objeto Cell especificado. Somente os campos listados no campo
fields
são atualizados. Os outros permanecem inalterados.
Se você estiver gravando uma célula com uma fórmula, os intervalos dela serão incrementados automaticamente para cada campo no intervalo. Por exemplo, se você estiver gravando uma célula com a fórmula
=A1
no intervalo B2:C4, B2 será
=A1, B3 será
=A2, B4 será
=A3, C2 será
=B1, C3 será
=B2 e C4 será
=B3.
Para manter os intervalos da fórmula estáticos, use o indicador $. Por exemplo, use a fórmula
=$A$1
para evitar que a linha e a coluna sejam incrementadas.
| Representação JSON |
|---|
{ "range": { object ( |
| Campos | |
|---|---|
range
|
O intervalo em que a célula será repetida. |
cell
|
Os dados a serem gravados. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
AddNamedRangeRequest
Adiciona um intervalo nomeado à planilha.
| Representação JSON |
|---|
{
"namedRange": {
object ( |
| Campos | |
|---|---|
namedRange
|
O intervalo nomeado a ser adicionado. O campo
|
DeleteNamedRangeRequest
Remove o intervalo nomeado com o ID especificado da planilha.
| Representação JSON |
|---|
{ "namedRangeId": string } |
| Campos | |
|---|---|
namedRangeId
|
O ID do intervalo nomeado a ser excluído. |
AddSheetRequest
Adiciona uma nova página. Quando uma planilha é adicionada em um determinado índice, todos os índices das planilhas subsequentes são incrementados. Para adicionar uma planilha de objetos, use
AddChartRequest
e especifique
EmbeddedObjectPosition.sheetId
ou
EmbeddedObjectPosition.newSheet.
| Representação JSON |
|---|
{
"properties": {
object ( |
| Campos | |
|---|---|
properties
|
As propriedades que a nova planilha deve ter. Todas as propriedades são opcionais. O campo
|
DeleteSheetRequest
Exclui a planilha solicitada.
| Representação JSON |
|---|
{ "sheetId": integer } |
| Campos | |
|---|---|
sheetId
|
O ID da planilha a ser excluída.
Se a planilha for do tipo
|
AutoFillRequest
Preenche mais dados com base nos dados atuais.
| Representação JSON |
|---|
{ "useAlternateSeries": boolean, // Union field |
| Campos | |
|---|---|
useAlternateSeries
|
Verdadeiro se precisarmos gerar dados com a série "alternate". Isso varia de acordo com o tipo e a quantidade de dados de origem. |
Campo de união
area. A área a ser preenchida automaticamente.
area
pode ser apenas um dos seguintes:
|
|
range
|
O intervalo a ser preenchido automaticamente. Isso vai examinar o intervalo, detectar o local com dados e preencher automaticamente o restante do intervalo. |
sourceAndDestination
|
As áreas de origem e destino para preenchimento automático. Isso lista explicitamente a origem do preenchimento automático e onde estender esses dados. |
SourceAndDestination
Uma combinação de um intervalo de origem e como estender essa origem.
| Representação JSON |
|---|
{ "source": { object ( |
| Campos | |
|---|---|
source
|
O local dos dados a serem usados como origem do preenchimento automático. |
dimension
|
A dimensão em que os dados devem ser preenchidos. |
fillLength
|
O número de linhas ou colunas em que os dados devem ser preenchidos. Números positivos se expandem além da última linha ou coluna da origem. Números negativos são expandidos antes da primeira linha ou coluna da origem. |
CutPasteRequest
Move os dados da origem para o destino.
| Representação JSON |
|---|
{ "source": { object ( |
| Campos | |
|---|---|
source
|
Os dados de origem a serem cortados. |
destination
|
A coordenada do canto superior esquerdo em que os dados devem ser colados. |
pasteType
|
Que tipo de dados colar. Todos os dados de origem serão cortados, independente do que for colado. |
PasteType
Que tipo de dados devem ser colados.
| Tipos enumerados | |
|---|---|
PASTE_NORMAL
|
Cole valores, fórmulas, formatos e mesclagens. |
PASTE_VALUES
|
Cole APENAS os valores, sem formatos, fórmulas ou mesclagens. |
PASTE_FORMAT
|
Cole apenas a formatação e a validação de dados. |
PASTE_NO_BORDERS
|
Como
PASTE_NORMAL
mas sem bordas.
|
PASTE_FORMULA
|
Cole apenas as fórmulas. |
PASTE_DATA_VALIDATION
|
Cole apenas a validação de dados. |
PASTE_CONDITIONAL_FORMATTING
|
Cole apenas as regras de formatação condicional. |
CopyPasteRequest
Copia dados da origem para o destino.
| Representação JSON |
|---|
{ "source": { object ( |
| Campos | |
|---|---|
source
|
O intervalo de origem a ser copiado. |
destination
|
O local em que você quer colar. Se o intervalo cobrir um período que seja um múltiplo da altura ou largura da origem, os dados serão repetidos para preencher o intervalo de destino. Se o intervalo for menor que o de origem, todos os dados de origem ainda serão copiados (além do final do intervalo de destino). |
pasteType
|
Que tipo de dados colar. |
pasteOrientation
|
Como esses dados devem ser orientados ao colar. |
PasteOrientation
Como uma operação de colar deve ser realizada.
| Tipos enumerados | |
|---|---|
NORMAL
|
Cole normalmente. |
TRANSPOSE
|
Cole transposta, em que todas as linhas se tornam colunas e vice-versa. |
MergeCellsRequest
Mescla todas as células no intervalo.
| Representação JSON |
|---|
{ "range": { object ( |
| Campos | |
|---|---|
range
|
O intervalo de células a serem mescladas. |
mergeType
|
Como as células devem ser mescladas. |
MergeType
O tipo de mesclagem a ser criada.
| Tipos enumerados | |
|---|---|
MERGE_ALL
|
Criar uma única junção do intervalo |
MERGE_COLUMNS
|
Crie uma junção para cada coluna no intervalo |
MERGE_ROWS
|
Crie uma mesclagem para cada linha no intervalo |
UnmergeCellsRequest
Desfaz a mesclagem de células no intervalo especificado.
| Representação JSON |
|---|
{
"range": {
object ( |
| Campos | |
|---|---|
range
|
O intervalo em que todas as células devem ser separadas. Se o intervalo abranger várias junções, todas serão desfeitas. O intervalo não pode abranger parcialmente nenhuma mesclagem. |
UpdateBordersRequest
Atualiza as bordas de um intervalo. Se um campo não for definido na solicitação, a borda vai permanecer como está. Por exemplo, com duas UpdateBordersRequest subsequentes:
-
intervalo: A1:A5
{ top: RED, bottom: WHITE } -
intervalo: A1:A5
{ left: BLUE }
Isso faria com que A1:A5 tivesse bordas de { top: RED, bottom: WHITE, left: BLUE }. Se você quiser limpar uma borda, defina explicitamente o estilo como
NONE.
| Representação JSON |
|---|
{ "range": { object ( |
| Campos | |
|---|---|
range
|
O intervalo cujas bordas precisam ser atualizadas. |
top
|
A borda a ser colocada na parte de cima do intervalo. |
bottom
|
A borda a ser colocada na parte de baixo do intervalo. |
left
|
A borda a ser colocada à esquerda do intervalo. |
right
|
A borda a ser colocada à direita do intervalo. |
innerHorizontal
|
A borda horizontal a ser colocada no intervalo. |
innerVertical
|
A borda vertical a ser colocada no intervalo. |
UpdateCellsRequest
Atualiza todas as células em um intervalo com novos dados.
| Representação JSON |
|---|
{ "rows": [ { object ( |
| Campos | |
|---|---|
rows[]
|
Os dados a serem gravados. |
fields
|
Os campos de CellData que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz é CellData. "row.values." não deve ser especificado. Um único
|
Campo de união
area. Os dados de localização precisam ser gravados. É necessário definir exatamente um valor.
area
pode ser apenas um dos seguintes:
|
|
start
|
A coordenada para começar a gravar dados. É possível gravar qualquer número de linhas e colunas, incluindo um número diferente de colunas por linha. |
range
|
O intervalo em que os dados serão gravados.
Se os dados nas linhas não abrangerem todo o intervalo solicitado, os campos correspondentes aos definidos em
|
AddFilterViewRequest
Adiciona uma visualização com filtro.
| Representação JSON |
|---|
{
"filter": {
object ( |
| Campos | |
|---|---|
filter
|
O filtro a ser adicionado. O campo
|
AppendCellsRequest
Adiciona novas células depois da última linha com dados em uma planilha, inserindo novas linhas na planilha, se necessário.
| Representação JSON |
|---|
{ "sheetId": integer, "rows": [ { object ( |
| Campos | |
|---|---|
sheetId
|
O ID da planilha em que os dados serão anexados. |
rows[]
|
Os dados a serem anexados. |
fields
|
Os campos de CellData que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz é CellData. "row.values." não deve ser especificado. Um único
|
Campo de união
area. Os dados de localização precisam ser gravados.
area
pode ser apenas um dos seguintes:
|
|
tableId
|
O ID da tabela a que os dados serão anexados. Os dados serão anexados apenas ao corpo da tabela.
Esse campo também tem precedência sobre o campo |
ClearBasicFilterRequest
Limpa o filtro básico, se houver um na planilha.
| Representação JSON |
|---|
{ "sheetId": integer } |
| Campos | |
|---|---|
sheetId
|
O ID da planilha em que o filtro básico deve ser limpo. |
DeleteDimensionRequest
Exclui as dimensões da planilha.
| Representação JSON |
|---|
{
"range": {
object ( |
| Campos | |
|---|---|
range
|
As dimensões a serem excluídas da planilha. |
DeleteEmbeddedObjectRequest
Exclui o objeto incorporado com o ID especificado.
| Representação JSON |
|---|
{ "objectId": integer } |
| Campos | |
|---|---|
objectId
|
O ID do objeto incorporado a ser excluído. |
DeleteFilterViewRequest
Exclui uma visualização com filtro específica.
| Representação JSON |
|---|
{ "filterId": integer } |
| Campos | |
|---|---|
filterId
|
O ID do filtro a ser excluído. |
DuplicateFilterViewRequest
Duplica uma visualização de filtro específica.
| Representação JSON |
|---|
{ "filterId": integer } |
| Campos | |
|---|---|
filterId
|
O ID do filtro que está sendo duplicado. |
DuplicateSheetRequest
Duplica o conteúdo de uma página.
| Representação JSON |
|---|
{ "sourceSheetId": integer, "insertSheetIndex": integer, "newSheetId": integer, "newSheetName": string } |
| Campos | |
|---|---|
sourceSheetId
|
A página a ser duplicada.
Se a planilha de origem for do tipo |
insertSheetIndex
|
O índice com base em zero em que a nova página será inserida. O índice de todas as planilhas depois disso é incrementado. |
newSheetId
|
Se definido, o ID da nova planilha. Se não for definido, um ID será escolhido. Se definido, o ID não pode entrar em conflito com nenhum ID de página existente. Se definido, não pode ser negativo. |
newSheetName
|
O nome da nova página. Se estiver vazio, um novo nome será escolhido para você. |
FindReplaceRequest
Encontra e substitui dados em células em um intervalo, uma planilha ou todas as planilhas.
| Representação JSON |
|---|
{ "find": string, "replacement": string, "matchCase": boolean, "matchEntireCell": boolean, "searchByRegex": boolean, "includeFormulas": boolean, // Union field |
| Campos | |
|---|---|
find
|
O valor a ser pesquisado. |
replacement
|
O valor a ser usado como substituição. |
matchCase
|
Verdadeiro se a pesquisa diferencia maiúsculas de minúsculas. |
matchEntireCell
|
Verdadeiro se o valor de pesquisa corresponder a toda a célula. |
searchByRegex
|
Verdadeiro se o valor de busca for uma regex. A expressão regular e a substituição precisam seguir as regras de regex do Java em
https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. A string de substituição pode se referir a grupos de captura. Por exemplo, se uma célula tiver o conteúdo
|
includeFormulas
|
Verdadeiro se a pesquisa incluir células com fórmulas. "False" para ignorar células com fórmulas. |
Campo de união
scope. O escopo em que encontrar/substituir. Apenas um precisa ser definido.
scope
pode ser apenas um dos seguintes:
|
|
range
|
O intervalo em que a ação de localizar/substituir será realizada. |
sheetId
|
A planilha em que a ação de localizar/substituir será realizada. |
allSheets
|
Verdadeiro para encontrar/substituir em todas as planilhas. |
InsertDimensionRequest
Insere linhas ou colunas em uma planilha em um determinado índice.
| Representação JSON |
|---|
{
"range": {
object ( |
| Campos | |
|---|---|
range
|
As dimensões a serem inseridas. Os índices inicial e final precisam estar delimitados. |
inheritFromBefore
|
Se as propriedades de dimensão devem ser estendidas das dimensões antes ou depois das dimensões recém-inseridas. "True" para herdar das dimensões anteriores (nesse caso, o índice inicial precisa ser maior que 0) e "false" para herdar das dimensões posteriores.
Por exemplo, se o índice de linha 0 tiver um plano de fundo vermelho e o índice de linha 1 tiver um plano de fundo verde, a inserção de duas linhas no índice 1 poderá herdar o plano de fundo verde ou vermelho. Se |
InsertRangeRequest
Insere células em um intervalo, deslocando as células atuais para a direita ou para baixo.
| Representação JSON |
|---|
{ "range": { object ( |
| Campos | |
|---|---|
range
|
O intervalo em que as novas células serão inseridas. O intervalo é restrito aos limites da planilha atual. |
shiftDimension
|
A dimensão que será movida ao inserir células. Se
|
MoveDimensionRequest
Move uma ou mais linhas ou colunas.
| Representação JSON |
|---|
{
"source": {
object ( |
| Campos | |
|---|---|
source
|
As dimensões de origem a serem movidas. |
destinationIndex
|
O índice inicial de base zero de onde mover os dados de origem, com base nas coordenadas antes da remoção dos dados de origem da grade. Os dados atuais serão movidos para baixo ou para a direita (dependendo da dimensão) para abrir espaço para as dimensões movidas. As dimensões de origem são removidas da grade, então os dados podem acabar em um índice diferente do especificado.
Por exemplo, considerando |
UpdateEmbeddedObjectPositionRequest
Atualizar a posição de um objeto incorporado (como mover ou redimensionar um gráfico ou uma imagem).
| Representação JSON |
|---|
{
"objectId": integer,
"newPosition": {
object ( |
| Campos | |
|---|---|
objectId
|
O ID do objeto a ser movido. |
newPosition
|
Uma posição explícita para mover o objeto incorporado. Se |
fields
|
Os campos de
|
PasteDataRequest
Insere dados na planilha a partir da coordenada especificada.
| Representação JSON |
|---|
{ "coordinate": { object ( |
| Campos | |
|---|---|
coordinate
|
A coordenada em que os dados devem começar a ser inseridos. |
data
|
Os dados a serem inseridos. |
type
|
Como os dados devem ser colados. |
Campo de união
kind. Como interpretar os dados. Exatamente um valor precisa ser definido.
kind
pode ser apenas um dos seguintes:
|
|
delimiter
|
O delimitador nos dados. |
html
|
Verdadeiro se os dados forem HTML. |
TextToColumnsRequest
Divide uma coluna de texto em várias colunas com base em um delimitador em cada célula.
| Representação JSON |
|---|
{ "source": { object ( |
| Campos | |
|---|---|
source
|
O intervalo de dados de origem. Ele precisa abranger exatamente uma coluna. |
delimiter
|
O delimitador a ser usado. Usado somente se delimiterType for
|
delimiterType
|
O tipo de delimitador a ser usado. |
DelimiterType
O delimitador para dividir.
| Tipos enumerados | |
|---|---|
DELIMITER_TYPE_UNSPECIFIED
|
Valor padrão. Esse valor não pode ser usado. |
COMMA
|
"," |
SEMICOLON
|
";" |
PERIOD
|
"." |
SPACE
|
" " |
CUSTOM
|
Um valor personalizado, conforme definido no delimitador. |
AUTODETECT
|
Detectar colunas automaticamente. |
UpdateFilterViewRequest
Atualiza as propriedades da visualização de filtro.
| Representação JSON |
|---|
{
"filter": {
object ( |
| Campos | |
|---|---|
filter
|
As novas propriedades da visualização com filtro. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
DeleteRangeRequest
Exclui um intervalo de células, movendo outras células para a área excluída.
| Representação JSON |
|---|
{ "range": { object ( |
| Campos | |
|---|---|
range
|
O intervalo de células a ser excluído. |
shiftDimension
|
A dimensão que vai substituir as células excluídas. Se |
AppendDimensionRequest
Adiciona linhas ou colunas ao final de uma planilha.
| Representação JSON |
|---|
{
"sheetId": integer,
"dimension": enum ( |
| Campos | |
|---|---|
sheetId
|
A planilha em que as linhas ou colunas serão anexadas. |
dimension
|
Indica se as linhas ou colunas precisam ser anexadas. |
length
|
O número de linhas ou colunas a serem anexadas. |
AddConditionalFormatRuleRequest
Adiciona uma nova regra de formatação condicional no índice especificado. Todos os índices das regras subsequentes são incrementados.
| Representação JSON |
|---|
{
"rule": {
object ( |
| Campos | |
|---|---|
rule
|
A regra a ser adicionada. |
index
|
O índice com base em zero em que a regra será inserida. |
UpdateConditionalFormatRuleRequest
Atualiza uma regra de formatação condicional no índice especificado ou move uma regra de formatação condicional para outro índice.
| Representação JSON |
|---|
{ "index": integer, "sheetId": integer, // Union field |
| Campos | |
|---|---|
index
|
O índice com base em zero da regra que precisa ser substituída ou movida. |
sheetId
|
A página da regra a ser movida. Obrigatório se
|
Campo de união
instruction. O tipo de atualização que deve ocorrer.
instruction
pode ser apenas um dos seguintes:
|
|
rule
|
A regra que vai substituir a regra no índice especificado. |
newIndex
|
O novo índice com base em zero em que a regra vai terminar. |
DeleteConditionalFormatRuleRequest
Exclui uma regra de formatação condicional no índice especificado. Todos os índices das regras subsequentes são reduzidos.
| Representação JSON |
|---|
{ "index": integer, "sheetId": integer } |
| Campos | |
|---|---|
index
|
O índice baseado em zero da regra a ser excluída. |
sheetId
|
A página de onde a regra está sendo excluída. |
SortRangeRequest
Classifica os dados em linhas com base em uma ordem de classificação por coluna.
| Representação JSON |
|---|
{ "range": { object ( |
| Campos | |
|---|---|
range
|
O intervalo a ser classificado. |
sortSpecs[]
|
A ordem de classificação por coluna. As especificações posteriores são usadas quando os valores são iguais nas especificações anteriores. |
SetDataValidationRequest
Define uma regra de validação de dados para cada célula no intervalo. Para limpar a validação em um intervalo, chame essa função sem especificar uma regra.
| Representação JSON |
|---|
{ "range": { object ( |
| Campos | |
|---|---|
range
|
O intervalo em que a regra de validação de dados deve ser aplicada. |
rule
|
A regra de validação de dados a ser definida em cada célula do intervalo ou vazia para limpar a validação de dados no intervalo. |
filteredRowsIncluded
|
Opcional. Se for "true", a regra de validação de dados também será aplicada às linhas filtradas. |
SetBasicFilterRequest
Define o filtro básico associado a uma planilha.
| Representação JSON |
|---|
{
"filter": {
object ( |
| Campos | |
|---|---|
filter
|
O filtro a ser definido. |
AddProtectedRangeRequest
Adiciona um novo intervalo protegido.
| Representação JSON |
|---|
{
"protectedRange": {
object ( |
| Campos | |
|---|---|
protectedRange
|
O intervalo protegido a ser adicionado. O campo
|
UpdateProtectedRangeRequest
Atualiza um intervalo protegido com o protectedRangeId especificado.
| Representação JSON |
|---|
{
"protectedRange": {
object ( |
| Campos | |
|---|---|
protectedRange
|
O intervalo protegido a ser atualizado com as novas propriedades. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
DeleteProtectedRangeRequest
Exclui o intervalo protegido com o ID especificado.
| Representação JSON |
|---|
{ "protectedRangeId": integer } |
| Campos | |
|---|---|
protectedRangeId
|
O ID do intervalo protegido a ser excluído. |
AutoResizeDimensionsRequest
Redimensiona automaticamente uma ou mais dimensões com base no conteúdo das células.
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união
dimension_range. O intervalo de dimensão.
dimension_range
pode ser apenas um dos seguintes:
|
|
dimensions
|
As dimensões a serem redimensionadas automaticamente. |
dataSourceSheetDimensions
|
As dimensões em uma página de fonte de dados para redimensionamento automático. |
AddChartRequest
Adiciona um gráfico a uma página na planilha.
| Representação JSON |
|---|
{
"chart": {
object ( |
| Campos | |
|---|---|
chart
|
O gráfico que será adicionado à planilha, incluindo a posição em que ele será colocado. O campo
|
UpdateChartSpecRequest
Atualiza as especificações de um gráfico. Isso não move nem redimensiona um gráfico. Para mover ou redimensionar um gráfico, use
UpdateEmbeddedObjectPositionRequest.)
| Representação JSON |
|---|
{
"chartId": integer,
"spec": {
object ( |
| Campos | |
|---|---|
chartId
|
O ID do gráfico a ser atualizado. |
spec
|
A especificação a ser aplicada ao gráfico. |
UpdateBandingRequest
Atualiza as propriedades do intervalo agrupado fornecido.
| Representação JSON |
|---|
{
"bandedRange": {
object ( |
| Campos | |
|---|---|
bandedRange
|
O intervalo agrupado a ser atualizado com as novas propriedades. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
AddBandingRequest
Adiciona um novo intervalo com bandas à planilha.
| Representação JSON |
|---|
{
"bandedRange": {
object ( |
| Campos | |
|---|---|
bandedRange
|
O intervalo com faixas a ser adicionado. O campo
|
DeleteBandingRequest
Remove o intervalo agrupado com o ID especificado da planilha.
| Representação JSON |
|---|
{ "bandedRangeId": integer } |
| Campos | |
|---|---|
bandedRangeId
|
O ID do intervalo agrupado a ser excluído. |
CreateDeveloperMetadataRequest
Uma solicitação para criar metadados do desenvolvedor.
| Representação JSON |
|---|
{
"developerMetadata": {
object ( |
| Campos | |
|---|---|
developerMetadata
|
Os metadados do desenvolvedor a serem criados. |
UpdateDeveloperMetadataRequest
Uma solicitação para atualizar propriedades de metadados de desenvolvedor. Atualiza as propriedades dos metadados do desenvolvedor selecionados pelos filtros com os valores fornecidos no recurso
DeveloperMetadata. Os chamadores precisam especificar as propriedades que querem atualizar no parâmetro "fields", além de especificar pelo menos um
DataFilter
que corresponda aos metadados que querem atualizar.
| Representação JSON |
|---|
{ "dataFilters": [ { object ( |
| Campos | |
|---|---|
dataFilters[]
|
Os filtros que correspondem às entradas de metadados do desenvolvedor a serem atualizadas. |
developerMetadata
|
O valor para o qual todos os metadados correspondentes aos filtros de dados serão atualizados. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
DeleteDeveloperMetadataRequest
Uma solicitação para excluir metadados do desenvolvedor.
| Representação JSON |
|---|
{
"dataFilter": {
object ( |
| Campos | |
|---|---|
dataFilter
|
O filtro de dados que descreve os critérios usados para selecionar qual entrada de metadados do desenvolvedor será excluída. |
RandomizeRangeRequest
Coloca em ordem aleatória as linhas em um intervalo.
| Representação JSON |
|---|
{
"range": {
object ( |
| Campos | |
|---|---|
range
|
O intervalo a ser aleatorizado. |
AddDimensionGroupRequest
Cria um grupo no intervalo especificado.
Se o intervalo solicitado for um superconjunto do intervalo de um grupo G, a profundidade de G será incrementada, e esse novo grupo G' terá a profundidade de G. Por exemplo, um grupo [C:D, profundidade 1] + [B:E] resulta em grupos [B:E, profundidade 1] e [C:D, profundidade 2]. Se o intervalo solicitado for um subconjunto do intervalo de um grupo G, a profundidade do novo grupo G' será uma unidade maior que a profundidade de G. Por exemplo, um grupo [B:E, profundidade 1] + [C:D] resulta em grupos [B:E, profundidade 1] e [C:D, profundidade 2]. Se o intervalo solicitado começar antes e terminar dentro, ou começar dentro e terminar depois, do intervalo de um grupo G existente, o intervalo do grupo G existente se torna a união dos intervalos, e o novo grupo G' tem profundidade um maior que a profundidade de G e intervalo como a interseção dos intervalos. Por exemplo, um grupo [B:D, profundidade 1] + [C:E] resulta em grupos [B:E, profundidade 1] e [C:D, profundidade 2].
| Representação JSON |
|---|
{
"range": {
object ( |
| Campos | |
|---|---|
range
|
O intervalo em que um grupo será criado. |
DeleteDimensionGroupRequest
Exclui um grupo no intervalo especificado, diminuindo a profundidade das dimensões no intervalo.
Por exemplo, suponha que a planilha tenha um grupo de profundidade 1 em B:E e um grupo de profundidade 2 em C:D. A exclusão de um grupo em D:E deixa a planilha com um grupo de profundidade 1 em B:D e um grupo de profundidade 2 em C:C.
| Representação JSON |
|---|
{
"range": {
object ( |
| Campos | |
|---|---|
range
|
O intervalo do grupo a ser excluído. |
UpdateDimensionGroupRequest
Atualiza o estado do grupo especificado.
| Representação JSON |
|---|
{
"dimensionGroup": {
object ( |
| Campos | |
|---|---|
dimensionGroup
|
O grupo cujo estado precisa ser atualizado. O intervalo e a profundidade do grupo precisam especificar um grupo válido na planilha, e todos os outros campos precisam ser atualizados. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
TrimWhitespaceRequest
Remove os espaços em branco (como espaços, tabulações ou novas linhas) de todas as células no intervalo especificado. Essa solicitação remove todos os espaços em branco do início e do fim do texto de cada célula e reduz qualquer subsequência de caracteres de espaço em branco restantes a um único espaço. Se o texto resultante começar com um caractere "+" ou "=", ele vai permanecer como um valor de string e não será interpretado como uma fórmula.
| Representação JSON |
|---|
{
"range": {
object ( |
| Campos | |
|---|---|
range
|
O intervalo de células a serem cortadas. |
DeleteDuplicatesRequest
Remove as linhas dentro desse intervalo que contêm valores nas colunas especificadas que são duplicados de valores em qualquer linha anterior. As linhas com valores idênticos, mas letras maiúsculas/minúsculas, formatação ou fórmulas diferentes, são consideradas cópias.
Essa solicitação também remove linhas duplicadas ocultas da visualização (por exemplo, devido a um filtro). Ao remover duplicados, a primeira instância de cada linha duplicada, verificada de cima para baixo, é mantida no intervalo resultante. O conteúdo fora do intervalo especificado não é removido, e as linhas consideradas duplicadas não precisam estar adjacentes umas às outras no intervalo.
| Representação JSON |
|---|
{ "range": { object ( |
| Campos | |
|---|---|
range
|
O intervalo de onde as linhas duplicadas serão removidas. |
comparisonColumns[]
|
As colunas no intervalo a serem analisadas para valores duplicados. Se nenhuma coluna for selecionada, todas serão analisadas em busca de duplicatas. |
UpdateEmbeddedObjectBorderRequest
Atualiza a propriedade de borda de um objeto incorporado.
| Representação JSON |
|---|
{
"objectId": integer,
"border": {
object ( |
| Campos | |
|---|---|
objectId
|
O ID do objeto incorporado a ser atualizado. |
border
|
A borda que se aplica ao objeto incorporado. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
AddSlicerRequest
Adiciona uma segmentação de dados a uma página da planilha.
| Representação JSON |
|---|
{
"slicer": {
object ( |
| Campos | |
|---|---|
slicer
|
A segmentação que deve ser adicionada à planilha, incluindo a posição em que ela deve ser colocada. O campo
|
UpdateSlicerSpecRequest
Atualiza as especificações de um segmentador. (Isso não move nem redimensiona uma segmentação. Para mover ou redimensionar um segmentador, use
UpdateEmbeddedObjectPositionRequest.
| Representação JSON |
|---|
{
"slicerId": integer,
"spec": {
object ( |
| Campos | |
|---|---|
slicerId
|
O ID do segmentador a ser atualizado. |
spec
|
A especificação a ser aplicada ao segmentador. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
AddDataSourceRequest
Adiciona uma fonte de dados. Depois que a fonte de dados é adicionada, uma planilha
DATA_SOURCE
associada é criada, e uma execução é acionada para atualizar a planilha e ler os dados da fonte.
A solicitação exige um escopo adicional do
bigquery.readonly
OAuth se você estiver adicionando uma fonte de dados do BigQuery.
| Representação JSON |
|---|
{
"dataSource": {
object ( |
| Campos | |
|---|---|
dataSource
|
A fonte de dados a ser adicionada. |
UpdateDataSourceRequest
Atualiza uma fonte de dados. Depois que a fonte de dados é atualizada, uma execução é acionada para atualizar a planilha DATA_SOURCE associada e ler os dados da fonte atualizada.
A solicitação exige um escopo do OAuth bigquery.readonly adicional se você estiver atualizando uma fonte de dados do BigQuery.
| Representação JSON |
|---|
{
"dataSource": {
object ( |
| Campos | |
|---|---|
dataSource
|
A fonte de dados a ser atualizada. |
fields
|
Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
DeleteDataSourceRequest
Exclui uma fonte de dados. A solicitação também exclui a planilha da fonte de dados associada e desvincula todos os objetos de fonte de dados associados.
| Representação JSON |
|---|
{ "dataSourceId": string } |
| Campos | |
|---|---|
dataSourceId
|
O ID da fonte de dados a ser excluída. |
RefreshDataSourceRequest
Atualiza um ou vários objetos de fonte de dados na planilha pelas referências especificadas.
A solicitação exige um escopo do OAuth bigquery.readonly adicional se você estiver atualizando uma fonte de dados do BigQuery.
Se houver várias solicitações de atualização referenciando os mesmos objetos de fonte de dados em um lote, apenas a última solicitação será processada, e todas elas terão a mesma resposta.
| Representação JSON |
|---|
{ "force": boolean, // Union field |
| Campos | |
|---|---|
force
|
Atualiza os objetos da fonte de dados, independente do estado atual. Se não estiver definido e um objeto de fonte de dados referenciado estiver em estado de erro, a atualização vai falhar imediatamente. |
Campo de união
target. Especifica o que atualizar.
target
pode ser apenas um dos seguintes:
|
|
references
|
Referências aos objetos da fonte de dados a serem atualizados. |
dataSourceId
|
Referência a um
|
isAll
|
Atualiza todos os objetos da fonte de dados na planilha. |
DataSourceObjectReferences
Uma lista de referências a objetos de fonte de dados.
| Representação JSON |
|---|
{
"references": [
{
object ( |
| Campos | |
|---|---|
references[]
|
As referências. |
DataSourceObjectReference
Referência a um objeto de fonte de dados.
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união
value. O tipo de referência.
value
pode ser apenas um dos seguintes:
|
|
sheetId
|
Referências a uma
página
|
chartId
|
Referências a um gráfico de fonte de dados. |
dataSourceTableAnchorCell
|
Referências a um
|
dataSourcePivotTableAnchorCell
|
Referências a uma fonte de dados
|
dataSourceFormulaCell
|
Referências a uma célula que contém
|
CancelDataSourceRefreshRequest
Cancela uma ou várias atualizações de objetos de fonte de dados na planilha pelas referências especificadas.
A solicitação exige um escopo do OAuth bigquery.readonly adicional se você estiver cancelando uma atualização em uma fonte de dados do BigQuery.
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união
target. Especifica o que cancelar.
target
pode ser apenas um dos seguintes:
|
|
references
|
Referências a objetos de fonte de dados cujas atualizações serão canceladas. |
dataSourceId
|
Referência a um
|
isAll
|
Cancela todas as atualizações de objetos de fontes de dados na planilha. |
AddTableRequest
Adiciona uma nova tabela à planilha.
| Representação JSON |
|---|
{
"table": {
object ( |
| Campos | |
|---|---|
table
|
Obrigatório. A tabela a ser adicionada. |
UpdateTableRequest
Atualiza uma tabela na planilha.
| Representação JSON |
|---|
{
"table": {
object ( |
| Campos | |
|---|---|
table
|
Obrigatório. A tabela a ser atualizada. |
fields
|
Obrigatório. Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz |
DeleteTableRequest
Remove a tabela com o ID especificado da planilha.
| Representação JSON |
|---|
{ "tableId": string } |
| Campos | |
|---|---|
tableId
|
O ID da tabela a ser excluída. |