Sheets

Planilha

Uma página em uma planilha.

Representação JSON 
{
  "properties": {
    object (SheetProperties)
  },
  "data": [
    {
      object (GridData)
    }
  ],
  "merges": [
    {
      object (GridRange)
    }
  ],
  "conditionalFormats": [
    {
      object (ConditionalFormatRule)
    }
  ],
  "filterViews": [
    {
      object (FilterView)
    }
  ],
  "protectedRanges": [
    {
      object (ProtectedRange)
    }
  ],
  "basicFilter": {
    object (BasicFilter)
  },
  "charts": [
    {
      object (EmbeddedChart)
    }
  ],
  "bandedRanges": [
    {
      object (BandedRange)
    }
  ],
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "rowGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "columnGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "slicers": [
    {
      object (Slicer)
    }
  ],
  "tables": [
    {
      object (Table)
    }
  ],
  "commentAnchors": [
    {
      object (CommentAnchor)
    }
  ]
}
Campos
properties

object (SheetProperties)

As propriedades da planilha.

data[]

object (GridData)

Dados na grade, se for uma planilha de grade.

O número de objetos GridData retornados depende do número de intervalos solicitados na planilha. Por exemplo, se isso representar Sheet1 e a planilha tiver sido solicitada com os intervalos Sheet1!A1:C10 e Sheet1!D15:E20, o primeiro GridData terá um startRow/startColumn de 0, enquanto o segundo terá startRow 14 (linha 15 com base em zero) e startColumn 3 (coluna D com base em zero).

Para uma planilha DATA_SOURCE, não é possível solicitar um intervalo específico. O GridData contém todos os valores.

merges[]

object (GridRange)

Os intervalos que são mesclados.

conditionalFormats[]

object (ConditionalFormatRule)

As regras de formatação condicional nesta planilha.

filterViews[]

object (FilterView)

As visualizações com filtro nesta página.

protectedRanges[]

object (ProtectedRange)

Os intervalos protegidos nesta página.

basicFilter

object (BasicFilter)

O filtro nesta planilha, se houver.

charts[]

object (EmbeddedChart)

As especificações de cada gráfico na página.

bandedRanges[]

object (BandedRange)

Os intervalos com faixas (cores alternadas) nesta planilha.

developerMetadata[]

object (DeveloperMetadata)

Os metadados do desenvolvedor associados a uma planilha.

rowGroups[]

object (DimensionGroup)

Todos os grupos de linhas nesta planilha, ordenados por índice inicial de intervalo crescente e, em seguida, por profundidade do grupo.

columnGroups[]

object (DimensionGroup)

Todos os grupos de colunas nesta planilha, ordenados por índice inicial de intervalo crescente e, em seguida, por profundidade do grupo.

slicers[]

object (Slicer)

Os filtros segmentados nesta planilha.

tables[]

object (Table)

As tabelas nesta página.

commentAnchors[]

object (CommentAnchor)

O comentário fica ancorado nesta página.

SheetProperties

Propriedades de uma planilha.

Representação JSON 
{
  "sheetId": integer,
  "title": string,
  "index": integer,
  "sheetType": enum (SheetType),
  "gridProperties": {
    object (GridProperties)
  },
  "hidden": boolean,
  "tabColor": {
    object (Color)
  },
  "tabColorStyle": {
    object (ColorStyle)
  },
  "rightToLeft": boolean,
  "dataSourceSheetProperties": {
    object (DataSourceSheetProperties)
  }
}
Campos
sheetId

integer

O ID da planilha. Não podem ser negativas. Esse campo não pode ser alterado depois de definido.

title

string

O nome da página.

index

integer

