Requests

Solicitação

Um único tipo de atualização a ser aplicado 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)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshRequest)
  }
  // End of list of possible types for union field kind.
}
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

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 nos dados atuais.

cutPaste

object (CutPasteRequest)

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

copyPaste

object (CopyPasteRequest)

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

mergeCells

object (MergeCellsRequest)

Mescla células.

unmergeCells

object (UnmergeCellsRequest)

Desfaz a mesclagem de células.

updateBorders

object (UpdateBordersRequest)

Atualiza as bordas em um intervalo de células.

updateCells

object (UpdateCellsRequest)

Atualiza muitas células de uma só vez.

addFilterView

object (AddFilterViewRequest)

Adiciona uma visualização com filtro.

appendCells

object (AppendCellsRequest)

Anexar células após a última linha com dados em uma planilha.

clearBasicFilter

object (ClearBasicFilterRequest)

Limpa o filtro básico de uma planilha.

deleteDimension

object (DeleteDimensionRequest)

Exclui linhas ou colunas de uma planilha.

deleteEmbeddedObject

object (DeleteEmbeddedObjectRequest)

Exclui um objeto incorporado (por exemplo, gráfico, imagem) em uma planilha.

deleteFilterView

object (DeleteFilterViewRequest)

Exclui uma visualização com filtro de uma planilha.

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.

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

updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionRequest)

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

pasteData

object (PasteDataRequest)

Colapsa os dados (HTML ou delimitados) em uma planilha.

textToColumns

object (TextToColumnsRequest)

Converte uma coluna de texto em várias colunas de texto.

updateFilterView

object (UpdateFilterViewRequest)

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

deleteRange

object (DeleteRangeRequest)

Exclui um intervalo de células de uma planilha, 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 formatação condicional.

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleRequest)

Exclui uma regra de formatação condicional.

sortRange

object (SortRangeRequest)

Classifica os 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 planilha.

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.

addChart

object (AddChartRequest)

Adiciona um gráfico.

updateChartSpec

object (UpdateChartSpecRequest)

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

updateBanding

object (UpdateBandingRequest)

Atualiza um intervalo com faixas

addBanding

object (AddBandingRequest)

Adiciona um novo intervalo com faixas

deleteBanding

object (DeleteBandingRequest)

Remove um intervalo com faixas

createDeveloperMetadata

object (CreateDeveloperMetadataRequest)

Cria novos metadados para desenvolvedores

updateDeveloperMetadata

object (UpdateDeveloperMetadataRequest)

Atualiza uma entrada de metadados do desenvolvedor

deleteDeveloperMetadata

object (DeleteDeveloperMetadataRequest)

Exclui metadados do desenvolvedor

randomizeRange

object (RandomizeRangeRequest)

Ordena aleatoriamente as linhas em um intervalo.

addDimensionGroup

object (AddDimensionGroupRequest)

Cria um grupo no intervalo especificado.

deleteDimensionGroup

object (DeleteDimensionGroupRequest)

Exclui um grupo no 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 com 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 fatiador.

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 objetos db associados.

cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

Cancela as atualizações de uma ou várias fontes de dados e objetos de banco de dados associados.

UpdateSpreadsheetPropertiesRequest

Atualiza as 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. É necessário especificar pelo menos um campo. A raiz "properties" é implícita e não precisa ser especificada. Um único "*" pode ser usado como atalho para listar todos os campos.

UpdateSheetPropertiesRequest

Atualiza as propriedades da planilha 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. É necessário especificar pelo menos um campo. O properties raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

UpdateDimensionPropertiesRequest

Atualiza as propriedades das dimensões no 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. É necessário especificar pelo menos um campo. O properties raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

Campo de união dimension_range. O intervalo da dimensão. dimension_range pode ser apenas um dos seguintes:
range

object (DimensionRange)

As linhas ou colunas a serem atualizadas.

dataSourceSheetRange

object (DataSourceSheetDimensionRange)

As colunas em uma planilha de fonte de dados a ser atualizada.

DataSourceSheetDimensionRange

Um intervalo em 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 em que o intervalo está.

