Requests

Solicitação

Um único tipo de atualização a ser aplicada a uma planilha.

Representação JSON
{

  // Union field kind can be only one of the following:
  "updateSpreadsheetProperties": {
    object (UpdateSpreadsheetPropertiesRequest)
  },
  "updateSheetProperties": {
    object (UpdateSheetPropertiesRequest)
  },
  "updateDimensionProperties": {
    object (UpdateDimensionPropertiesRequest)
  },
  "updateNamedRange": {
    object (UpdateNamedRangeRequest)
  },
  "repeatCell": {
    object (RepeatCellRequest)
  },
  "addNamedRange": {
    object (AddNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "addSheet": {
    object (AddSheetRequest)
  },
  "deleteSheet": {
    object (DeleteSheetRequest)
  },
  "autoFill": {
    object (AutoFillRequest)
  },
  "cutPaste": {
    object (CutPasteRequest)
  },
  "copyPaste": {
    object (CopyPasteRequest)
  },
  "mergeCells": {
    object (MergeCellsRequest)
  },
  "unmergeCells": {
    object (UnmergeCellsRequest)
  },
  "updateBorders": {
    object (UpdateBordersRequest)
  },
  "updateCells": {
    object (UpdateCellsRequest)
  },
  "addFilterView": {
    object (AddFilterViewRequest)
  },
  "appendCells": {
    object (AppendCellsRequest)
  },
  "clearBasicFilter": {
    object (ClearBasicFilterRequest)
  },
  "deleteDimension": {
    object (DeleteDimensionRequest)
  },
  "deleteEmbeddedObject": {
    object (DeleteEmbeddedObjectRequest)
  },
  "deleteFilterView": {
    object (DeleteFilterViewRequest)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewRequest)
  },
  "duplicateSheet": {
    object (DuplicateSheetRequest)
  },
  "findReplace": {
    object (FindReplaceRequest)
  },
  "insertDimension": {
    object (InsertDimensionRequest)
  },
  "insertRange": {
    object (InsertRangeRequest)
  },
  "moveDimension": {
    object (MoveDimensionRequest)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionRequest)
  },
  "pasteData": {
    object (PasteDataRequest)
  },
  "textToColumns": {
    object (TextToColumnsRequest)
  },
  "updateFilterView": {
    object (UpdateFilterViewRequest)
  },
  "deleteRange": {
    object (DeleteRangeRequest)
  },
  "appendDimension": {
    object (AppendDimensionRequest)
  },
  "addConditionalFormatRule": {
    object (AddConditionalFormatRuleRequest)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleRequest)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleRequest)
  },
  "sortRange": {
    object (SortRangeRequest)
  },
  "setDataValidation": {
    object (SetDataValidationRequest)
  },
  "setBasicFilter": {
    object (SetBasicFilterRequest)
  },
  "addProtectedRange": {
    object (AddProtectedRangeRequest)
  },
  "updateProtectedRange": {
    object (UpdateProtectedRangeRequest)
  },
  "deleteProtectedRange": {
    object (DeleteProtectedRangeRequest)
  },
  "autoResizeDimensions": {
    object (AutoResizeDimensionsRequest)
  },
  "addChart": {
    object (AddChartRequest)
  },
  "updateChartSpec": {
    object (UpdateChartSpecRequest)
  },
  "updateBanding": {
    object (UpdateBandingRequest)
  },
  "addBanding": {
    object (AddBandingRequest)
  },
  "deleteBanding": {
    object (DeleteBandingRequest)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataRequest)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataRequest)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataRequest)
  },
  "randomizeRange": {
    object (RandomizeRangeRequest)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupRequest)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupRequest)
  },
  "updateDimensionGroup": {
    object (UpdateDimensionGroupRequest)
  },
  "trimWhitespace": {
    object (TrimWhitespaceRequest)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesRequest)
  },
  "updateEmbeddedObjectBorder": {
    object (UpdateEmbeddedObjectBorderRequest)
  },
  "addSlicer": {
    object (AddSlicerRequest)
  },
  "updateSlicerSpec": {
    object (UpdateSlicerSpecRequest)
  },
  "addDataSource": {
    object (AddDataSourceRequest)
  },
  "updateDataSource": {
    object (UpdateDataSourceRequest)
  },
  "deleteDataSource": {
    object (DeleteDataSourceRequest)
  },
  "refreshDataSource": {
    object (RefreshDataSourceRequest)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de união kind. O tipo de atualização. Exatamente um campo é obrigatório. kind pode ser apenas uma das seguintes opções:
updateSpreadsheetProperties

object (UpdateSpreadsheetPropertiesRequest)

Atualiza as propriedades da planilha.

updateSheetProperties

object (UpdateSheetPropertiesRequest)

Atualiza as propriedades de uma página.

updateDimensionProperties

object (UpdateDimensionPropertiesRequest)

Atualiza as propriedades das dimensões.

updateNamedRange

object (UpdateNamedRangeRequest)

Atualiza um intervalo nomeado.

repeatCell

object (RepeatCellRequest)

Repete uma única célula em um intervalo.

addNamedRange

object (AddNamedRangeRequest)

Adiciona um intervalo nomeado.

deleteNamedRange

object (DeleteNamedRangeRequest)

Exclui um intervalo nomeado.

addSheet

object (AddSheetRequest)

Adiciona uma página.

deleteSheet

object (DeleteSheetRequest)

Exclui uma página.

autoFill

object (AutoFillRequest)

Preenche automaticamente mais dados com base em dados existentes.

cutPaste

object (CutPasteRequest)

Recorta dados de uma área e os cola em outra.

copyPaste

object (CopyPasteRequest)

Copia os dados de uma área e os cola em outra.

mergeCells

object (MergeCellsRequest)

Mescla as células.

unmergeCells

object (UnmergeCellsRequest)

Desfazer mesclagem de células mescladas.

updateBorders

object (UpdateBordersRequest)

Atualiza as bordas em um intervalo de células.

updateCells

object (UpdateCellsRequest)

Atualiza muitas células de uma vez.

addFilterView

object (AddFilterViewRequest)

Adiciona uma visualização com filtro.

appendCells

object (AppendCellsRequest)

Anexa células após a última linha com dados em uma página.

clearBasicFilter

object (ClearBasicFilterRequest)

Limpa o filtro básico em uma página.

deleteDimension

object (DeleteDimensionRequest)

Exclui linhas ou colunas de uma página.

deleteEmbeddedObject

object (DeleteEmbeddedObjectRequest)

Exclui um objeto incorporado (por exemplo, gráfico, imagem) de uma página.

deleteFilterView

object (DeleteFilterViewRequest)

Exclui uma visualização com filtro de uma página.

duplicateFilterView

object (DuplicateFilterViewRequest)

Duplica uma visualização com filtro.

duplicateSheet

object (DuplicateSheetRequest)

Duplica uma página.

findReplace

object (FindReplaceRequest)

Encontra e substitui ocorrências de algum texto por outro texto.

insertDimension

object (InsertDimensionRequest)

Insere novas linhas ou colunas em uma página.

insertRange

object (InsertRangeRequest)

Insere novas células em uma página, deslocando as células existentes.

moveDimension

object (MoveDimensionRequest)

Move linhas ou colunas para outro local em uma página.

updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionRequest)