O índice da página na planilha. Ao adicionar ou atualizar propriedades de uma planilha, se esse campo for excluído, a planilha será adicionada ou movida para o final da lista. Ao atualizar ou inserir planilhas, o movimento é considerado nos índices "antes da movimentação". Por exemplo, se houver três planilhas (P1, P2, P3) e você quiser mover P1 para antes de P2, o índice precisará ser definido como 2. Uma solicitação de atualização de índice de planilha é ignorada se o índice solicitado for idêntico ao índice atual das planilhas ou se o novo índice solicitado for igual ao índice atual da planilha + 1.

sheetType

enum (SheetType)

O tipo de página. O padrão é GRID. Esse campo não pode ser alterado depois de definido.

gridProperties

object (GridProperties)

Outras propriedades da planilha, se ela for uma grade. Se a planilha for de objetos, contendo um gráfico ou uma imagem, esse campo não vai aparecer. Ao escrever, é um erro definir propriedades de grade em planilhas que não são de grade.

Se a planilha for do tipo DATA_SOURCE , esse campo será somente de saída, mas vai conter as propriedades que refletem como uma planilha de fonte de dados é renderizada na interface, por exemplo, rowCount.

hidden

boolean

Verdadeiro se a planilha estiver oculta na interface, falso se estiver visível.

tabColor
(deprecated)

object (Color)

A cor da guia na interface. Descontinuado: use tabColorStyle.

tabColorStyle

object (ColorStyle)

A cor da guia na interface. Se tabColor também estiver definido, esse campo terá precedência.

rightToLeft

boolean

Verdadeiro se a planilha for RTL em vez de LTR.

dataSourceSheetProperties

object (DataSourceSheetProperties)

Apenas saída. Se presente, o campo vai conter DATA_SOURCE propriedades específicas da planilha.

SheetType

O tipo de página.

Tipos enumerados
SHEET_TYPE_UNSPECIFIED Valor padrão. Não usar.
GRID A planilha é uma grade.
OBJECT A página não tem grade, mas um objeto, como um gráfico ou uma imagem.
DATA_SOURCE A planilha se conecta a um DataSource externo e mostra a prévia dos dados.

GridProperties

Propriedades de uma grade.

Representação JSON 
{
  "rowCount": integer,
  "columnCount": integer,
  "frozenRowCount": integer,
  "frozenColumnCount": integer,
  "hideGridlines": boolean,
  "rowGroupControlAfter": boolean,
  "columnGroupControlAfter": boolean
}
Campos
rowCount

integer

O número de linhas na grade.

columnCount

integer

O número de colunas na grade.

frozenRowCount

integer

O número de linhas fixadas na grade.

frozenColumnCount

integer

O número de colunas fixadas na grade.

hideGridlines

boolean

Verdadeiro se a grade não estiver mostrando linhas de grade na interface.

rowGroupControlAfter

boolean

Verdadeiro se a alternância de controle de agrupamento de linhas for mostrada após o grupo.

columnGroupControlAfter

boolean

Verdadeiro se a alternância de controle de agrupamento de colunas for mostrada após o grupo.

DataSourceSheetProperties

Outras propriedades de uma planilha DATA_SOURCE.

