Requests

Solicitação

Um único tipo de atualização para aplicar 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. 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 dimensões propriedades.

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

Cancela a mesclagem das células mescladas.

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)

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

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, um gráfico ou uma imagem) de uma planilha.

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

findReplace

object (FindReplaceRequest)

Encontra e substitui ocorrências de um 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 na 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 de filtro.

deleteRange

object (DeleteRangeRequest)

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

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleRequest)

Exclui uma regra de formatação condicional existente.

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 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 daquela 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 intervalos

addBanding

object (AddBandingRequest)

Adiciona um novo intervalo em faixas

deleteBanding

object (DeleteBandingRequest)

Remove um intervalo em intervalos

createDeveloperMetadata

object (CreateDeveloperMetadataRequest)

Cria novos metadados do desenvolvedor

updateDeveloperMetadata

object (UpdateDeveloperMetadataRequest)

Atualiza uma entrada existente de metadados do desenvolvedor

deleteDeveloperMetadata

object (DeleteDeveloperMetadataRequest)

Exclui metadados do desenvolvedor

randomizeRange

object (RandomizeRangeRequest)

Faz com que a ordem das linhas em um intervalo seja aleatória.

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 as células de espaço em branco (como espaços, tabulações ou novas linhas).

deleteDuplicates

object (DeleteDuplicatesRequest)

Remove linhas contendo valores duplicados nas 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.

cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

Cancela as atualizações de 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. É necessário especificar pelo menos um campo. A raiz "propriedades" está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

UpdateSheetPropertiesRequest

Atualiza as propriedades da planilha com as sheetId:

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. A raiz properties está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para 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. É necessário especificar pelo menos um campo. A raiz properties está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

Campo de união dimension_range: O intervalo de dimensão. 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 de fonte de dados a ser atualizada.

DataSourceSheetDimensionRange

Um intervalo em uma única dimensão em um DATA_SOURCE folha

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á incluído.

columnReferences[]

object (DataSourceColumnReference)

As colunas na página da fonte de dados.

UpdateNamedRangeRequest

Atualiza as propriedades do intervalo nomeado com o valor namedRangeId:

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. A raiz namedRange está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

RepeatCellRequest

Atualiza todas as células do intervalo com os valores do objeto Cell especificado. Somente os campos listados no fields serão atualizados. enquanto outros não são alterados.

Ao escrever uma célula com uma fórmula, os intervalos da fórmula serão incrementados automaticamente para cada campo no intervalo. Por exemplo, se escrever uma célula com fórmula =A1 no intervalo B2:C4, B2 seria =A1, B3 seria =A2, e B4 seria =A3, C2 seria =B1, C3 seria =B2, C4 seria =B3.

Para manter os intervalos da fórmula estáticos, use o método $ 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. É necessário especificar pelo menos um campo. A raiz cell está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada 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. A namedRangeId é opcional. Se nenhuma for definida, um ID 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 em um determinado índice, todas as páginas subsequentes os índices serão incrementados. Para adicionar uma folha de objetos, use AddChartRequest e especificar EmbeddedObjectPosition.sheetId ou EmbeddedObjectPosition.newSheet

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

object (SheetProperties)

As propriedades que a nova planilha deve ter. Todas as propriedades são opcionais. A sheetId é opcional. Se nenhuma for definida, um ID será gerado aleatoriamente. (É um erro especificar o ID de uma planilha que já existe.)

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 de DATA_SOURCE o tipo de correspondência, DataSource também seja excluído.

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 gerarmos dados com o argumento "alternativo" Google Workspace. Isso difere com base no tipo e na quantidade de dados de origem.

Campo de união area: Área a ser preenchida automaticamente. area pode ser apenas uma das seguintes opções:
range

object (GridRange)

O intervalo a ser preenchido automaticamente. Isso examinará o intervalo, detectará o local que contém dados e preencherá automaticamente esses dados com o 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 de como estender essa fonte.

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 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 da última coluna da origem. Os números negativos se expandem antes da primeira linha ou da primeira 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 onde os dados devem ser colados.

pasteType

enum (PasteType)

Os tipos de dados a serem colados. Todos os dados de origem serão recortados, independentemente do que for colado.

PasteType

Que tipos de dados devem ser colados.