columnReferences[]

object (DataSourceColumnReference)

As colunas na planilha da fonte de dados.

UpdateNamedRangeRequest

Atualiza as 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. É necessário especificar pelo menos um campo. O namedRange raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

RepeatCellRequest

Atualiza todas as células no intervalo para os valores no objeto Cell fornecido. Somente os campos listados em fields são atualizados. Os outros permanecem inalterados.

Se você escrever uma célula com uma fórmula, os intervalos da fórmula vão aumentar automaticamente para cada campo no intervalo. Por exemplo, se você gravar 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 impedir 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 em que a célula será repetida.

cell

object (CellData)

Os dados a serem gravados.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. O cell raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para 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 não for definido, um ID será gerado aleatoriamente. Especificar o ID de um intervalo que já existe é um erro.

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 planilha é adicionada a um determinado índice, todos os índices das planilhas subsequentes são incrementados. Para adicionar uma folha de objeto, use AddChartRequest e especifique EmbeddedObjectPosition.sheetId ou EmbeddedObjectPosition.newSheet.

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

object (SheetProperties)

As propriedades que a nova planilha precisa ter. Todas as propriedades são opcionais. O campo sheetId é opcional. Se não for definido, um ID será gerado aleatoriamente. Especificar o ID de uma planilha que já existe é um erro.

DeleteSheetRequest

Exclui a planilha solicitada.

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

integer

O ID da planilha a ser excluída.

Se a planilha for do tipo DATA_SOURCE, a DataSource associada também será excluída.

AutoFillRequest

Preenche mais dados com base nos dados atuais.

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 "alternativa". 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

object (GridRange)

O intervalo a ser preenchido automaticamente. Isso vai examinar o intervalo e detectar o local que tem dados e preencher automaticamente esses dados 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 estender esses dados.

SourceAndDestination

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 origem do preenchimento automático.

dimension

enum (Dimension)

A dimensão em que os dados vão ser preenchidos.

fillLength

integer

O número de linhas ou colunas em que os dados precisam ser preenchidos. Os números positivos se estendem além da última linha ou coluna da origem. Os números negativos são expandidos antes da primeira linha ou coluna da origem.

CutPasteRequest

Move 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 cortados.

destination

object (GridCoordinate)

A coordenada no canto superior esquerdo em que os dados precisam ser colados.

pasteType

enum (PasteType)

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

PasteType

Que tipo de dados devem ser colados.