Representação JSON 
{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Campos
dataSourceId

string

ID da DataSource a que a planilha está conectada.

columns[]

object (DataSourceColumn)

As colunas mostradas na planilha, correspondentes aos valores em RowData.

dataExecutionStatus

object (DataExecutionStatus)

O status da execução de dados.

GridData

Dados na grade e metadados sobre as dimensões.

Representação JSON 
{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}
Campos
startRow

integer

A primeira linha a que este GridData se refere, com base zero.

startColumn

integer

A primeira coluna a que este GridData se refere, com base zero.

rowData[]

object (RowData)

Os dados na grade, uma entrada por linha, começando com a linha em "startRow". Os valores em RowData correspondem às colunas que começam em startColumn.

rowMetadata[]

object (DimensionProperties)

Metadados sobre as linhas solicitadas na grade, começando pela linha em startRow.

columnMetadata[]

object (DimensionProperties)

Metadados sobre as colunas solicitadas na grade, começando pela coluna em startColumn.

RowData

Dados sobre cada célula em uma linha.

Representação JSON 
{
  "values": [
    {
      object (CellData)
    }
  ]
}
Campos
values[]

object (CellData)

Os valores na linha, um por coluna.

DimensionProperties

Propriedades de uma dimensão.

Representação JSON 
{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}
Campos
hiddenByFilter

boolean

Verdadeiro se essa dimensão estiver sendo filtrada. Este campo é somente leitura.

hiddenByUser

boolean

Verdadeiro se essa dimensão estiver explicitamente oculta.

pixelSize

integer

A altura (se for uma linha) ou a largura (se for uma coluna) da dimensão em pixels.

developerMetadata[]

object (DeveloperMetadata)

Os metadados do desenvolvedor associados a uma única linha ou coluna.

dataSourceColumnReference

object (DataSourceColumnReference)

Apenas saída. Se definido, será uma coluna em uma planilha de fonte de dados.

ConditionalFormatRule

Uma regra que descreve um formato condicional.

Representação JSON 
{
  "ranges": [
    {
      object (GridRange)
    }
  ],

  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
}
Campos
ranges[]

object (GridRange)

Os intervalos formatados se a condição for verdadeira. Todos os intervalos precisam estar na mesma grade.

Campo de união rule. A regra que controla esse formato condicional. É necessário definir exatamente uma. rule pode ser apenas um dos seguintes:
booleanRule

object (BooleanRule)

A formatação é "ativada" ou "desativada" de acordo com a regra.

gradientRule

object (GradientRule)

A formatação varia de acordo com os gradientes na regra.

BooleanRule

Uma regra que pode ou não corresponder, dependendo da condição.

Representação JSON 
{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}
Campos
condition

object (BooleanCondition)

A condição da regra. Se a condição for avaliada como verdadeira, o formato será aplicado.

format

object (CellFormat)

O formato a ser aplicado. A formatação condicional só pode aplicar um subconjunto de formatação: bold, italic, strikethrough, foreground color e background color.

GradientRule

Uma regra que aplica um formato de escala de cores gradiente com base nos pontos de interpolação listados. O formato de uma célula varia de acordo com o conteúdo dela em comparação com os valores dos pontos de interpolação.

Representação JSON 
{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}
Campos
minpoint

object (InterpolationPoint)

O ponto de interpolação inicial.

midpoint

object (InterpolationPoint)

Um ponto de interpolação intermediário opcional.

maxpoint

object (InterpolationPoint)

O ponto de interpolação final.

InterpolationPoint

Um único ponto de interpolação em uma formatação condicional de gradiente. Eles fixam a escala de cores gradiente de acordo com a cor, o tipo e o valor escolhidos.

Representação JSON 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}
Campos
color
(deprecated)

object (Color)

A cor que esse ponto de interpolação deve usar. Descontinuado: use colorStyle.

colorStyle

object (ColorStyle)

A cor que esse ponto de interpolação deve usar. Se color também estiver definido, esse campo terá precedência.

type

enum (InterpolationPointType)

Como o valor deve ser interpretado.

value

string

O valor usado por esse ponto de interpolação. Pode ser uma fórmula. Não usado se type for MIN ou MAX.

InterpolationPointType

O tipo de ponto de interpolação.

Tipos enumerados
INTERPOLATION_POINT_TYPE_UNSPECIFIED O valor padrão. Não use.
MIN O ponto de interpolação usa o valor mínimo nas células no intervalo do formato condicional.
MAX O ponto de interpolação usa o valor máximo nas células no intervalo do formato condicional.
NUMBER O ponto de interpolação usa exatamente o valor em InterpolationPoint.value.
PERCENT

O ponto de interpolação é a porcentagem determinada em todas as células no intervalo da formatação condicional. Isso é equivalente a NUMBER se o valor fosse: =(MAX(FLATTEN(range)) * (value / 100)) + (MIN(FLATTEN(range)) * (1 - (value / 100))) (em que os erros no intervalo são ignorados ao achatar).