Atualiza a posição de um objeto incorporado (por exemplo, gráfico, imagem).

pasteData

object (PasteDataRequest)

Cola dados (HTML ou delimitados) em uma página.

textToColumns

object (TextToColumnsRequest)

Converte uma coluna de texto em muitas colunas de texto.

updateFilterView

object (UpdateFilterViewRequest)

Atualiza as propriedades de uma visualização com filtro.

deleteRange

object (DeleteRangeRequest)

Exclui um intervalo de células da página, deslocando as células restantes.

appendDimension

object (AppendDimensionRequest)

Anexa dimensões ao final de uma página.

addConditionalFormatRule

object (AddConditionalFormatRuleRequest)

Adiciona uma nova regra de formatação condicional.

updateConditionalFormatRule

object (UpdateConditionalFormatRuleRequest)

Atualiza uma regra de formato condicional existente.

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleRequest)

Exclui uma regra de formato condicional existente.

sortRange

object (SortRangeRequest)

Classifica dados em um intervalo.

setDataValidation

object (SetDataValidationRequest)

Define a validação de dados para uma ou mais células.

setBasicFilter

object (SetBasicFilterRequest)

Define o filtro básico em uma página.

addProtectedRange

object (AddProtectedRangeRequest)

Adiciona um intervalo protegido.

updateProtectedRange

object (UpdateProtectedRangeRequest)

Atualiza um intervalo protegido.

deleteProtectedRange

object (DeleteProtectedRangeRequest)

Exclui um intervalo protegido.

autoResizeDimensions

object (AutoResizeDimensionsRequest)

Redimensiona automaticamente uma ou mais dimensões com base no conteúdo das células dessa dimensão.

addChart

object (AddChartRequest)

Adiciona um gráfico.

updateChartSpec

object (UpdateChartSpecRequest)

Atualiza as especificações de um gráfico.

updateBanding

object (UpdateBandingRequest)

Atualiza um intervalo em faixas

addBanding

object (AddBandingRequest)

Adiciona um novo intervalo com faixas

deleteBanding

object (DeleteBandingRequest)

Remove um intervalo em faixas

createDeveloperMetadata

object (CreateDeveloperMetadataRequest)

Cria novos metadados do desenvolvedor

updateDeveloperMetadata

object (UpdateDeveloperMetadataRequest)

Atualiza uma entrada de metadados do desenvolvedor existente

deleteDeveloperMetadata

object (DeleteDeveloperMetadataRequest)

Exclui metadados do desenvolvedor

randomizeRange

object (RandomizeRangeRequest)

Ordem aleatória das linhas das linhas de um intervalo.

addDimensionGroup

object (AddDimensionGroupRequest)

Cria um grupo no intervalo especificado.

deleteDimensionGroup

object (DeleteDimensionGroupRequest)

Exclui um grupo sobre o intervalo especificado.

updateDimensionGroup

object (UpdateDimensionGroupRequest)

Atualiza o estado do grupo especificado.

trimWhitespace

object (TrimWhitespaceRequest)

Corta células de espaço em branco (como espaços, tabulações ou novas linhas).

deleteDuplicates

object (DeleteDuplicatesRequest)

Remove linhas contendo valores duplicados em colunas especificadas de um intervalo de células.

updateEmbeddedObjectBorder

object (UpdateEmbeddedObjectBorderRequest)

Atualiza a borda de um objeto incorporado.

addSlicer

object (AddSlicerRequest)

Adiciona um controle de filtros.

updateSlicerSpec

object (UpdateSlicerSpecRequest)

Atualiza as especificações de um controle de filtros.

addDataSource

object (AddDataSourceRequest)

Adiciona uma fonte de dados.

updateDataSource

object (UpdateDataSourceRequest)

Atualiza uma fonte de dados.

deleteDataSource

object (DeleteDataSourceRequest)

Exclui uma fonte de dados.

refreshDataSource

object (RefreshDataSourceRequest)

Atualiza uma ou várias fontes de dados e dbobjects associados.