Enums
PASTE_NORMAL Cole valores, fórmulas, formatos e mesclagens.
PASTE_VALUES Colar 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 (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 para colar. Se o intervalo abranger um intervalo que seja um múltiplo da altura ou da largura da origem, os dados serão repetidos para preencher o intervalo de destino. Se o intervalo for menor que o da origem, todos os dados da origem ainda serão copiados (além do fim do intervalo de destino).

pasteType

enum (PasteType)

Que tipo de dados colar.

pasteOrientation

enum (PasteOrientation)

Como esses dados devem ser orientados ao serem colados.

PasteOrientation

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

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

MergeCellsRequest

Mescla todas as células no 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.

MergeType

O tipo de mesclagem a ser criado.

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

UnmergeCellsRequest

Desfaz a mesclagem de células no intervalo especificado.

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

object (GridRange)

O intervalo em que todas as células precisam ser separadas. Se o intervalo abranger várias mesclagens, 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:

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

Isso resultaria em A1:A5 com 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 (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 de bordas que precisa ser atualizado.

top

object (Border)

A borda que será colocada na parte de cima do intervalo.

bottom

object (Border)

A borda a ser colocada na parte de baixo do intervalo.

left

object (Border)

A borda que será colocada à esquerda do intervalo.

right

object (Border)

A borda que será colocada à direita do intervalo.

innerHorizontal

object (Border)

A borda horizontal a ser colocada no intervalo.

innerVertical

object (Border)

A borda vertical a ser colocada dentro do intervalo.

UpdateCellsRequest

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 precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz é a CellData.Não é necessário especificar "row.values". Um único "*" pode ser usado como atalho para listar todos os campos.

Campo de união area. Os dados de local precisam ser gravados. É necessário definir exatamente um valor. area pode ser apenas um dos seguintes:
start

object (GridCoordinate)

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

object (GridRange)

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 fields serão limpos.

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 não for definido, um ID será gerado aleatoriamente. É um erro especificar o ID de um filtro que já existe.

AppendCellsRequest

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

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

integer

O ID da planilha em que os dados serão anexados.

rows[]

object (RowData)

Os dados a serem anexados.

fields

string (FieldMask format)

Os campos de CellData que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz é a CellData.Não é necessário especificar "row.values". Um único "*" pode ser usado como atalho para listar todos os campos.

ClearBasicFilterRequest

Limpa o filtro básico, se houver um na planilha.

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

integer

O ID da planilha em que o filtro básico precisa ser limpo.

DeleteDimensionRequest

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

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.

DuplicateFilterViewRequest

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

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

integer

O ID do filtro duplicado.

DuplicateSheetRequest

Duplica o conteúdo de uma planilha.

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

integer

A página a ser duplicada.

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

insertSheetIndex

integer

O índice baseado em zero em que a nova página precisa ser inserida. O índice de todas as planilhas depois disso é incrementado.

newSheetId

integer

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, precisa ser não negativo.

newSheetName

string

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

FindReplaceRequest

Encontra e substitui dados em células de 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 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 substituto.

matchCase

boolean

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

matchEntireCell

boolean

Verdadeiro se o valor de pesquisa precisa corresponder à célula inteira.

searchByRegex

boolean

Verdadeiro se o valor de pesquisa for um 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 "Google Sheets" e outra tiver "Google Docs", a pesquisa de "o.* (.*)" com uma substituição de "$1 Rocks" mudaria o conteúdo das células para "GSheets Rocks" e "GDocs Rocks", respectivamente.

includeFormulas

boolean

Verdadeiro se a pesquisa precisa incluir células com fórmulas. False para ignorar células com fórmulas.

Campo de união scope. O escopo em que a substituição/procura será feita. É necessário definir apenas um. scope pode ser apenas um dos seguintes:
range

object (GridRange)

O intervalo em que a pesquisa/substituição será feita.

sheetId

integer

A planilha em que você quer fazer a substituição.

allSheets

boolean

Verdadeiro para encontrar/substituir em todas as planilhas.

InsertDimensionRequest

Insere linhas ou colunas em uma planilha 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 inicial e final precisam ser delimitados.

inheritFromBefore

boolean

Se as propriedades da dimensão precisam ser estendidas das dimensões anteriores ou posteriores às dimensões recém-inseridas. Verdadeiro para herdar das dimensões anteriores (nesse caso, o índice de início precisa ser maior que 0) e falso para herdar das dimensões posteriores.

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

InsertRangeRequest

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

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

object (GridRange)

O intervalo em que novas células serão inseridas. O intervalo é limitado aos limites da planilha atual.

shiftDimension

enum (Dimension)

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

MoveDimensionRequest

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 de início baseado em zero para onde mover os dados de origem, com base nas coordenadas antes que os dados de origem forem removidos da grade. Os dados atuais serão deslocados 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, dado A1..A5 de 0, 1, 2, 3, 4 e querendo 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 planilha com esse ID será criada. Se newPosition.newSheet estiver definido como verdadeiro, uma nova planilha será criada com um ID escolhido para você.

fields

string (FieldMask format)

Os campos de OverlayPosition que precisam ser atualizados ao definir uma nova posição. Usado apenas se newPosition.overlayPosition estiver definido. Nesse caso, pelo menos um campo precisa ser especificado. O newPosition.overlayPosition raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

PasteDataRequest

Insere dados na planilha a partir da 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 em que os dados vão 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, exatamente um valor precisa ser definido. kind pode ser apenas um dos seguintes:
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. Ele precisa abranger exatamente uma coluna.

delimiter

string

O delimitador a ser usado. Usado apenas se o delimiterType for CUSTOM.

delimiterType

enum (DelimiterType)

O tipo de delimitador a ser usado.

DelimiterType

O delimitador a ser usado.

Enums
DELIMITER_TYPE_UNSPECIFIED Valor padrão. Esse valor não deve 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 (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. É necessário especificar pelo menos um campo. O filter raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para 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 que será usada para substituir as células excluídas. Se ROWS, as células atuais serão deslocadas para cima para substituir as células excluídas. Se COLUMNS, as células atuais serão deslocadas para a esquerda para substituir as células excluídas.

AppendDimensionRequest

Anexar linhas ou colunas ao final de uma planilha.

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

integer

A planilha em que você quer adicionar linhas ou colunas.

dimension

enum (Dimension)

Indica se linhas ou colunas precisam ser anexadas.

length

integer

O número de linhas ou colunas a serem anexadas.

AddConditionalFormatRuleRequest

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

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

object (ConditionalFormatRule)

A regra a ser adicionada.

index

integer

O índice baseado em zero em que a regra precisa ser inserida.

UpdateConditionalFormatRuleRequest

Atualiza uma regra de formatação condicional no índice fornecido ou move uma regra de formatação 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 com base em zero da regra que precisa ser substituída ou movida.

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 precisa acontecer. instruction pode ser apenas um dos seguintes:
rule

object (ConditionalFormatRule)

A regra que vai substituir a regra no índice fornecido.

newIndex

integer

O novo índice com base em zero em que a regra vai terminar.

DeleteConditionalFormatRuleRequest

Exclui uma regra de formatação condicional no índice fornecido. Os índices de todas as regras subsequentes são decrementados.

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

integer

O índice baseado em zero da regra a ser excluída.

sheetId

integer

A planilha em que 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 (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.

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 uma regra especificada.

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

object (GridRange)

O intervalo em que a regra de validação de dados será aplicada.

rule

object (DataValidationRule)

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

boolean

Opcional. Se for verdadeiro, 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 (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 não for definido, um ID será gerado aleatoriamente. É um erro especificar o ID de um intervalo que já existe.

UpdateProtectedRangeRequest

Atualiza um intervalo protegido 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. É necessário especificar pelo menos um campo. O protectedRange raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

DeleteProtectedRangeRequest

Exclui o intervalo protegido com o ID fornecido.

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

integer

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 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 da dimensão. dimension_range pode ser apenas um dos seguintes:
dimensions

object (DimensionRange)

As dimensões que serão redimensionadas automaticamente.

dataSourceSheetDimensions

object (DataSourceSheetDimensionRange)

As dimensões em uma planilha de origem de dados para redimensionar automaticamente.

AddChartRequest

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

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

object (EmbeddedChart)

O gráfico que será adicionado à planilha, incluindo a posição em que ele será colocado. O campo chartId é opcional. Se não for definido, um ID será gerado aleatoriamente. Especificar o ID de um objeto incorporado que já existe é um erro.

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.

UpdateBandingRequest

Atualiza as propriedades do intervalo agrupado fornecido.

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

object (BandedRange)

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

fields

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. O bandedRange raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

AddBandingRequest

Adiciona um novo intervalo de faixas à planilha.

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

object (BandedRange)

O intervalo de faixas a ser adicionado. O campo bandedRangeId é opcional. Se não for definido, um ID será gerado aleatoriamente. É um erro especificar o ID de um intervalo que já existe.

DeleteBandingRequest

Remove o intervalo com o ID especificado da planilha.

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

integer

O ID do intervalo com faixas a ser excluído.

CreateDeveloperMetadataRequest

Uma solicitação para criar metadados do desenvolvedor.

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

object (DeveloperMetadata)

Os metadados do desenvolvedor a serem criados.

UpdateDeveloperMetadataRequest

Uma solicitação para atualizar propriedades dos metadados do desenvolvedor. Atualiza as propriedades dos metadados do desenvolvedor selecionados pelos filtros para os valores fornecidos no recurso DeveloperMetadata. Os autores de chamadas precisam especificar as propriedades que querem atualizar no parâmetro de campos e pelo menos um DataFilter que corresponda aos metadados que querem 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 atualizadas.

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. É necessário especificar pelo menos um campo. O developerMetadata raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para 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 será excluída.

RandomizeRangeRequest

Ordena aleatoriamente as linhas em um intervalo.

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

object (GridRange)

O intervalo a ser tornado 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 esse novo grupo G' terá a profundidade desse grupo. 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á maior que a 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, o intervalo do grupo G vai se tornar a união dos intervalos, e o novo grupo G' terá uma profundidade maior que a de G e um intervalo igual à 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 (DimensionRange)
  }
}
Campos
range

object (DimensionRange)

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 sobre B:E e um grupo de profundidade 2 sobre 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 (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 precisa ser atualizado. O intervalo e a profundidade do grupo precisam especificar um grupo válido na planilha e todos os outros campos atualizados.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. O dimensionGroup raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

TrimWhitespaceRequest

Corta os espaços em branco (como espaços, tabulações ou novas linhas) em cada célula 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 subseqência de caracteres de espaço em branco restante a um único espaço. Se o texto cortado resultante começar com um caractere "+" ou "=', o texto vai 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 de células a ser cortado.

DeleteDuplicatesRequest

Remove linhas nesse 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 de maiúsculas e minúsculas, formatação ou fórmulas diferentes, são consideradas duplicadas.

Essa solicitação também remove linhas duplicadas ocultas da visualização (por exemplo, devido a um filtro). Ao remover duplicatas, a primeira instância de cada linha duplicada que é 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 (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}
Campos
range

object (GridRange)

O intervalo de linhas duplicadas a serem removidas.

comparisonColumns[]

object (DimensionRange)

As colunas do intervalo a serem analisadas para detectar valores duplicados. Se nenhuma coluna for selecionada, todas serão analisadas para detectar duplicatas.

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. É necessário especificar pelo menos um campo. O border raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

AddSlicerRequest

Adiciona um seletor a uma página da planilha.

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

object (Slicer)

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

UpdateSlicerSpecRequest

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

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

integer

O ID do seletor a ser atualizado.

spec

object (SlicerSpec)

A especificação a ser aplicada ao fatiador.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. O SlicerSpec raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como 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 e ler os dados da fonte.

A solicitação exige um escopo do OAuth bigquery.readonly adicional se você estiver adicionando uma origem de dados do BigQuery.

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

object (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 página DATA_SOURCE associada e ler os dados da fonte de dados atualizada.

A solicitação requer um escopo do OAuth bigquery.readonly adicional se você estiver atualizando uma origem de dados do BigQuery.

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. É necessário especificar pelo menos um campo. O dataSource raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

DeleteDataSourceRequest

Exclui uma fonte de dados. A solicitação também exclui a planilha de fonte de dados associada e desassocia todos os objetos de fonte de dados.

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 de fonte de dados na planilha pelas referências especificadas.

A solicitação requer um escopo do OAuth bigquery.readonly adicional se você estiver atualizando uma origem de dados do BigQuery.

Se houver várias solicitações de atualização que fazem referência aos mesmos objetos de origem de dados em um lote, apenas a última solicitação de atualização será processada, e todas essas solicitações vão ter 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 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 será atualizado. target pode ser apenas um dos seguintes:
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 associados à fonte de dados.

isAll

boolean

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 (DataSourceObjectReference)
    }
  ]
}
Campos
references[]

object (DataSourceObjectReference)

As referências.

CancelDataSourceRefreshRequest

Cancela uma ou várias atualizações de objetos de fonte de dados na planilha pelas referências especificadas.

A solicitação requer um escopo do OAuth bigquery.readonly adicional se você estiver cancelando uma atualização em uma origem de dados do BigQuery.

Representação JSON 
{

  // 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
Campo de união target. Especifica o que será cancelado. target pode ser apenas um dos seguintes:
references

object (DataSourceObjectReferences)

Referências a objetos de origem de dados com atualizações que precisam ser canceladas.

dataSourceId

string

Referência a um DataSource. Se especificado, cancela todas as atualizações de objetos de fonte de dados associadas a essa fonte.

isAll

boolean

Cancela todas as atualizações de objetos de fonte de dados para todas as fontes de dados na planilha.