PERCENTILE O ponto de interpolação é o percentil determinado em todas as células no intervalo da formatação condicional. Isso é equivalente a NUMBER se o valor fosse: =PERCENTILE(FLATTEN(range), value / 100) (em que os erros no intervalo são ignorados ao achatar).

FilterView

Uma visualização com filtro. Para mais informações, consulte Gerenciar a visibilidade dos dados com filtros.

Representação JSON 
{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
Campos
filterViewId

integer

O ID da visualização com filtro.

title

string

O nome da visualização com filtro.

range

object (GridRange)

O intervalo que essa visualização com filtro abrange.

Ao gravar, apenas um dos seguintes parâmetros pode ser definido: range, namedRangeId ou tableId.

namedRangeId

string

O intervalo nomeado em que esta visualização com filtro se baseia, se houver.

Ao gravar, apenas um dos seguintes parâmetros pode ser definido: range, namedRangeId ou tableId.

tableId

string

A tabela em que essa visualização com filtro se baseia, se houver.

Ao gravar, apenas um dos seguintes parâmetros pode ser definido: range, namedRangeId ou tableId.

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.

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria))

Os critérios para mostrar/ocultar valores por coluna. A chave do mapa é o índice da coluna, e o valor é o critério para essa coluna.

O uso desse campo foi suspenso para dar preferência a filterSpecs.

filterSpecs[]

object (FilterSpec)

Os critérios de filtro para mostrar ou ocultar valores por coluna.

criteria e filterSpecs são preenchidos nas respostas. Se ambos os campos forem especificados em uma solicitação de atualização, este campo terá precedência.

ProtectedRange

Um intervalo protegido.

Representação JSON 
{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}
Campos
protectedRangeId

integer

O ID do intervalo protegido. Este campo é somente leitura.

range

object (GridRange)

O intervalo que está sendo protegido. O intervalo pode ser totalmente sem limites, e nesse caso, ele é considerado uma página protegida.

Ao gravar, apenas um dos seguintes campos pode ser definido: range ou namedRangeId ou tableId.

namedRangeId

string

O intervalo nomeado em que este intervalo protegido se baseia, se houver.

Ao gravar, apenas um dos seguintes campos pode ser definido: range ou namedRangeId ou tableId.

tableId

string

A tabela em que esse intervalo protegido se baseia, se houver.

Ao gravar, apenas um dos seguintes campos pode ser definido: range ou namedRangeId ou tableId.

description

string

A descrição do intervalo protegido.

warningOnly

boolean

Verdadeiro se o intervalo protegido mostrar um aviso ao ser editado. A proteção baseada em avisos significa que todos os usuários podem editar dados no intervalo protegido, mas a edição vai gerar um aviso pedindo que o usuário confirme a ação.

Ao gravar: se este campo for verdadeiro, editors será ignorado. Além disso, se esse campo for alterado de "true" para "false" e o campo editors não estiver definido (nem incluído na máscara de campo), os editores serão definidos como todos os editores no documento.

requestingUserCanEdit

boolean

Verdadeiro se o usuário que solicitou esse intervalo protegido puder editar a área protegida. Este campo é somente leitura.

unprotectedRanges[]

object (GridRange)

A lista de intervalos não protegidos em uma página protegida. Intervalos não protegidos são compatíveis apenas com páginas protegidas.

editors

object (Editors)

Os usuários e grupos com acesso de edição ao intervalo protegido. Esse campo só fica visível para usuários com acesso de edição ao intervalo protegido e ao documento. Os editores não são compatíveis com a proteção warningOnly.

Editores

Os editores de um intervalo protegido.

Representação JSON 
{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}
Campos
users[]

string

Os endereços de e-mail dos usuários com acesso de edição ao intervalo protegido.