UpdateSpreadsheetPropertiesRequest

Atualiza propriedades de uma planilha.

Representação JSON
{
  "properties": {
    object (SpreadsheetProperties)
  },
  "fields": string
}
Campos
properties

object (SpreadsheetProperties)

As propriedades a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz de 'properties' está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

UpdateSheetPropertiesRequest

Atualiza propriedades da página com o sheetId especificado.

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

object (SheetProperties)

As propriedades a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz properties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

UpdateDimensionPropertiesRequest

Atualiza propriedades de dimensões dentro do intervalo especificado.

Representação JSON
{
  "properties": {
    object (DimensionProperties)
  },
  "fields": string,

  // Union field dimension_range can be only one of the following:
  "range": {
    object (DimensionRange)
  },
  "dataSourceSheetRange": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
Campos
properties

object (DimensionProperties)

Propriedades a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz properties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Campo de união dimension_range. O intervalo de dimensões. dimension_range pode ser apenas uma das seguintes opções:
range

object (DimensionRange)

As linhas ou colunas a serem atualizadas.

dataSourceSheetRange

object (DataSourceSheetDimensionRange)

As colunas em uma página da fonte de dados que serão atualizadas.

DataSourceSheetDimensionRange

Um intervalo ao longo de uma única dimensão em uma página DATA_SOURCE.

Representação JSON
{
  "sheetId": integer,
  "columnReferences": [
    {
      object (DataSourceColumnReference)
    }
  ]
}
Campos
sheetId

integer

O ID da página da fonte de dados na qual o intervalo está inserido.

columnReferences[]

object (DataSourceColumnReference)

As colunas na página da fonte de dados.

UpdateNamedRangeRequest

Atualiza propriedades do intervalo nomeado com o namedRangeId especificado.

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

object (NamedRange)

O intervalo nomeado a ser atualizado com as novas propriedades.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz namedRange está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

RepetirCellRequest

Atualiza todas as células do intervalo para os valores no objeto de celular especificado. Somente os campos listados no campo fields são atualizados. Os outros não são alterados.

Se você estiver escrevendo uma célula com uma fórmula, os intervalos da fórmula serão incrementados automaticamente para cada campo do intervalo. Por exemplo, se escrever uma célula com a fórmula =A1 no intervalo B2:C4, B2 seria =A1, B3 seria =A2, B4 seria =A3, C2 seria =B1, C3 seria =B2, C4 seria =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 (GridRange)
  },
  "cell": {
    object (CellData)
  },
  "fields": string
}
Campos
range

object (GridRange)

O intervalo no qual a célula será repetida.

cell

object (CellData)

Os dados a serem gravados.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz cell está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

AddNamedRangeRequest

Adiciona um intervalo nomeado à planilha.

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

object (NamedRange)

O intervalo nomeado a ser adicionado. O campo namedRangeId é opcional. Se nenhum campo for definido, um código será gerado aleatoriamente. É um erro especificar o ID de um intervalo que já existe.

DeleteNamedRangeRequest

Remove o intervalo nomeado com o ID fornecido da planilha.

Representação JSON
{
  "namedRangeId": string
}
Campos
namedRangeId

string

O ID do intervalo nomeado a ser excluído.

AddSheetRequest

Adiciona uma nova página. Quando uma página é adicionada a um determinado índice, todos os índices das páginas subsequentes são incrementados. Para adicionar uma página de objeto, use AddChartRequest e especifique EmbeddedObjectPosition.sheetId ou EmbeddedObjectPosition.newSheet.

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

object (SheetProperties)

As propriedades da nova página. Todas as propriedades são opcionais. O campo sheetId é opcional. Se nenhum campo for definido, um código será gerado aleatoriamente. É um erro especificar o ID de uma página que já existe.

DeleteSheetRequest

Exclui a página solicitada.

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

integer

O ID da página a ser excluída.

Se a página for do tipo DATA_SOURCE, o DataSource associado também será excluído.

Solicitação de Preenchimento automático

Preenche mais dados com base nos dados existentes.

Representação JSON
{
  "useAlternateSeries": boolean,

  // Union field area can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sourceAndDestination": {
    object (SourceAndDestination)
  }
  // End of list of possible types for union field area.
}
Campos
useAlternateSeries

boolean

Verdadeiro se for necessário 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 uma das seguintes opções:
range

object (GridRange)

O intervalo a ser preenchido automaticamente. O intervalo será examinado, o local dos dados será detectado e os dados serão preenchidos automaticamente no restante do intervalo.

sourceAndDestination

object (SourceAndDestination)

As áreas de origem e destino para preenchimento automático. Isso lista explicitamente a origem do preenchimento automático e onde eles podem ser estendidos.

Destino e destino de origem

Uma combinação de um intervalo de origem e como estender essa origem.

Representação JSON
{
  "source": {
    object (GridRange)
  },
  "dimension": enum (Dimension),
  "fillLength": integer
}
Campos
source

object (GridRange)

O local dos dados a serem usados como a origem do preenchimento automático.

dimension

enum (Dimension)

A dimensão na qual os dados devem ser preenchidos.

fillLength

integer

O número de linhas ou colunas em que os dados devem ser preenchidos. Os números positivos se expandem além da última linha ou última coluna da origem. Os números negativos se expandem antes da primeira linha ou primeira coluna da origem.

ColarColarsolicitação

Move os dados da origem para o destino.

Representação JSON
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridCoordinate)
  },
  "pasteType": enum (PasteType)
}
Campos
source

object (GridRange)

Os dados de origem a serem recortados.

destination

object (GridCoordinate)

A coordenada superior esquerda onde os dados devem ser colados.

pasteType

enum (PasteType)