Enums
PASTE_NORMAL Colar valores, fórmulas, formatos e mesclagens.
PASTE_VALUES Cole SOMENTE os valores sem formatos, fórmulas ou mesclagens.
PASTE_FORMAT Cole apenas o formato e a validação dos dados.
PASTE_NO_BORDERS Marcar como "Gostei" 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 onde a imagem será colado. Se o intervalo cobrir um período que é múltiplo da altura ou largura da origem, os dados serão repetidos para preencher o intervalo de destino. Se o intervalo for menor que o intervalo de origem, todos os dados de origem ainda serão copiados (além do final do intervalo de destino).

pasteType

enum (PasteType)

Os tipos de dados a serem colados.

pasteOrientation

enum (PasteOrientation)

Como esses dados devem ser orientados ao colar.

PasteOrientation

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

Enums
NORMAL Cole normalmente.
TRANSPOSE Cola a transposição, em que todas as linhas se tornam colunas e vice-versa.

MergeCellsRequest

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

mergeType

enum (MergeType)

Como as células devem ser mescladas.

MergeType

O tipo de mesclagem a ser criada.

Enums
MERGE_ALL Criar uma única mesclagem usando o 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 das células do intervalo especificado.

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

object (GridRange)

O intervalo no qual todas as células devem ser canceladas. Se o intervalo abranger várias mesclagens, a mesclagem de todas será cancelada. 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 resultaria em A1:A5 teria bordas de { top: RED, bottom: WHITE, left: BLUE }: Se 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 cujas bordas devem ser atualizadas.

top

object (Border)

A borda a ser colocada no topo do intervalo.

bottom

object (Border)

A borda a ser colocada na parte inferior do intervalo.

left

object (Border)

A borda a ser colocada no lado esquerdo do intervalo.

right

object (Border)

A borda a 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 no 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 é CellData; "row.values". não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

Campo de união area: Os dados de local precisam ser gravados. Exatamente um valor precisa ser definido. area pode ser apenas uma das seguintes opções:
start

object (GridCoordinate)

A coordenada em que os dados começam a ser 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 em que os dados serão gravados.

Se os dados nas linhas não cobrirem todo o intervalo solicitado, os campos correspondentes àqueles 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. A filterViewId é opcional. Se nenhuma for definida, 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 à qual 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 é CellData; "row.values". não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

ClearBasicFilterRequest

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

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 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 de filtro específica.

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

integer

O ID do filtro a ser excluído.

DuplicateFilterViewRequest

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

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

integer

O ID do filtro que está sendo duplicado.

DuplicateSheetRequest

Duplica o conteúdo de uma página.

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

integer

A planilha a ser duplicada.

Se a página de origem for DATA_SOURCE o tipo de disco, DataSource também será duplicada e associada à nova cópia da planilha. Nenhuma execução de dados é acionada. Os dados de grade desta planilha também são copiados, mas ficam disponíveis somente depois que a solicitação em lote é concluída.

insertSheetIndex

integer

O índice de base zero no qual a nova página deve ser inserida. O índice de todas as páginas depois desse valor será 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 planilha existente. Se definido, ele 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 em um intervalo, uma página ou 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 substituto.

matchCase

boolean

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

matchEntireCell

boolean

Verdadeiro se o valor de localização precisar corresponder a toda a célula.

searchByRegex

boolean

Verdadeiro se o valor de localização for um regex. A expressão regular e a substituição devem seguir as regras de expressão regular do Java https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. A string de substituição tem permissão para se referir a grupos de captura. Por exemplo, se uma célula tiver o conteúdo "Google Sheets" e outro tem "Google Docs" e pesquisando "o.* (.*)" pela 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 no qual localizar/substituir. É necessário definir apenas um. scope pode ser apenas uma das seguintes opções:
range

object (GridRange)

O intervalo em que será encontrado/substituído.

sheetId

integer

A página a ser localizada/substituída.

allSheets

boolean

Verdadeiro para localizar/substituir todas as páginas.

InsertDimensionRequest

Insere linhas ou colunas em uma página com 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 limitados.

inheritFromBefore

boolean

Indica se as propriedades da dimensão precisam ser estendidas das dimensões antes ou depois das dimensões recém-inseridas. Verdadeiro para herdar das dimensões anteriores (nesse caso, o índice inicial deve ser maior que 0) e falso para herdar das dimensões posteriores.

Por exemplo, se o índice de linha 0 tem um fundo vermelho e o índice de linha 1 tem um fundo verde, inserir 2 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 anterior ao ponto de inserção era vermelha), enquanto que, 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 existentes para cima ou para baixo.

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