groups[]

string

Os endereços de e-mail dos grupos com acesso de edição ao intervalo protegido.

domainUsersCanEdit

boolean

Verdadeiro se qualquer pessoa no domínio do documento tiver acesso de edição ao intervalo protegido. A proteção de domínio é compatível apenas com documentos dentro de um domínio.

BasicFilter

O filtro padrão associado a uma planilha. Para mais informações, consulte Gerenciar a visibilidade dos dados com filtros.

Representação JSON 
{
  "range": {
    object (GridRange)
  },
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
Campos
range

object (GridRange)

O intervalo que o filtro abrange.

tableId

string

A tabela em que este filtro se baseia, se houver. Ao gravar, apenas um de range ou tableId pode ser definido.

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.

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria))

Os critérios para mostrar/ocultar valores por coluna. A chave do mapa é o índice da coluna, e o valor é o critério para essa coluna.

O uso desse campo foi suspenso para dar preferência a filterSpecs.

filterSpecs[]

object (FilterSpec)

Os critérios de filtro por coluna.

criteria e filterSpecs são preenchidos nas respostas. Se ambos os campos forem especificados em uma solicitação de atualização, este campo terá precedência.

BandedRange

Um intervalo com faixas (cores alternadas) em uma planilha.

Representação JSON 
{
  "bandedRangeId": integer,
  "bandedRangeReference": string,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}
Campos
bandedRangeId

integer

O ID do intervalo agrupado. Se não estiver definido, consulte bandedRangeReference.

bandedRangeReference

string

Apenas saída. A referência do intervalo agrupado, usada para identificar o ID que é indisponível para o bandedRangeId.

range

object (GridRange)

O intervalo em que essas propriedades são aplicadas.

rowProperties

object (BandingProperties)

Propriedades para faixas de linhas. Essas propriedades são aplicadas linha por linha em todo o intervalo. É preciso especificar pelo menos um dos seguintes valores: rowProperties ou columnProperties.

columnProperties

object (BandingProperties)

Propriedades para faixas de colunas. Essas propriedades são aplicadas coluna por coluna em todas as colunas do intervalo. É preciso especificar pelo menos um dos seguintes valores: rowProperties ou columnProperties.

BandingProperties

Propriedades que se referem a uma única dimensão (linha ou coluna). Se BandedRange.row_properties e BandedRange.column_properties estiverem definidos, as cores de preenchimento serão aplicadas às células de acordo com as seguintes regras:

Por exemplo, a cor da primeira linha tem prioridade sobre a cor da primeira coluna, mas a cor da primeira coluna tem prioridade sobre a cor da segunda linha. Da mesma forma, o cabeçalho da linha tem prioridade sobre o cabeçalho da coluna na célula superior esquerda, mas o cabeçalho da coluna tem prioridade sobre a cor da primeira linha se o cabeçalho da linha não estiver definido.