Quais tipos de dados colar. Todos os dados de origem serão cortados, independentemente do que for colado.

ColarTipo

Quais tipos de dados devem ser colados.

Enums
PASTE_NORMAL Cole valores, fórmulas, formatos e mesclagens.
PASTE_VALUES Cole os valores SOMENTE sem formatos, fórmulas ou mesclagens.
PASTE_FORMAT Cole somente o formato e a validação dos dados.
PASTE_NO_BORDERS Como PASTE_NORMAL, mas sem bordas.
PASTE_FORMULA Cole somente as fórmulas.
PASTE_DATA_VALIDATION Cole somente a validação de dados.
PASTE_CONDITIONAL_FORMATTING Cole somente as regras de formatação condicional.

ColarColarCópia

Copia os dados da origem para o destino.

Representação JSON
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridRange)
  },
  "pasteType": enum (PasteType),
  "pasteOrientation": enum (PasteOrientation)
}
Campos
source

object (GridRange)

O intervalo de origem a ser copiado.

destination

object (GridRange)

O local onde colar. Se o intervalo abrange um período que é múltiplo da altura ou da largura da fonte, os dados são repetidos para preencher o intervalo de destino. Se o intervalo for menor que o intervalo de origem, todos os dados de origem ainda serão copiados (além do final do intervalo de destino).

pasteType

enum (PasteType)

Quais tipos de dados colar.

pasteOrientation

enum (PasteOrientation)

Como esses dados devem ser orientados ao colar.

Colar Orientação

Como uma operação de colagem deve ser realizada.

Enums
NORMAL Colar normalmente.
TRANSPOSE Colar transpostos, em que todas as linhas se tornam colunas e vice-versa.

Solicitação de mesclagem de células

Mescla todas as células do intervalo.

Representação JSON
{
  "range": {
    object (GridRange)
  },
  "mergeType": enum (MergeType)
}
Campos
range

object (GridRange)

O intervalo de células a ser mesclado.

mergeType

enum (MergeType)

Como as células devem ser mescladas.

Tipo de mesclagem

O tipo de mesclagem a ser criado.

Enums
MERGE_ALL Criar uma única mesclagem a partir do intervalo
MERGE_COLUMNS Criar uma mesclagem para cada coluna no intervalo
MERGE_ROWS Criar uma mesclagem para cada linha no intervalo

UnmergeCellsRequest

Cancela a mesclagem de células no intervalo fornecido.

Representação JSON
{
  "range": {
    object (GridRange)
  }
}
Campos
range

object (GridRange)

O intervalo no qual todas as células devem ser separadas. Se o intervalo abranger várias mesclagens, todas não serão mescladas. 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, isso significa que a borda permanece como está. Por exemplo, com dois UpdateBordersRequest subsequentes:

  1. intervalo: A1:A5 { top: RED, bottom: WHITE }
  2. intervalo: A1:A5 { left: BLUE }

Isso faria com que A1:A5 tivesse as bordas de { top: RED, bottom: WHITE, left: BLUE }. Se você quiser limpar uma borda, defina o estilo explicitamente como NONE.

Representação JSON
{
  "range": {
    object (GridRange)
  },
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  },
  "innerHorizontal": {
    object (Border)
  },
  "innerVertical": {
    object (Border)
  }
}
Campos
range

object (GridRange)

O intervalo cujas bordas devem ser atualizadas.

top

object (Border)

A borda a ser colocada na parte superior do intervalo.

bottom

object (Border)

A borda a ser colocada na parte inferior do intervalo.

left

object (Border)

A borda a ser colocada à esquerda do intervalo.

right

object (Border)

A borda a ser colocada à direita do intervalo.

innerHorizontal

object (Border)

A borda horizontal a ser colocada dentro do intervalo.

innerVertical

object (Border)

A borda vertical a ser colocada no intervalo.

Solicitação de atualização de celular

Atualiza todas as células em um intervalo com novos dados.

Representação JSON
{
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string,

  // Union field area can be only one of the following:
  "start": {
    object (GridCoordinate)
  },
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field area.
}
Campos
rows[]

object (RowData)

Os dados a serem gravados.

fields

string (FieldMask format)

Os campos de CellData que devem ser atualizados. Pelo menos um campo precisa ser especificado. A raiz é o CellData. "row.values." não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Campo de união area. Os dados de local devem ser gravados. É preciso definir exatamente um valor. area pode ser apenas uma das seguintes opções:
start

object (GridCoordinate)

A coordenada na qual os dados serão gravados. Qualquer número de linhas e colunas (incluindo um número diferente de colunas por linha) pode ser escrito.

range

object (GridRange)

O intervalo no qual os dados serão gravados.

Se os dados nas linhas não abrangerem todo o intervalo solicitado, os campos correspondentes a eles definidos em fields serão apagados.

AddFilterViewRequest

Adiciona uma visualização com filtro.

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

object (FilterView)

O filtro a ser adicionado. O campo filterViewId é opcional. Se nenhum campo for definido, um código será gerado aleatoriamente. É um erro especificar o ID de um filtro que já existe.

Solicitação de anexação

Adiciona novas células após a última linha com dados em uma página, inserindo novas linhas na página, se necessário.

Representação JSON
{
  "sheetId": integer,
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string
}
Campos
sheetId

integer

O ID da página em que os dados serão anexados.

rows[]

object (RowData)

Os dados que serão anexados.

fields

string (FieldMask format)

Os campos de CellData que devem ser atualizados. Pelo menos um campo precisa ser especificado. A raiz é o CellData. "row.values." não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Solicitação de filtro básico

Limpa o filtro básico, se houver algum na página.

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

integer