object (GridRange)

O intervalo em que as novas células serão inseridas.

shiftDimension

enum (Dimension)

A dimensão que será deslocada 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.

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 inicial baseado em zero do local para onde mover os dados de origem, com base nas coordenadas antes os dados de origem são removidos da grade. Os dados existentes serão deslocados para baixo ou para a direita (dependendo da dimensão) a fim de abrir espaço para as dimensões movidas. As dimensões de origem são removidas da grade, então os dados podem acabar em um índice diferente do especificado.

Por exemplo, considerando A1..A5 de 0, 1, 2, 3, 4 e querer se mudar "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

Atualize 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 for definido como verdadeiro, uma nova planilha será criada com um ID escolhido para você.

fields

string (FieldMask format)

Os campos de OverlayPosition que deve ser atualizada ao definir uma nova posição. Usado apenas se newPosition.overlayPosition é definido, caso em que pelo menos um campo deve ser especificado. A raiz newPosition.overlayPosition está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

PasteDataRequest

Insere dados na planilha começando na 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, exatamente um valor precisa ser definido. 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 precisa abranger exatamente uma coluna.

delimiter

string

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

delimiterType

enum (DelimiterType)

O tipo de delimitador a ser usado.

DelimiterType

O delimitador no qual dividir.

Enums
DELIMITER_TYPE_UNSPECIFIED Valor padrão. Não use esse valor.
COMMA ","
SEMICOLON ";"
PERIOD ".
SPACE ” ”
CUSTOM Um valor personalizado, conforme definido no delimitador.
AUTODETECT Detectar colunas automaticamente.

UpdateFilterViewRequest

Atualiza 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. A raiz filter está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

DeleteRangeRequest

Exclui um intervalo de células, deslocando as demais 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 pela qual as células excluídas serão substituídas. Se ROWS, as células existentes serão deslocadas 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.

AppendDimensionRequest

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

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

integer

A planilha à 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 serem anexadas.

AddConditionalFormatRuleRequest

Adiciona uma nova regra de formatação condicional no índice especificado. Todas as regras subsequentes os índices 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 no qual a regra deve ser inserida.

UpdateConditionalFormatRuleRequest

Atualiza uma regra de formatação condicional no índice especificado ou move uma regra de formatação condicional para outro índice.

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

  // Union field 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 baseado em zero da regra que deve ser substituída ou movida.

sheetId

integer

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

Campo de união instruction: O tipo de atualização que precisa 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 baseado em zero em que a regra vai terminar.

DeleteConditionalFormatRuleRequest

Exclui uma regra de formatação condicional no índice fornecido. Todas as regras subsequentes os índices diminuem.

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

integer

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

sheetId

integer

A página da qual 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 classificar.

sortSpecs[]

object (SortSpec)

A ordem de classificação por coluna. 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 todas as células no intervalo. Para limpar a validação em um intervalo, chame esse método sem especificar uma regra.

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 que será definida em cada célula do 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. A protectedRangeId é opcional. Se nenhuma for definida, um ID será gerado aleatoriamente. É um erro especificar o ID de um intervalo que já existe.

UpdateProtectedRangeRequest

Atualiza um intervalo protegido existente com a protectedRangeId:

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. A raiz protectedRange está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada 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 daquela 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ão. 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 que serão redimensionadas 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 deve ser adicionado à planilha, incluindo a posição em que ele deve ser colocado. A chartId é opcional. Se nenhuma for definida, um ID será gerado aleatoriamente. (É um erro especificar o ID de um objeto incorporado que já existe.)

UpdateChartSpecRequest

Atualiza as especificações de um gráfico. Essa opção não move nem redimensiona o 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 em intervalos fornecido.

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

object (BandedRange)

O intervalo em intervalos a ser atualizado com as novas propriedades.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz bandedRange está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

AddBandingRequest

Adiciona um novo intervalo em intervalos à planilha.

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

object (BandedRange)

O intervalo em faixa a ser adicionado. A bandedRangeId é opcional. Se nenhuma for definida, um ID será gerado aleatoriamente. É um erro especificar o ID de um intervalo que já existe.

DeleteBandingRequest

