Solicitação
Um único tipo de atualização a ser aplicada a uma planilha.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . O tipo de atualização. Exatamente um campo é obrigatório.
kind
pode ser apenas de um dos tipos a seguir:
|
|
updateSpreadsheetProperties
|
Atualiza as propriedades da planilha. |
updateSheetProperties
|
Atualiza as propriedades de uma planilha. |
updateDimensionProperties
|
Atualiza as propriedades das dimensões. |
updateNamedRange
|
Atualiza um intervalo nomeado. |
repeatCell
|
Repete uma única célula em um intervalo. |
addNamedRange
|
Adiciona um intervalo nomeado. |
deleteNamedRange
|
Exclui um intervalo nomeado. |
addSheet
|
Adiciona uma página. |
deleteSheet
|
Exclui uma página. |
autoFill
|
Preenche automaticamente mais dados com base nos dados atuais. |
cutPaste
|
Recorta dados de uma área e os cola em outra. |
copyPaste
|
Copia dados de uma área e os cola em outra. |
mergeCells
|
Mescla as células. |
unmergeCells
|
Cancela a mesclagem das células mescladas. |
updateBorders
|
Atualiza as bordas em um intervalo de células. |
updateCells
|
Atualiza várias células de uma vez. |
addFilterView
|
Adiciona uma visualização com filtro. |
appendCells
|
Anexa células após a última linha com dados em uma página. |
clearBasicFilter
|
Limpa o filtro básico em uma página. |
deleteDimension
|
Exclui linhas ou colunas de uma página. |
deleteEmbeddedObject
|
Exclui um objeto incorporado (por exemplo, um gráfico ou uma imagem) em uma página. |
deleteFilterView
|
Exclui uma visualização com filtro de uma página. |
duplicateFilterView
|
Duplica uma visualização de filtro. |
duplicateSheet
|
Duplica uma página. |
findReplace
|
Encontra e substitui ocorrências de um texto por outro. |
insertDimension
|
Insere novas linhas ou colunas em uma página. |
insertRange
|
Insere novas células em uma página, deslocando as células existentes. |
moveDimension
|
Move linhas ou colunas para outro local em uma página. |
updateEmbeddedObjectPosition
|
Atualiza a posição de um objeto incorporado (por exemplo, gráfico ou imagem). |
pasteData
|
Cola dados (HTML ou delimitados) em uma página. |
textToColumns
|
Converte uma coluna de texto em várias colunas de texto. |
updateFilterView
|
Atualiza as propriedades de uma visualização com filtro. |
deleteRange
|
Exclui um intervalo de células de uma planilha, deslocando as células restantes. |
appendDimension
|
Anexa dimensões ao final de uma página. |
addConditionalFormatRule
|
Adiciona uma nova regra de formatação condicional. |
updateConditionalFormatRule
|
Atualiza uma regra de formato condicional existente. |
deleteConditionalFormatRule
|
Exclui uma regra de formato condicional existente. |
sortRange
|
Classifica os dados em um intervalo. |
setDataValidation
|
Define a validação de dados para uma ou mais células. |
setBasicFilter
|
Define o filtro básico em uma página. |
addProtectedRange
|
Adiciona um intervalo protegido. |
updateProtectedRange
|
Atualiza um intervalo protegido. |
deleteProtectedRange
|
Exclui um intervalo protegido. |
autoResizeDimensions
|
Redimensiona automaticamente uma ou mais dimensões com base no conteúdo das células naquela dimensão. |
addChart
|
Adiciona um gráfico. |
updateChartSpec
|
Atualiza as especificações de um gráfico. |
updateBanding
|
Atualiza um intervalo de faixas |
addBanding
|
Adiciona uma nova faixa de faixa |
deleteBanding
|
Remove um intervalo de faixas |
createDeveloperMetadata
|
Cria novos metadados do desenvolvedor |
updateDeveloperMetadata
|
Atualiza uma entrada de metadados do desenvolvedor |
deleteDeveloperMetadata
|
Exclui metadados do desenvolvedor |
randomizeRange
|
Coloca aleatoriamente a ordem das linhas em um intervalo. |
addDimensionGroup
|
Cria um grupo no intervalo especificado. |
deleteDimensionGroup
|
Exclui um grupo no intervalo especificado. |
updateDimensionGroup
|
Atualiza o estado do grupo especificado. |
trimWhitespace
|
Corta células com espaços em branco (como espaços, tabulações ou novas linhas). |
deleteDuplicates
|
Remove linhas que contêm valores duplicados nas colunas especificadas de um intervalo de células. |
updateEmbeddedObjectBorder
|
Atualiza a borda de um objeto incorporado. |
addSlicer
|
Adiciona um controle de filtros. |
updateSlicerSpec
|
Atualiza as especificações de um controle de filtros. |
addDataSource
|
Adiciona uma fonte de dados. |
updateDataSource
|
Atualiza uma fonte de dados. |
deleteDataSource
|
Exclui uma fonte de dados. |
refreshDataSource
|
Atualiza uma ou várias fontes de dados e dbobjects associados. |
cancelDataSourceRefresh
|
Cancela atualizações de uma ou várias fontes de dados e dbobjects associados. |
UpdateSpreadsheetPropertiesRequest
Atualiza as propriedades de uma planilha.
Representação JSON |
---|
{
"properties": {
object (
|
Campos | |
---|---|
properties
|
Propriedades a serem atualizadas. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz "propriedades" é implícita e não deve ser especificada. Um único |
UpdateSheetPropertiesRequest
Atualiza as propriedades da página com o sheetId
especificado.
Representação JSON |
---|
{
"properties": {
object (
|
Campos | |
---|---|
properties
|
Propriedades a serem atualizadas. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
UpdateDimensionPropertiesRequest
Atualiza propriedades de dimensões no intervalo especificado.
Representação JSON |
---|
{ "properties": { object ( |
Campos | |
---|---|
properties
|
Propriedades a serem atualizadas. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
Campo de união dimension_range . Intervalo de dimensão.
dimension_range
pode ser apenas de um dos tipos a seguir:
|
|
range
|
As linhas ou colunas a serem atualizadas. |
dataSourceSheetRange
|
As colunas de uma página 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 (
|
Campos | |
---|---|
sheetId
|
O ID da página de fonte de dados em que o intervalo está. |
columnReferences[]
|
As colunas na página da fonte de dados. |
UpdateNamedRangeRequest
Atualiza as propriedades do intervalo nomeado com o namedRangeId
especificado.
Representação JSON |
---|
{
"namedRange": {
object (
|
Campos | |
---|---|
namedRange
|
O intervalo nomeado a ser atualizado com as novas propriedades. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
RepeatCellRequest
Atualiza todas as células no intervalo para os valores do objeto Cell especificado. 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 dessa fórmula serão incrementados automaticamente para cada campo no intervalo. Por exemplo, se gravar uma célula com a fórmula =A1
no intervalo B2:C4, B2 seria =A1
, B3 seria =A2
, B4 seria =A3
, C2 seria =B1
, C3 seria =B2
e C4 seria =B3
.
Para manter os intervalos da fórmula estáticos, use o
indicador
$
. Por exemplo, use a fórmula
=$A$1
para evitar que a linha e a coluna aumentem.
Representação JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
O intervalo em que a célula será repetida. |
cell
|
Os dados a serem gravados. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
AddNamedRangeRequest
Adiciona um intervalo nomeado à planilha.
Representação JSON |
---|
{
"namedRange": {
object (
|
Campos | |
---|---|
namedRange
|
O intervalo nomeado a ser adicionado. O campo |
DeleteNamedRangeRequest
Remove o intervalo nomeado com o ID fornecido da planilha.
Representação JSON |
---|
{ "namedRangeId": string } |
Campos | |
---|---|
namedRangeId
|
O ID do intervalo nomeado a ser excluído. |
AddSheetRequest
Adiciona uma nova página. Quando uma página é adicionada em um determinado índice, os índices de todas as páginas subsequentes são incrementados. Para adicionar uma página de objetos, use
AddChartRequest
e especifique
EmbeddedObjectPosition.sheetId
ou
EmbeddedObjectPosition.newSheet
.
Representação JSON |
---|
{
"properties": {
object (
|
Campos | |
---|---|
properties
|
As propriedades que a nova planilha deve ter. Todas as propriedades são opcionais. O campo |
DeleteSheetRequest
Exclui a planilha solicitada.
Representação JSON |
---|
{ "sheetId": integer } |
Campos | |
---|---|
sheetId
|
O ID da página a ser excluída.
Se a planilha for do tipo |
AutoFillRequest
Preenche mais dados com base nos dados atuais.
Representação JSON |
---|
{ "useAlternateSeries": boolean, // Union field |
Campos | |
---|---|
useAlternateSeries
|
Verdadeiro se for preciso gerar dados com a série "alternate". Isso varia de acordo com o tipo e a quantidade de dados de origem. |
Campo de união area . A área a ser preenchida automaticamente.
area
pode ser apenas de um dos tipos a seguir:
|
|
range
|
O intervalo do preenchimento automático. Isso examina o intervalo, detecta o local que tem dados e preenche automaticamente esses dados no restante do intervalo. |
sourceAndDestination
|
As áreas de origem e destino para preenchimento automático. Isso lista explicitamente a origem do preenchimento automático e onde estender esses dados. |
SourceAndDestination
Uma combinação de um intervalo de origem e como estender essa origem.
Representação JSON |
---|
{ "source": { object ( |
Campos | |
---|---|
source
|
O local dos dados a serem usados como origem do preenchimento automático. |
dimension
|
A dimensão a que os dados devem ser preenchidos. |
fillLength
|
O número de linhas ou colunas em que os dados devem ser preenchidos. Os números positivos se expandem além da última linha ou última coluna da origem. Os números negativos se expandem antes da primeira linha ou primeira coluna da origem. |
CutPasteRequest
Move os dados da origem para o destino.
Representação JSON |
---|
{ "source": { object ( |
Campos | |
---|---|
source
|
Os dados de origem a serem recortados. |
destination
|
A coordenada superior esquerda em que os dados devem ser colados. |
pasteType
|
Os tipos de dados a serem colados. Todos os dados de origem serão recortados, independente do que for colado. |
PasteType
Os tipos de dados que devem ser colados.
Enums | |
---|---|
PASTE_NORMAL
|
Colar valores, fórmulas, formatos e mesclagens. |
PASTE_VALUES
|
Cole os valores APENAS, sem formatos, fórmulas ou mesclagens. |
PASTE_FORMAT
|
Cole apenas o formato e a validação de dados. |
PASTE_NO_BORDERS
|
Semelhante a
PASTE_NORMAL ,
mas sem bordas.
|
PASTE_FORMULA
|
Cole apenas as fórmulas. |
PASTE_DATA_VALIDATION
|
Cole apenas a validação de dados. |
PASTE_CONDITIONAL_FORMATTING
|
Cole apenas as regras de formatação condicional. |
CopyPasteRequest
Copia dados da origem para o destino.
Representação JSON |
---|
{ "source": { object ( |
Campos | |
---|---|
source
|
O intervalo de origem a ser copiado. |
destination
|
O local em que o conteúdo será colado. Se o intervalo cobrir um período que seja um múltiplo da altura ou largura da origem, os dados serão repetidos para preencher o intervalo de destino. Se o intervalo for menor que o intervalo de origem, todos os dados ainda serão copiados (além do fim do intervalo de destino). |
pasteType
|
Os tipos de dados a serem colados. |
pasteOrientation
|
Como esses dados devem ser orientados ao colar. |
PasteOrientation
Como uma operação de colagem 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 ( |
Campos | |
---|---|
range
|
O intervalo de células a ser mesclado. |
mergeType
|
Como as células devem ser mescladas. |
MergeType
O tipo de mesclagem a ser criada.
Enums | |
---|---|
MERGE_ALL
|
Criar uma única mesclagem a partir do intervalo |
MERGE_COLUMNS
|
Criar uma mesclagem para cada coluna no intervalo |
MERGE_ROWS
|
Criar uma mesclagem para cada linha do intervalo |
UnmergeCellsRequest
Cancela a mesclagem de células no intervalo especificado.
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
O intervalo em que a mesclagem de todas as células deve ser desfeita. Se o intervalo abranger várias mesclagens, todas serão desmarcadas. O intervalo não pode abranger parcialmente uma mesclagem. |
UpdateBordersRequest
Atualiza as bordas de um intervalo. Se um campo não for definido na solicitação, a borda permanecerá como está. Por exemplo, com dois UpdateBordersRequest subsequentes:
-
intervalo: A1:A5
{ top: RED, bottom: WHITE }
-
intervalo: A1:A5
{ left: BLUE }
Isso faria com que A1:A5 tenha bordas de
{ top: RED, bottom: WHITE, left: BLUE }
. Para limpar uma borda, defina explicitamente o estilo como NONE
.
Representação JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
O intervalo cujas bordas precisam ser atualizadas. |
top
|
A borda a ser colocada no topo do intervalo. |
bottom
|
A borda a ser colocada na parte inferior do intervalo. |
left
|
A borda a ser colocada à esquerda do intervalo. |
right
|
A borda a ser colocada à direita do intervalo. |
innerHorizontal
|
A borda horizontal a ser colocada no intervalo. |
innerVertical
|
A borda vertical a ser colocada no intervalo. |
UpdateCellsRequest
Atualiza todas as células em um intervalo com novos dados.
Representação JSON |
---|
{ "rows": [ { object ( |
Campos | |
---|---|
rows[]
|
Os dados a serem gravados. |
fields
|
Os campos de CellData que devem ser atualizados. É necessário especificar pelo menos um campo. A raiz é CellData; 'row.values.' não deve ser especificado. Um único |
Campo de união area . Os dados de local precisam ser gravados. Exatamente um valor deve ser definido.
area
pode ser apenas de um dos tipos a seguir:
|
|
start
|
A coordenada na qual começar a gravar dados. Qualquer número de linhas e colunas (incluindo um número diferente de colunas por linha) pode ser gravado. |
range
|
O intervalo em que os dados serão gravados.
Se os dados nas linhas não cobrirem todo o intervalo solicitado, os campos que correspondem aos definidos em |
AddFilterViewRequest
Adiciona uma visualização com filtro.
Representação JSON |
---|
{
"filter": {
object (
|
Campos | |
---|---|
filter
|
O filtro a ser adicionado. O campo |
AppendCellsRequest
Adiciona novas células 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 (
|
Campos | |
---|---|
sheetId
|
O ID da planilha à qual os dados serão anexados. |
rows[]
|
Os dados a serem anexados. |
fields
|
Os campos de CellData que devem ser atualizados. É necessário especificar pelo menos um campo. A raiz é CellData; 'row.values.' não deve ser especificado. Um único |
ClearBasicFilterRequest
Limpa o filtro básico, se houver algum na página.
Representação JSON |
---|
{ "sheetId": integer } |
Campos | |
---|---|
sheetId
|
O ID da planilha em que o filtro básico deve ser apagado. |
DeleteDimensionRequest
Exclui as dimensões da planilha.
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
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
|
O ID do objeto incorporado a ser excluído. |
DeleteFilterViewRequest
Exclui uma determinada visualização com filtro.
Representação JSON |
---|
{ "filterId": integer } |
Campos | |
---|---|
filterId
|
O ID do filtro a ser excluído. |
DuplicateFilterViewRequest
Duplica uma visualização de filtro específica.
Representação JSON |
---|
{ "filterId": integer } |
Campos | |
---|---|
filterId
|
O ID do filtro que está sendo duplicado. |
DuplicateSheetRequest
Duplica o conteúdo de uma página.
Representação JSON |
---|
{ "sourceSheetId": integer, "insertSheetIndex": integer, "newSheetId": integer, "newSheetName": string } |
Campos | |
---|---|
sourceSheetId
|
A página a ser duplicada.
Se a página de origem for do tipo |
insertSheetIndex
|
O índice baseado em zero em que a nova página deve ser inserida. O índice de todas as páginas depois deste é incrementado. |
newSheetId
|
Se definido, o ID da nova planilha. Se não for definido, será escolhido um ID. Se definido, o ID não pode entrar em conflito com nenhum ID de página existente. Se definido, ele não pode ser negativo. |
newSheetName
|
O nome da nova planilha. Se estiver vazio, um novo nome vai 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 |
Campos | |
---|---|
find
|
O valor a ser pesquisado. |
replacement
|
O valor a ser usado como substituto. |
matchCase
|
Verdadeiro se a pesquisa diferenciar maiúsculas de minúsculas. |
matchEntireCell
|
Verdadeiro se o valor de busca precisar corresponder à célula inteira. |
searchByRegex
|
Verdadeiro se o valor de localização for um regex. A expressão regular e a substituição precisam seguir as regras de regex Java em https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. A string de substituição pode se referir a grupos de captura. Por exemplo, se uma célula tiver o conteúdo
|
includeFormulas
|
Verdadeiro se a pesquisa deve 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 de um dos tipos a seguir:
|
|
range
|
O intervalo no qual localizar/substituir. |
sheetId
|
Planilha para localizar/substituir. |
allSheets
|
Verdadeiro para localizar/substituir em todas as páginas. |
InsertDimensionRequest
Insere linhas ou colunas em uma página com um índice específico.
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
As dimensões a serem inseridas. Os índices inicial e final precisam ser limitados. |
inheritFromBefore
|
Define se as propriedades da dimensão devem ser estendidas a partir das dimensões antes ou depois das dimensões recém-inseridas. Verdadeiro para herdar das dimensões anteriores (nesse caso, o índice inicial precisa ser maior do que 0), e falso para herdar das dimensões posteriores.
Por exemplo, se o índice da linha 0 tiver o plano de fundo vermelho e o índice 1 da linha tiver um fundo verde, a inserção de 2 linhas no índice 1 pode herdar o plano de fundo verde ou vermelho. Se
|
InsertRangeRequest
Insere células em um intervalo, movendo as células existentes para cima ou para baixo.
Representação JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
O intervalo no qual inserir novas células. |
shiftDimension
|
A dimensão que será alterada ao inserir células. Se
|
MoveDimensionRequest
Move uma ou mais linhas ou colunas.
Representação JSON |
---|
{
"source": {
object (
|
Campos | |
---|---|
source
|
As dimensões de origem a serem movidas. |
destinationIndex
|
O índice inicial baseado em zero para onde mover os dados de origem, com base nas coordenadas antes de os dados de origem serem removidos da grade. Os dados existentes serão deslocados para baixo ou para a direita (dependendo da dimensão) 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
|
UpdateEmbeddedObjectPositionRequest
Atualize a posição de um objeto incorporado (por exemplo, ao mover ou redimensionar um gráfico ou uma imagem).
Representação JSON |
---|
{
"objectId": integer,
"newPosition": {
object (
|
Campos | |
---|---|
objectId
|
O ID do objeto a ser movido. |
newPosition
|
Uma posição explícita para onde o objeto incorporado será movido. Se
|
fields
|
Os campos de |
PasteDataRequest
Insere dados na planilha a partir da coordenada especificada.
Representação JSON |
---|
{ "coordinate": { object ( |
Campos | |
---|---|
coordinate
|
A coordenada na qual os dados devem começar a ser inseridos. |
data
|
Os dados a serem inseridos. |
type
|
Como os dados devem ser colados. |
Campo de união kind . Como interpretar os dados: exatamente um valor precisa ser definido.
kind
pode ser apenas de um dos tipos a seguir:
|
|
delimiter
|
O delimitador nos dados. |
html
|
Verdadeiro se os dados forem HTML. |
TextToColumnsRequest
divide uma coluna de texto em várias colunas com base em um delimitador em cada célula.
Representação JSON |
---|
{ "source": { object ( |
Campos | |
---|---|
source
|
Intervalo de dados de origem. Precisa abranger exatamente uma coluna. |
delimiter
|
O delimitador a ser usado. Usado somente se delimiterType for |
delimiterType
|
O tipo de delimitador a ser usado. |
DelimiterType
O delimitador.
Enums | |
---|---|
DELIMITER_TYPE_UNSPECIFIED
|
Valor padrão. Esse valor não pode ser usado. |
COMMA
|
"," |
SEMICOLON
|
";" |
PERIOD
|
"." |
SPACE
|
" " |
CUSTOM
|
Um valor personalizado conforme definido no delimitador. |
AUTODETECT
|
Detectar colunas automaticamente. |
UpdateFilterViewRequest
Atualiza as propriedades da visualização de filtro.
Representação JSON |
---|
{
"filter": {
object (
|
Campos | |
---|---|
filter
|
As novas propriedades da visualização com filtro. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
DeleteRangeRequest
Exclui um intervalo de células, deslocando outras células para a área excluída.
Representação JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
O intervalo de células a ser excluído. |
shiftDimension
|
A dimensão pela qual as células excluídas serão substituídas. Se
|
AppendDimensionRequest
Anexa linhas ou colunas no final de uma página.
Representação JSON |
---|
{
"sheetId": integer,
"dimension": enum (
|
Campos | |
---|---|
sheetId
|
A página à qual linhas ou colunas serão anexadas. |
dimension
|
Define se linhas ou colunas devem ser anexadas. |
length
|
O número de linhas ou colunas a serem anexadas. |
AddConditionalFormatRuleRequest
Adiciona uma nova regra de formato condicional no índice especificado. Todos os índices das regras subsequentes serão incrementados.
Representação JSON |
---|
{
"rule": {
object (
|
Campos | |
---|---|
rule
|
A regra a ser adicionada. |
index
|
O índice baseado em zero em que a regra deve ser inserida. |
UpdateConditionalFormatRuleRequest
Atualiza uma regra de formato condicional no índice especificado ou move uma regra de formato condicional para outro índice.
Representação JSON |
---|
{ "index": integer, "sheetId": integer, // Union field |
Campos | |
---|---|
index
|
O índice baseado em zero da regra que deve ser substituída ou movida. |
sheetId
|
A página da regra a ser movida. Obrigatório se
|
Campo de união instruction . O tipo de atualização que precisa acontecer.
instruction
pode ser apenas de um dos tipos a seguir:
|
|
rule
|
A regra que substituirá a regra no índice especificado. |
newIndex
|
O novo índice baseado em zero que a regra deve atingir. |
DeleteConditionalFormatRuleRequest
Exclui uma regra de formatação condicional no índice especificado. Todos os índices das regras subsequentes são reduzidos.
Representação JSON |
---|
{ "index": integer, "sheetId": integer } |
Campos | |
---|---|
index
|
O índice baseado em zero da regra a ser excluída. |
sheetId
|
A página 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 ( |
Campos | |
---|---|
range
|
O intervalo a ser classificado. |
sortSpecs[]
|
A ordem de classificação por coluna. As especificações posteriores são usadas quando os valores são iguais nas especificações anteriores. |
SetDataValidationRequest
Define uma regra de validação de dados para cada célula no intervalo. Para limpar a validação em um intervalo, chame esse parâmetro sem uma regra especificada.
Representação JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
O intervalo em que a regra de validação de dados se aplica. |
rule
|
A regra de validação de dados a ser definida em cada célula no intervalo ou vazia para limpar a validação de dados no intervalo. |
SetBasicFilterRequest
Define o filtro básico associado a uma página.
Representação JSON |
---|
{
"filter": {
object (
|
Campos | |
---|---|
filter
|
O filtro a ser definido. |
AddProtectedRangeRequest
Adiciona um novo intervalo protegido.
Representação JSON |
---|
{
"protectedRange": {
object (
|
Campos | |
---|---|
protectedRange
|
O intervalo protegido que será adicionado. O campo |
UpdateProtectedRangeRequest
Atualiza um intervalo protegido existente com o protectedRangeId
especificado.
Representação JSON |
---|
{
"protectedRange": {
object (
|
Campos | |
---|---|
protectedRange
|
O intervalo protegido a ser atualizado com as novas propriedades. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
DeleteProtectedRangeRequest
Exclui o intervalo protegido com o ID fornecido.
Representação JSON |
---|
{ "protectedRangeId": integer } |
Campos | |
---|---|
protectedRangeId
|
O ID do intervalo protegido a ser excluído. |
AutoResizeDimensionsRequest
Redimensiona automaticamente uma ou mais dimensões com base no conteúdo das células naquela dimensão.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união dimension_range . Intervalo de dimensão.
dimension_range
pode ser apenas de um dos tipos a seguir:
|
|
dimensions
|
As dimensões a serem redimensionadas automaticamente. |
dataSourceSheetDimensions
|
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 (
|
Campos | |
---|---|
chart
|
O gráfico que deve ser adicionado à planilha, incluindo a posição em que ele deve ser colocado. O campo |
UpdateChartSpecRequest
Atualiza as especificações de um gráfico. Essa açã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 (
|
Campos | |
---|---|
chartId
|
O ID do gráfico a ser atualizado. |
spec
|
A especificação a ser aplicada ao gráfico. |
UpdateBandingRequest
Atualiza propriedades do intervalo de faixa fornecido.
Representação JSON |
---|
{
"bandedRange": {
object (
|
Campos | |
---|---|
bandedRange
|
O intervalo de faixas a ser atualizado com as novas propriedades. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
AddBandingRequest
Adiciona um novo intervalo de banda à planilha.
Representação JSON |
---|
{
"bandedRange": {
object (
|
Campos | |
---|---|
bandedRange
|
A faixa de faixas a ser adicionada. O campo |
DeleteBandingRequest
Remove o intervalo de faixas com o ID fornecido da planilha.
Representação JSON |
---|
{ "bandedRangeId": integer } |
Campos | |
---|---|
bandedRangeId
|
O ID do intervalo de faixas a ser excluído. |
CreateDeveloperMetadataRequest
Uma solicitação para criar metadados de desenvolvedor.
Representação JSON |
---|
{
"developerMetadata": {
object (
|
Campos | |
---|---|
developerMetadata
|
Os metadados do desenvolvedor que serão criados. |
UpdateDeveloperMetadataRequest
Uma solicitação para atualizar as propriedades dos metadados do desenvolvedor. Atualiza as propriedades dos metadados do desenvolvedor selecionados pelos filtros para os valores fornecidos no
recurso
DeveloperMetadata
. Os autores da chamada precisam especificar as propriedades que querem atualizar no parâmetro de campos, além de especificar pelo menos um DataFilter
correspondente aos metadados que querem atualizar.
Representação JSON |
---|
{ "dataFilters": [ { object ( |
Campos | |
---|---|
dataFilters[]
|
Os filtros que correspondem às entradas de metadados do desenvolvedor a serem atualizados. |
developerMetadata
|
O valor para o qual todos os metadados que corresponderem aos filtros de dados serão atualizados. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
DeleteDeveloperMetadataRequest
Uma solicitação para excluir os metadados do desenvolvedor.
Representação JSON |
---|
{
"dataFilter": {
object (
|
Campos | |
---|---|
dataFilter
|
Filtro de dados que descreve os critérios usados para selecionar qual entrada de metadados do desenvolvedor será excluída. |
RandomizeRangeRequest
Coloca aleatoriamente a ordem das linhas em um intervalo.
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
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' 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 existente, a profundidade do novo grupo G' será maior que a profundidade de G. Por exemplo, um grupo [B:E, profundidade 1] + [C:D] resulta em grupos [B:E, profundidade 1] e [C:D, profundidade 2]. Se o intervalo solicitado começar antes e terminar dentro ou 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' terá a profundidade um maior do que a profundidade de G e o intervalo como a interseção dos intervalos. Por exemplo, um grupo [B:D, profundidade 1] + [C:E] resulta em grupos [B:E, profundidade 1] e [C:D, profundidade 2].
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
O intervalo em que um grupo deve 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 em B:E e um grupo de profundidade em C:D. A exclusão de um grupo em D:E deixa a página com um grupo de profundidade acima de B:D e um de profundidade de 2 acima de C:C.
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
O intervalo do grupo a ser excluído. |
UpdateDimensionGroupRequest
Atualiza o estado do grupo especificado.
Representação JSON |
---|
{
"dimensionGroup": {
object (
|
Campos | |
---|---|
dimensionGroup
|
O grupo cujo estado 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
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
TrimWhitespaceRequest
Corta o espaço em branco (como espaços, tabulações ou novas linhas) em todas as células no intervalo especificado. Essa solicitação remove todos os espaços em branco do início e do final do texto de cada célula e reduz qualquer subsequência de caracteres de espaço em branco restantes para um único espaço. Se o texto cortado resultante começar com um caractere "+" ou "=", o texto permanece como um valor de string e não é interpretado como uma fórmula.
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
O intervalo cujas células serão cortadas. |
DeleteDuplicatesRequest
Remove linhas deste intervalo que contêm valores nas colunas especificadas que são duplicatas de valores em qualquer linha anterior. Linhas com valores idênticos, mas capitalização, 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 ( |
Campos | |
---|---|
range
|
O intervalo do qual remover linhas duplicadas. |
comparisonColumns[]
|
As colunas no intervalo a serem analisadas em busca de valores duplicados. Se nenhuma coluna for selecionada, todas as colunas serão analisadas em busca de duplicatas. |
UpdateEmbeddedObjectBorderRequest
Atualiza a propriedade de borda de um objeto incorporado.
Representação JSON |
---|
{
"objectId": integer,
"border": {
object (
|
Campos | |
---|---|
objectId
|
O ID do objeto incorporado a ser atualizado. |
border
|
A borda que se aplica ao objeto incorporado. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
AddSlicerRequest
Adiciona um controle de filtros a uma página na planilha.
Representação JSON |
---|
{
"slicer": {
object (
|
Campos | |
---|---|
slicer
|
O controle de filtros que deve ser adicionado à planilha, incluindo a posição em que ele deve ser colocado. O campo |
UpdateSlicerSpecRequest
Atualiza as especificações de um controle de filtros. Isso não move nem redimensiona um controle de filtros. Para mover ou redimensionar um controle de filtros, use UpdateEmbeddedObjectPositionRequest
.
Representação JSON |
---|
{
"slicerId": integer,
"spec": {
object (
|
Campos | |
---|---|
slicerId
|
O ID do controle de filtros a ser atualizado. |
spec
|
A especificação a ser aplicada ao controle de filtros. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
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 de dados. A solicitação requer um escopo bigquery.readonly
adicional do OAuth.
Representação JSON |
---|
{
"dataSource": {
object (
|
Campos | |
---|---|
dataSource
|
A fonte de dados a ser adicionada. |
UpdateDataSourceRequest
Atualiza uma fonte de dados. Depois que a fonte de dados for atualizada, uma execução será acionada para atualizar a página
DATA_SOURCE
associada para ler os dados da fonte atualizada. A solicitação requer um escopo bigquery.readonly
adicional do OAuth.
Representação JSON |
---|
{
"dataSource": {
object (
|
Campos | |
---|---|
dataSource
|
A fonte de dados a ser atualizada. |
fields
|
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz
|
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 dessa fonte.
Representação JSON |
---|
{ "dataSourceId": string } |
Campos | |
---|---|
dataSourceId
|
O ID da fonte de dados a ser excluída. |
RefreshDataSourceRequest
Atualiza um ou vários objetos de fonte de dados na planilha de acordo com as referências especificadas. A solicitação requer um escopo bigquery.readonly
adicional do OAuth.
Se houver várias solicitações de atualização fazendo referência aos mesmos objetos de fonte de dados em um lote, somente a última delas será processada e todas terão a mesma resposta.
Representação JSON |
---|
{ "force": boolean, // Union field |
Campos | |
---|---|
force
|
Atualiza os objetos da fonte de dados, independentemente do estado atual. Se não for definido e um objeto de fonte de dados referenciado estiver em estado de erro, a atualização vai falhar imediatamente. |
Campo de união target . Especifica o que atualizar.
target
pode ser apenas de um dos tipos a seguir:
|
|
references
|
Referências a objetos da fonte de dados para atualização. |
dataSourceId
|
Referência a um
|
isAll
|
Atualiza todos os objetos da fonte de dados na planilha. |
DataSourceObjectReferences
Uma lista de referências a objetos da fonte de dados.
Representação JSON |
---|
{
"references": [
{
object (
|
Campos | |
---|---|
references[]
|
As referências. |
DataSourceObjectReference
Referência a um objeto de fonte de dados.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união value . O tipo de referência.
value
pode ser apenas de um dos tipos a seguir:
|
|
sheetId
|
Referências a uma
página
|
chartId
|
Referências a um gráfico de fonte de dados. |
dataSourceTableAnchorCell
|
Referências a um |
dataSourcePivotTableAnchorCell
|
Referências a uma fonte de dados
|
dataSourceFormulaCell
|
Referências a uma célula que contém
|
CancelDataSourceRefreshRequest
Cancela uma ou várias atualizações de objetos de fonte de dados na planilha feitas pelas referências especificadas.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união target . Especifica o que cancelar.
target
pode ser apenas de um dos tipos a seguir:
|
|
references
|
Referências a objetos da fonte de dados cujas atualizações precisam ser canceladas. |
dataSourceId
|
Referência a um
|
isAll
|
Cancela todas as atualizações de objetos de fonte de dados existentes para todas as fontes de dados na planilha. |