O ID da página em que o filtro básico deve ser limpo.

Solicitação de exclusão de dimensão

Exclui as dimensões da página.

Representação JSON
{
  "range": {
    object (DimensionRange)
  }
}
Campos
range

object (DimensionRange)

As dimensões a serem excluídas da página.

DeleteEmbeddedObjectRequest

Exclui o objeto incorporado com o ID fornecido.

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

integer

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

integer

O ID do filtro a ser excluído.

Solicitação de filtro de duplicação

Duplica uma visualização de filtro específica.

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

integer

O ID do filtro que está sendo duplicado.

Solicitação de página duplicada

Duplica o conteúdo de uma página.

Representação JSON
{
  "sourceSheetId": integer,
  "insertSheetIndex": integer,
  "newSheetId": integer,
  "newSheetName": string
}
Campos
sourceSheetId

integer

A página a ser duplicada.

Se a página de origem for do tipo DATA_SOURCE, o DataSource de apoio também será duplicado e associado à nova cópia da página. Nenhuma execução de dados é acionada. Os dados em grade desta página também são copiados, mas ficam disponíveis somente após a conclusão da solicitação em lote.

insertSheetIndex

integer

O índice de base zero em que a nova página deve ser inserida. O índice de todas as páginas depois disso é incrementado.

newSheetId

integer

Se definido, o ID da nova página. Se não for definido, um ID será escolhido. Se definido, o ID não pode entrar em conflito com nenhum código de página existente. Se definido, não pode ser negativo.

newSheetName

string

O nome da nova página. Se estiver vazio, um novo nome será escolhido para você.

Localizar substituição de solicitação

Encontra e substitui dados nas células de um intervalo, de uma página ou de todas as páginas.

Representação JSON
{
  "find": string,
  "replacement": string,
  "matchCase": boolean,
  "matchEntireCell": boolean,
  "searchByRegex": boolean,
  "includeFormulas": boolean,

  // Union field scope can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sheetId": integer,
  "allSheets": boolean
  // End of list of possible types for union field scope.
}
Campos
find

string

O valor a ser pesquisado.

replacement

string

O valor a ser usado como substituição.

matchCase

boolean

Verdadeiro se a pesquisa diferenciar maiúsculas de minúsculas.

matchEntireCell

boolean

Verdadeiro se o valor de localização tiver que corresponder à célula inteira.

searchByRegex

boolean

Verdadeiro se o valor de localização for uma regex. A expressão regular e a substituição precisam seguir as regras de regex 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 "Google Sheets" e outra tiver "Google Docs", pesquisar "o.* (.*)" com uma substituição de "$1 Rocks" alteraria o conteúdo das células para "GSheets Rocks" e "GDocs Rocks", respectivamente.

includeFormulas

boolean

Verdadeiro se a pesquisa precisar incluir células com fórmulas. Falso para pular células com fórmulas.

Campo de união scope. O escopo sobre o qual encontrar/substituir; um e apenas um deve ser definido. scope pode ser apenas uma das seguintes opções:
range

object (GridRange)

O intervalo sobre o qual encontrar/substituir.

sheetId

integer

A página para localizar/substituir.

allSheets

boolean

Verdadeiro para localizar/substituir em todas as páginas.

InserirDimensionRequest

Insere linhas ou colunas em uma página em um índice específico.

Representação JSON
{
  "range": {
    object (DimensionRange)
  },
  "inheritFromBefore": boolean
}
Campos
range

object (DimensionRange)

As dimensões a serem inseridas. Os índices de início e término precisam ser limitados.

inheritFromBefore

boolean

Se as propriedades de dimensão devem ser estendidas das dimensões antes ou depois das dimensões recém-inseridas. Verdadeiro para herdar das dimensões antes. Nesse caso, o índice inicial precisa ser maior que 0, e falso para herdar das dimensões depois.

Por exemplo, se o índice da linha 0 tiver um fundo vermelho e o índice da linha 1 tiver um fundo verde, a inserção de duas linhas no índice 1 poderá herdar o fundo verde ou vermelho. Se inheritFromBefore for verdadeiro, as duas linhas novas serão vermelhas (porque a linha antes do ponto de inserção era vermelha), enquanto se inheritFromBefore for falsa, as duas linhas novas serão verdes (porque a linha após o ponto de inserção era verde).

Solicitação de inserção de intervalo

Insere células em um intervalo, movendo as células existentes para cima ou para baixo.

Representação JSON
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
Campos
range

object (GridRange)

O intervalo no qual as novas células serão inseridas.

shiftDimension

enum (Dimension)

A dimensão que será alterada ao inserir células. Se ROWS, as células existentes serão deslocadas para baixo. Se COLUMNS, as células existentes serão deslocadas para a direita.

MoverDimensionRequest

Move uma ou mais linhas ou colunas.

Representação JSON
{
  "source": {
    object (DimensionRange)
  },
  "destinationIndex": integer
}
Campos
source

object (DimensionRange)

As dimensões de origem a serem movidas.

destinationIndex

integer

O índice inicial baseado em zero de onde mover os dados de origem, com base nas coordenadas antes de os dados de origem serem removidos da grade. Os dados existentes serão deslocados para baixo ou para a direita (dependendo da dimensão) para dar espaço às dimensões movidas. As dimensões de origem são removidas da grade, de modo que os dados podem acabar em um índice diferente do especificado.

Por exemplo, considerando A1..A5 de 0, 1, 2, 3, 4 e quer mover "1" e "2" entre "3" e "4", a origem seria ROWS [1..3),e o índice de destino seria "4" (o índice baseado em zero da linha 5). O resultado final seria A1..A5 de 0, 3, 1, 2, 4.

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 (EmbeddedObjectPosition)
  },
  "fields": string
}
Campos
objectId