Remove o intervalo em faixas 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 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 as propriedades dos metadados do desenvolvedor. Atualiza as propriedades dos metadados do desenvolvedor selecionados pelos filtros para os valores fornecidos no DeveloperMetadata recurso. Os autores da chamada precisam especificar as propriedades que querem atualizar no parâmetro "fields" e especificar pelo menos um DataFilter correspondentes aos metadados que serão atualizados.

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. A raiz developerMetadata está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada 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

Faz com que a ordem das linhas em um intervalo seja aleatória.

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

object (GridRange)

O intervalo a randomizar.

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' tem 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 daquele de um grupo G existente, a profundidade do novo grupo G' se torna um maior do que a profundidade do 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 depois depois do intervalo de um grupo G existente, o intervalo do grupo G existente se tornará a união dos intervalos, e o novo grupo G' tem profundidade um maior que a profundidade de G e intervalo como a interseção dos intervalos. Por exemplo, um grupo [B:D, profundidade 1] + [C:E] resulta em grupos [B:E, profundidade 1] e [C:D, profundidade 2].

Representação JSON
{
  "range": {
    object (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. Excluir um grupo em 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 precisam especificar um grupo válido na página, e todos os outros campos precisam ser atualizados.

fields

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz dimensionGroup está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

TrimWhitespaceRequest

Corta o espaço em branco (como espaços, tabulações ou novas linhas) em cada célula no intervalo especificado. Essa solicitação remove todos os espaços em branco do início e do fim do texto de cada célula e reduz qualquer subsequência dos caracteres de espaço em branco restantes a um único espaço. Se o texto cortado resultante começar com um sinal "+" ou '=' o texto permanece como um valor de string e não é interpretado como uma fórmula.

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

object (GridRange)

O intervalo cujas células serão removidas.

DeleteDuplicatesRequest

Remove linhas dentro do intervalo que contêm valores nas colunas especificadas que são cópias 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 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 umas às outras no intervalo.

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

object (GridRange)

O intervalo do qual remover linhas duplicadas.

comparisonColumns[]

object (DimensionRange)

As colunas no intervalo a analisar em busca de valores duplicados. Se nenhuma coluna for selecionada, todas as colunas serão analisadas para identificar 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. É necessário especificar pelo menos um campo. A raiz border está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

AddSlicerRequest

Adiciona um controle de filtros a uma página na 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. A slicerId é opcional. Se nenhuma for definida, um ID será gerado aleatoriamente. É um erro especificar o ID de um controle de filtros já existente.

UpdateSlicerSpecRequest

Atualiza as especificações de um controle de filtros. Essa ação não move nem redimensiona o 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 ID 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. É necessário especificar pelo menos um campo. A raiz SlicerSpec está implícito e não deve ser especificado. Um único "*" pode ser usado como abreviação para listar todos os campos.

AddDataSourceRequest

Adiciona uma fonte de dados. Depois que a fonte de dados for adicionada, um DATA_SOURCE a planilha é criada e uma execução é acionada para atualizar a planilha e ler os dados da fonte de dados.

A solicitação requer uma permissão bigquery.readonly Escopo do OAuth se você estiver adicionando uma fonte 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 fonte de dados DATA_SOURCE para ler os dados da fonte atualizada.

A solicitação requer uma permissão bigquery.readonly Escopo do OAuth se você estiver atualizando uma fonte 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. A raiz dataSource está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

DeleteDataSourceRequest

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

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 uma permissão bigquery.readonly o escopo do OAuth se você estiver atualizando uma fonte de dados do BigQuery.

Se houver várias solicitações de atualização que fazem referência aos mesmos objetos da fonte de dados em um lote, somente a última solicitação de atualização será processada e todas essas solicitações 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 a política não for definida e um objeto da fonte de dados referenciado estiver em 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 a serem atualizados.

dataSourceId

string

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

isAll

boolean

Atualiza todos os objetos de fonte de dados 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.

CancelDataSourceRefreshRequest

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

A solicitação exige uma configuração bigquery.readonly Escopo do OAuth se você estiver cancelando uma atualização em uma fonte 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 uma das seguintes opções:
references

object (DataSourceObjectReferences)

Referências a objetos da fonte de dados cujas atualizações precisam ser canceladas.

dataSourceId

string

Referência a um DataSource: Se especificado, cancela todas as atualizações de objeto da fonte de dados associada a essa fonte de dados.

isAll

boolean

Cancela todas as atualizações de objeto da fonte de dados em todas as fontes na planilha.