Representação JSON 
{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
Campos
headerColor
(deprecated)

object (Color)

A cor da primeira linha ou coluna. Se esse campo estiver definido, a primeira linha ou coluna será preenchida com essa cor, e as cores vão alternar entre firstBandColor e secondBandColor a partir da segunda linha ou coluna. Caso contrário, a primeira linha ou coluna será preenchida com firstBandColor e as cores vão se alternar normalmente. Descontinuado: use headerColorStyle.

headerColorStyle

object (ColorStyle)

A cor da primeira linha ou coluna. Se esse campo estiver definido, a primeira linha ou coluna será preenchida com essa cor, e as cores vão alternar entre firstBandColor e secondBandColor a partir da segunda linha ou coluna. Caso contrário, a primeira linha ou coluna será preenchida com firstBandColor e as cores vão se alternar normalmente. Se headerColor também estiver definido, esse campo terá precedência.

firstBandColor
(deprecated)

object (Color)

A primeira cor que está alternando. (Obrigatório) Descontinuado: use firstBandColorStyle.

firstBandColorStyle

object (ColorStyle)

A primeira cor que está alternando. (Obrigatório) Se firstBandColor também estiver definido, esse campo terá precedência.

secondBandColor
(deprecated)

object (Color)

É a segunda cor que está alternando. (Obrigatório) Descontinuado: use secondBandColorStyle.

secondBandColorStyle

object (ColorStyle)

É a segunda cor que está alternando. (Obrigatório) Se secondBandColor também estiver definido, esse campo terá precedência.

footerColor
(deprecated)

object (Color)

A cor da última linha ou coluna. Se esse campo não estiver definido, a última linha ou coluna será preenchida com firstBandColor ou secondBandColor, dependendo da cor da linha ou coluna anterior. Descontinuado: use footerColorStyle.

footerColorStyle

object (ColorStyle)

A cor da última linha ou coluna. Se esse campo não estiver definido, a última linha ou coluna será preenchida com firstBandColor ou secondBandColor, dependendo da cor da linha ou coluna anterior. Se footerColor também estiver definido, esse campo terá precedência.

DimensionGroup

Um grupo em um intervalo de linhas ou colunas em uma planilha, que pode conter ou estar contido em outros grupos. Um grupo pode ser recolhido ou expandido como uma unidade na planilha.

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

object (DimensionRange)

O intervalo em que esse grupo existe.

depth

integer

A profundidade do grupo, representando quantos grupos têm um intervalo que contém totalmente o intervalo deste grupo.

collapsed

boolean

Esse campo será verdadeiro se o grupo estiver recolhido. Um grupo recolhido permanece assim se um grupo sobreposto em uma profundidade menor for expandido.

Um valor verdadeiro não implica que todas as dimensões do grupo estão ocultas, já que a visibilidade de uma dimensão pode mudar independentemente dessa propriedade do grupo. No entanto, quando essa propriedade é atualizada, todas as dimensões nela são definidas como ocultas se esse campo for verdadeiro ou como visíveis se esse campo for falso.

Controle de filtros

Um controle de filtros em uma página.

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

integer

O ID do controle de filtros.

spec

object (SlicerSpec)

A especificação do controle de filtros.

position

object (EmbeddedObjectPosition)

A posição do controle de filtros. A segmentação de dados só pode ser posicionada em uma planilha existente. Além disso, a largura e a altura do controle de filtros podem ser ajustadas automaticamente para mantê-lo dentro dos limites permitidos.

SlicerSpec

As especificações de um controle de filtros.

Representação JSON 
{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}
Campos
dataRange

object (GridRange)

O intervalo de dados do controle de filtros.

filterCriteria

object (FilterCriteria)

Os critérios de filtragem do controle de filtros.

columnIndex

integer

O índice de coluna com base em zero na tabela de dados em que o filtro é aplicado.

applyToPivotTables

boolean

True se o filtro deve ser aplicado a tabelas dinâmicas. Se não for definido, o padrão será True.

title

string

O título do controle de filtros.

textFormat

object (TextFormat)

O formato de texto do título no controle de filtros. O campo de link está indisponível.

backgroundColor
(deprecated)

object (Color)

A cor de fundo do controle de filtros. Descontinuado: use backgroundColorStyle.

backgroundColorStyle

object (ColorStyle)

A cor de fundo do controle de filtros. Se backgroundColor também estiver definido, esse campo terá precedência.

horizontalAlignment

enum (HorizontalAlign)

O alinhamento horizontal do título no segmentador. Se não for especificado, o padrão será LEFT

Tabela

Uma tabela.

Representação JSON 
{
  "tableId": string,
  "name": string,
  "range": {
    object (GridRange)
  },
  "rowsProperties": {
    object (TableRowsProperties)
  },
  "columnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
Campos
tableId

string

O ID da tabela.

name

string

O nome da tabela. Isso é exclusivo para todas as tabelas na mesma planilha.

range

object (GridRange)

O intervalo da tabela.

rowsProperties

object (TableRowsProperties)

As propriedades das linhas da tabela.

columnProperties[]

object (TableColumnProperties)

As propriedades da coluna da tabela.

TableRowsProperties

As propriedades da linha da tabela.

Representação JSON 
{
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
Campos
headerColorStyle

object (ColorStyle)

A cor da linha de cabeçalho. Se esse campo for definido, a linha de cabeçalho será preenchida com a cor especificada. Caso contrário, a linha de cabeçalho será preenchida com uma cor padrão.

firstBandColorStyle

object (ColorStyle)

A primeira cor que está alternando. Se esse campo estiver definido, a primeira linha com faixas será preenchida com a cor especificada. Caso contrário, a primeira linha com faixas será preenchida com uma cor padrão.

secondBandColorStyle

object (ColorStyle)

É a segunda cor que está alternando. Se esse campo for definido, a segunda linha com faixas será preenchida com a cor especificada. Caso contrário, a segunda linha com faixa será preenchida com uma cor padrão.

footerColorStyle

object (ColorStyle)

A cor da última linha. Se esse campo não estiver definido, um rodapé não será adicionado, e a última linha será preenchida com firstBandColorStyle ou secondBandColorStyle, dependendo da cor da linha anterior. Se você estiver atualizando uma tabela sem rodapé para ter um, o intervalo será expandido em uma linha. Se você estiver atualizando uma tabela com um rodapé e removendo um rodapé, o intervalo será reduzido em uma linha.

TableColumnProperties

A coluna da tabela.

Representação JSON 
{
  "columnIndex": integer,
  "columnName": string,
  "columnType": enum (ColumnType),
  "dataValidationRule": {
    object (TableColumnDataValidationRule)
  }
}
Campos
columnIndex

integer

O índice de coluna baseado em zero. Esse índice é relativo à posição na tabela e não é necessariamente o mesmo que o índice da coluna na planilha.

columnName

string

O nome da coluna.

columnType

enum (ColumnType)

O tipo da coluna.

dataValidationRule

object (TableColumnDataValidationRule)

A regra de validação de dados da coluna. Definido apenas para o tipo de coluna de menu suspenso.

ColumnType

O tipo de uma determinada coluna em uma tabela.

Tipos enumerados
COLUMN_TYPE_UNSPECIFIED Um tipo de coluna não especificado.
DOUBLE O tipo de coluna de número.
CURRENCY O tipo de coluna de moeda.
PERCENT O tipo de coluna de porcentagem.
DATE O tipo de coluna de data.
TIME O tipo de coluna de tempo.
DATE_TIME O tipo de coluna de data e hora.
TEXT O tipo de coluna de texto.
BOOLEAN O tipo de coluna booleana.
DROPDOWN O tipo de coluna de menu suspenso.
FILES_CHIP Tipo de coluna: ícone de arquivos
PEOPLE_CHIP O tipo de coluna de ícone de usuário
FINANCE_CHIP O tipo de coluna de ícone de finanças
PLACE_CHIP O tipo de coluna de ícone de lugar
RATINGS_CHIP O tipo de coluna de ícone de classificação

TableColumnDataValidationRule

Uma regra de validação de dados para uma coluna em uma tabela.

Representação JSON 
{
  "condition": {
    object (BooleanCondition)
  }
}
Campos
condition

object (BooleanCondition)

A condição que os dados na célula precisam corresponder. Válido apenas se [BooleanCondition.type] for ONE_OF_LIST.

CommentAnchor

Um local na planilha vinculado a um CommentThread com o mesmo anchorId. Observação: várias âncoras podem se referir ao mesmo local.

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

string

O ID exclusivo da âncora do comentário. Apenas saída.

range

object (GridRange)

O intervalo de coordenadas dentro da planilha em que o comentário está ancorado.