integer

O ID do objeto a ser movido.

newPosition

object (EmbeddedObjectPosition)

Uma posição explícita para mover o objeto incorporado. Se newPosition.sheetId estiver definido, uma nova página com esse ID será criada. Se newPosition.newSheet for definido como verdadeiro, uma nova página será criada com um ID que será escolhido para você.

fields

string (FieldMask format)

Os campos de OverlayPosition que precisam ser atualizados ao definir uma nova posição. Usado somente se newPosition.overlayPosition estiver definido. Nesse caso, pelo menos um campo precisa ser especificado. A raiz newPosition.overlayPosition está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

ColarDadosdaSolicitação

Insere dados na planilha começando pela coordenada especificada.

Representação JSON
{
  "coordinate": {
    object (GridCoordinate)
  },
  "data": string,
  "type": enum (PasteType),

  // Union field kind can be only one of the following:
  "delimiter": string,
  "html": boolean
  // End of list of possible types for union field kind.
}
Campos
coordinate

object (GridCoordinate)

A coordenada na qual os dados devem começar a ser inseridos.

data

string

Os dados a serem inseridos.

type

enum (PasteType)

Como os dados devem ser colados.

Campo de união kind. Como interpretar os dados. É necessário definir exatamente um valor. kind pode ser apenas uma das seguintes opções:
delimiter

string

O delimitador nos dados.

html

boolean

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 (GridRange)
  },
  "delimiter": string,
  "delimiterType": enum (DelimiterType)
}
Campos
source

object (GridRange)

O intervalo de dados de origem. Isso deve abranger exatamente uma coluna.

delimiter

string

O delimitador a ser usado. Usado somente se delimiterType for CUSTOM.

delimiterType

enum (DelimiterType)

O tipo delimitador a ser usado.

Tipo de delimitador

O delimitador para dividir.

Enums
DELIMITER_TYPE_UNSPECIFIED Valor padrão. Este valor não pode ser usado.
COMMA ",
SEMICOLON ";"
PERIOD ".
SPACE "
CUSTOM Um valor personalizado, conforme definido no delimitador.
AUTODETECT Detectar colunas automaticamente.

AtualizarFilterViewRequest

Atualiza propriedades da visualização com filtro.

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

object (FilterView)

As novas propriedades da visualização com filtro.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz filter está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

DeleteRangeRequest

Exclui um intervalo de células, deslocando outras células para a área excluída.

Representação JSON
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
Campos
range

object (GridRange)

O intervalo de células a ser excluído.

shiftDimension

enum (Dimension)

A dimensão a partir da qual as células excluídas serão substituídas. Se ROWS, as células existentes serão movidas para cima para substituir as células excluídas. Se COLUMNS, as células existentes serão deslocadas para a esquerda para substituir as células excluídas.

Solicitação de anexação

Anexa linhas ou colunas ao final de uma página.

Representação JSON
{
  "sheetId": integer,
  "dimension": enum (Dimension),
  "length": integer
}
Campos
sheetId

integer

A página à qual anexar linhas ou colunas.

dimension

enum (Dimension)

Se linhas ou colunas devem ser anexadas.

length

integer

O número de linhas ou colunas a anexar.

AddConditionFormatRuleRequest

Adiciona uma nova regra de formatação condicional no índice especificado. Todos os índices das regras subsequentes serão incrementados.

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

object (ConditionalFormatRule)

A regra a ser adicionada.

index

integer

O índice de base zero em que a regra deve ser inserida.

UpdateConditionFormatRuleRequest

Atualiza uma regra de formato condicional no índice especificado ou move uma regra de formato condicional para outro índice.

Representação JSON
{
  "index": integer,
  "sheetId": integer,

  // Union field instruction can be only one of the following:
  "rule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer
  // End of list of possible types for union field instruction.
}
Campos
index

integer

O índice da regra que deve ser substituído ou movido com base em zero.

sheetId

integer

A página da regra a ser movida. Obrigatório se newIndex estiver definido. Caso contrário, não será usado.

Campo de união instruction. O tipo de atualização que deve acontecer. instruction pode ser apenas uma das seguintes opções:
rule

object (ConditionalFormatRule)

A regra que deve substituir a regra no índice especificado.

newIndex

integer

O novo índice com base em zero a que a regra deve chegar.

DeleteConditionFormatRuleRequest

Exclui uma regra de formatação condicional no índice especificado. Todos os índices das regras subsequentes serão reduzidos.

Representação JSON
{
  "index": integer,
  "sheetId": integer
}
Campos
index

integer

O índice da regra a ser excluída.

sheetId

integer

A página da qual a regra está sendo excluída.

Solicitação de classificação do intervalo

Classifica dados em linhas com base em uma ordem de classificação por coluna.

Representação JSON
{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ]
}
Campos
range

object (GridRange)

O intervalo a ser classificado.

sortSpecs[]

object (SortSpec)

A ordem de classificação por coluna. As especificações posteriores são usadas quando os valores são iguais nas especificações anteriores.

Definição de DataDataValidation

Define uma regra de validação de dados para cada célula no intervalo. Para limpar a validação em um intervalo, chame-o sem regra especificada.

Representação JSON
{
  "range": {
    object (GridRange)
  },
  "rule": {
    object (DataValidationRule)
  }
}
Campos
range

object (GridRange)

O intervalo ao qual a regra de validação de dados deve ser aplicada.

rule

object (DataValidationRule)

A regra de validação de dados a ser definida em cada célula no intervalo ou vazia para limpar a validação de dados no intervalo.

SetBasicFilterRequest

Define o filtro básico associado a uma página.

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

object (BasicFilter)

O filtro a ser definido.

AddProtectedRangeRequest

Adiciona um novo intervalo protegido.

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

object (ProtectedRange)

O intervalo protegido a ser adicionado. O campo protectedRangeId é opcional. Se nenhum campo for definido, um código será gerado aleatoriamente. É um erro especificar o ID de um intervalo que já existe.

UpdateProtectedRangeRequest

Atualiza um intervalo protegido existente com o protectedRangeId especificado.

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

object (ProtectedRange)

O intervalo protegido a ser atualizado com as novas propriedades.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz protectedRange está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

DeleteProtectedRangeRequest

Exclui o intervalo protegido com o código fornecido.

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

integer

O ID do intervalo protegido a ser excluído.

Redimensionarsolicitação automaticamente

Redimensiona automaticamente uma ou mais dimensões com base no conteúdo das células dessa dimensão.

Representação JSON
{

  // Union field dimension_range can be only one of the following:
  "dimensions": {
    object (DimensionRange)
  },
  "dataSourceSheetDimensions": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
Campos
Campo de união dimension_range. O intervalo de dimensões. dimension_range pode ser apenas uma das seguintes opções:
dimensions

object (DimensionRange)

As dimensões a serem redimensionadas automaticamente.

dataSourceSheetDimensions

object (DataSourceSheetDimensionRange)

As dimensões em uma página de fonte de dados para redimensionar automaticamente.

Solicitação de adição de gráficos

Adiciona um gráfico a uma página na planilha.

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

object (EmbeddedChart)

O gráfico que deve ser adicionado à planilha, incluindo a posição onde ele deve ser colocado. O campo chartId é opcional. Se nenhum campo for definido, um código será gerado aleatoriamente. É um erro especificar o ID de um objeto incorporado que já existe.

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 (ChartSpec)
  }
}
Campos
chartId

integer

O ID do gráfico a ser atualizado.

spec

object (ChartSpec)

A especificação a ser aplicada ao gráfico.

Solicitação de atualização

Atualiza propriedades do intervalo de banda fornecido.

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

object (BandedRange)

O intervalo com faixas a ser atualizado com as novas propriedades.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz bandedRange está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Solicitação de adição de proibição

Adiciona um novo intervalo de faixas à planilha.

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

object (BandedRange)

O intervalo com faixas a adicionar. O campo bandedRangeId é opcional. Se nenhum campo for definido, um código será gerado aleatoriamente. É um erro especificar o ID de um intervalo que já existe.

ExcluirBandingRequest

Remove o intervalo da faixa com o ID fornecido da planilha.

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

integer

O ID do intervalo em faixa a ser excluído.

CreateDeveloperMetadataRequest

Uma solicitação para criar metadados de desenvolvedor.

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

object (DeveloperMetadata)

Os metadados do desenvolvedor a serem criados.

UpdateDeveloperMetadataRequest

Uma solicitação para atualizar as propriedades dos metadados do desenvolvedor. Atualiza as propriedades dos metadados do desenvolvedor selecionados pelos filtros para os valores fornecidos no recurso DeveloperMetadata. Os autores da chamada precisam especificar as propriedades que querem atualizar no parâmetro fields e pelo menos um DataFilter correspondente aos metadados que pretendem atualizar.

Representação JSON
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "fields": string
}
Campos
dataFilters[]

object (DataFilter)

Os filtros que correspondem às entradas de metadados do desenvolvedor a serem atualizados.

developerMetadata

object (DeveloperMetadata)

O valor para o qual todos os metadados correspondentes aos filtros de dados serão atualizados.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz developerMetadata está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

DeleteDeveloperMetadataRequest

Uma solicitação para excluir metadados do desenvolvedor.

Representação JSON
{
  "dataFilter": {
    object (DataFilter)
  }
}
Campos
dataFilter

object (DataFilter)

O filtro de dados que descreve os critérios usados para selecionar qual entrada de metadados do desenvolvedor deve ser excluída.

RandomizeRangeRequest.

Ordem aleatória das linhas das linhas de um intervalo.

Representação JSON
{
  "range": {
    object (GridRange)
  }
}
Campos
range

object (GridRange)

O intervalo a ser aleatório.

AddDimensionGroupRequest

Cria um grupo no intervalo especificado.

Se o intervalo solicitado for um superconjunto do intervalo de um grupo G existente, a profundidade de G será incrementada e o novo grupo G terá a profundidade desse grupo. Por exemplo, um grupo [C:D, profundidade 1] + [B:E] resulta nos grupos [B:E, profundidade 1] e [C:D, profundidade 2]. Se o intervalo solicitado for um subconjunto do intervalo de um grupo G existente, a profundidade do novo grupo G se tornará maior do 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 em, ou começar dentro e terminar depois, o intervalo de um grupo G existente, o intervalo do grupo G existente se tornará a união dos intervalos e o novo grupo G terá uma profundidade maior que a profundidade de G e o intervalo como intersecçã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 (DimensionRange)
  }
}
Campos
range

object (DimensionRange)

O intervalo sobre o qual criar um grupo.

DeleteDimensionGroupRequest

Exclui um grupo sobre o intervalo especificado, diminuindo a profundidade das dimensões no intervalo.

Por exemplo, suponha que a página tenha um grupo de profundidade 1 sobre B:E e um grupo de profundidade 2 sobre C:D. Excluir um grupo por meio de D:E deixa a planilha com um grupo de profundidade 1 sobre B:D e um grupo de profundidade 2 sobre C:C.

Representação JSON
{
  "range": {
    object (DimensionRange)
  }
}
Campos
range

object (DimensionRange)

O intervalo do grupo a ser excluído.

UpdateDimensionGroupRequest

Atualiza o estado do grupo especificado.

Representação JSON
{
  "dimensionGroup": {
    object (DimensionGroup)
  },
  "fields": string
}
Campos
dimensionGroup

object (DimensionGroup)

O grupo cujo estado deve ser atualizado. O intervalo e a profundidade do grupo devem especificar um grupo válido na página e todos os outros campos atualizados.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz dimensionGroup está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

TrimWhitespaceRequest

Corta espaços em branco (como espaços, tabulações ou novas linhas) em todas as células do 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 cortado resultante começar com um caractere '+' ou '=', o texto permanecerá como um valor de string e não será interpretado como uma fórmula.

Representação JSON
{
  "range": {
    object (GridRange)
  }
}
Campos
range

object (GridRange)

O intervalo cujas células serão cortadas.

DeleteDuplicatesRequest

Remove as linhas dentro desse intervalo que contêm valores nas colunas especificadas que são duplicatas de valores em qualquer linha anterior. As linhas com valores idênticos, mas com uso diferente de maiúsculas e minúsculas, formatação ou fórmulas, são consideradas duplicatas.

Essa solicitação também remove linhas duplicadas ocultas (por exemplo, devido a um filtro). Ao remover duplicatas, a primeira instância de cada verificação de linha duplicada 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 ser adjacentes no intervalo.

Representação JSON
{
  "range": {
    object (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}
Campos
range

object (GridRange)

O intervalo do qual as linhas duplicadas serão removidas.

comparisonColumns[]

object (DimensionRange)

As colunas do intervalo a serem analisadas quanto a valores duplicados. Se nenhuma coluna for selecionada, todas as colunas serão analisadas em busca de cópias.

UpdateEmbeddedObjectBorderRequest

Atualiza a propriedade de borda de um objeto incorporado.

Representação JSON
{
  "objectId": integer,
  "border": {
    object (EmbeddedObjectBorder)
  },
  "fields": string
}
Campos
objectId

integer

O ID do objeto incorporado a ser atualizado.

border

object (EmbeddedObjectBorder)

A borda que se aplica ao objeto incorporado.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz border está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

AddSlicerRequest

Adiciona um controle de filtros a uma página da planilha.

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

object (Slicer)

O controle de filtros que deve ser adicionado à planilha, incluindo a posição em que ele deve ser colocado. O campo slicerId é opcional. Se nenhum campo for definido, um código será gerado aleatoriamente. É um erro especificar o ID de um controle de filtros que já existe.

UpdateSlicerSpecRequest

Atualiza as especificações de um controle de filtros. Isso não move nem redimensiona um controle de filtros. Para mover ou redimensionar um controle de filtros, use UpdateEmbeddedObjectPositionRequest.

Representação JSON
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "fields": string
}
Campos
slicerId

integer

O código do controle de filtros a ser atualizado.

spec

object (SlicerSpec)

A especificação a ser aplicada ao controle de filtros.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz SlicerSpec está implícita e não deve ser especificada. Um único "*" pode ser usado como um atalho para listar todos os campos.

AddDataSourceRequest

Adiciona uma fonte de dados. Depois que a fonte de dados é adicionada, uma página DATA_SOURCE associada é criada e uma execução é acionada para atualizar a página para ler os dados da fonte de dados. A solicitação requer um escopo adicional do OAuth bigquery.readonly.

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

object (DataSource)

A fonte de dados a ser adicionada.

AtualizaçãoRequestRequest

Atualiza uma fonte de dados. Depois que a fonte de dados é atualizada, uma execução é acionada para atualizar a página DATA_SOURCE associada para ler dados da fonte atualizada. A solicitação requer um escopo adicional do OAuth bigquery.readonly.

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

object (DataSource)

A fonte de dados a ser atualizada.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. Pelo menos um campo precisa ser especificado. A raiz dataSource está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

DeleteDataSourceRequest

Exclui uma fonte de dados. A solicitação também exclui a página de fonte de dados associada e desvincula todos os objetos dela.

Representação JSON
{
  "dataSourceId": string
}
Campos
dataSourceId

string

O ID da fonte de dados a ser excluída.

RefreshDataSourceRequest

Atualiza um ou vários objetos da fonte de dados na planilha pelas referências especificadas. A solicitação requer um escopo adicional do OAuth bigquery.readonly.

Se houver várias solicitações de atualização referenciando os mesmos objetos de fonte de dados em um lote, apenas a última será processada, e todas elas terão a mesma resposta.

Representação JSON
{
  "force": boolean,

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}
Campos
force

boolean

Atualiza os objetos da fonte de dados, independentemente do estado atual. Se não for definido e um objeto de fonte de dados referenciado estiver no estado de erro, a atualização falhará imediatamente.

Campo de união target. Especifica o que atualizar. target pode ser apenas uma das seguintes opções:
references

object (DataSourceObjectReferences)

Referências a objetos da fonte de dados para atualizar.

dataSourceId

string

Referência a um DataSource. Se especificado, atualiza todos os objetos da fonte de dados associada.

isAll

boolean

Atualiza todos os objetos da fonte de dados existentes na planilha.

DataSourceObjectReferences

Uma lista de referências a objetos da fonte de dados.

Representação JSON
{
  "references": [
    {
      object (DataSourceObjectReference)
    }
  ]
}
Campos
references[]

object (DataSourceObjectReference)

As referências.

Referência de objeto do DataSource

Referência a um objeto da fonte 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 uma das seguintes opções:
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 ancorada na célula.

dataSourceFormulaCell

object (GridCoordinate)

Referências a uma célula contendo DataSourceFormula.