Planilha
Uma página em uma planilha.
Representação JSON |
---|
{ "properties": { object ( |
Campos | |
---|---|
properties
|
As propriedades da página. |
data[]
|
Dados na grade, se esta 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
Para uma
folha |
merges[]
|
Os intervalos que são mesclados. |
conditionalFormats[]
|
As regras de formatação condicional desta página. |
filterViews[]
|
As visualizações com filtro nesta página. |
protectedRanges[]
|
Os intervalos protegidos nesta página. |
basicFilter
|
O filtro na planilha, se houver. |
charts[]
|
As especificações de cada gráfico nesta página. |
bandedRanges[]
|
Os intervalos de faixas (cores alternadas) nesta planilha. |
developerMetadata[]
|
Os metadados do desenvolvedor associados a uma planilha. |
rowGroups[]
|
Todos os grupos de linhas na planilha, ordenados pelo índice de início do intervalo crescente e depois pela profundidade do grupo. |
columnGroups[]
|
Todos os grupos de colunas nesta página, ordenados aumentando o índice inicial do intervalo e, em seguida, por profundidade do grupo. |
slicers[]
|
Os controles de filtros nesta página. |
SheetProperties
Propriedades de uma planilha.
Representação JSON |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
Campos | |
---|---|
sheetId
|
O ID da planilha. Não podem ser negativas. Não é possível mudar esse campo depois de definido. |
title
|
O nome da planilha. |
index
|
O índice da página na planilha. Ao adicionar ou atualizar as propriedades da página, se este campo for excluído, a planilha será adicionada ou movida para o fim da lista de páginas. Ao atualizar índices de planilha ou inserir planilhas, o movimento é considerado nos índices "antes da movimentação". Por exemplo, se houver três planilhas (S1, S2, S3), para mover a S1 à frente da S2, o índice terá que ser definido como 2. Uma solicitação de atualização do índice da página é ignorada se o índice solicitado for idêntico ao índice atual da página ou se o novo índice solicitado for igual ao índice atual da página + 1. |
sheetType
|
O tipo de planilha. O padrão é
|
gridProperties
|
Propriedades adicionais da planilha, se ela for uma grade. Se a planilha for de objetos e tiver um gráfico ou imagem, esse campo estará ausente. Ao escrever, é um erro definir propriedades de grade em folhas que não são de grade.
Se a página for |
tabColor
|
A cor da guia na interface. Descontinuado: use
|
tabColorStyle
|
A cor da guia na interface. Se
|
rightToLeft
|
Verdadeiro se a planilha for RTL em vez de LTR. |
dataSourceSheetProperties
|
Apenas saída. Se presente, o campo contém propriedades específicas da folha |
SheetType
O tipo de folha.
Enums | |
---|---|
SHEET_TYPE_UNSPECIFIED
|
Valor padrão, não usar. |
GRID
|
A planilha é uma grade. |
OBJECT
|
A planilha não tem grade, mas um objeto, como um gráfico ou uma imagem. |
DATA_SOURCE
|
A planilha se conecta a uma
DataSource
externa e mostra a visualização 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
|
O número de linhas na grade. |
columnCount
|
O número de colunas na grade. |
frozenRowCount
|
O número de linhas congeladas na grade. |
frozenColumnCount
|
O número de colunas que são congeladas na grade. |
hideGridlines
|
Verdadeiro se a grade não estiver mostrando linhas de grade na interface. |
rowGroupControlAfter
|
Verdadeiro se o controle de agrupamento de linhas for mostrado após o grupo. |
columnGroupControlAfter
|
Verdadeiro se o controle de agrupamento de colunas for mostrado após o grupo. |
DataSourceSheetProperties
Propriedades adicionais de uma
folha
DATA_SOURCE
.
Representação JSON |
---|
{ "dataSourceId": string, "columns": [ { object ( |
Campos | |
---|---|
dataSourceId
|
ID do
|
columns[]
|
As colunas exibidas na página, correspondendo aos valores em
|
dataExecutionStatus
|
O status de execução dos dados. |
GridData
Dados na grade e metadados sobre as dimensões.
Representação JSON |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
Campos | |
---|---|
startRow
|
A primeira linha a que GridData se refere, com base em zero. |
startColumn
|
A primeira coluna a que este GridData se refere, baseada em zero. |
rowData[]
|
Os dados na grade, uma entrada por linha, começando com a linha na startRow. Os valores em RowData correspondem às colunas a partir de
|
rowMetadata[]
|
Metadados sobre as linhas solicitadas na grade, começando pela linha em
|
columnMetadata[]
|
Metadados sobre as colunas solicitadas na grade, começando pela coluna em |
RowData
Dados sobre cada célula em uma linha.
Representação JSON |
---|
{
"values": [
{
object ( |
Campos | |
---|---|
values[]
|
Os valores na linha, um por coluna. |
DimensionProperties
Propriedades sobre uma dimensão.
Representação JSON |
---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
Campos | |
---|---|
pixelSize
|
A altura (se for uma linha) ou a largura (se for uma coluna) da dimensão em pixels. |
developerMetadata[]
|
Os metadados do desenvolvedor associados a uma única linha ou coluna. |
dataSourceColumnReference
|
Apenas saída. Se definido, será uma coluna em uma página de fonte de dados. |
ConditionalFormatRule
Uma regra que descreve um formato condicional.
Representação JSON |
---|
{ "ranges": [ { object ( |
Campos | |
---|---|
ranges[]
|
Os intervalos que são 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 precisa ser definida exatamente uma vez.
rule
pode ser apenas de um dos tipos a seguir:
|
|
booleanRule
|
A formatação é "ativada" ou "desativada" de acordo com a regra. |
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 ( |
Campos | |
---|---|
condition
|
A condição da regra. Se a condição for avaliada como verdadeira, o formato será aplicado. |
format
|
O formato a ser aplicado. A formatação condicional só pode aplicar um subconjunto de formatação:
|
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 em comparação com os valores dos pontos de interpolação.
Representação JSON |
---|
{ "minpoint": { object ( |
Campos | |
---|---|
minpoint
|
O ponto de interpolação inicial. |
midpoint
|
Um ponto de interpolação opcional no meio. |
maxpoint
|
O último ponto de interpolação. |
InterpolationPoint
Um único ponto de interpolação em um formato condicional de gradiente. Eles fixam a escala de cores do gradiente de acordo com a cor, o tipo e o valor escolhidos.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color
|
A cor que esse ponto de interpolação precisa usar. Descontinuado: use
|
colorStyle
|
A cor que esse ponto de interpolação precisa usar. Se
|
type
|
Como o valor deve ser interpretado. |
value
|
O valor usado por esse ponto de interpolação. Pode ser uma fórmula. Não usado se
|
InterpolationPointType
O tipo de ponto de interpolação.
Enums | |
---|---|
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 ao longo do 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 especificada em todas as células no intervalo do formato condicional. Isso é equivalente a
|
PERCENTILE
|
O ponto de interpolação é o percentil fornecido em todas as células no intervalo do formato condicional. Isso será equivalente a
NUMBER
se o valor for:
=PERCENTILE(FLATTEN(range), value / 100)
(em que os erros no intervalo são ignorados ao nivelar).
|
FilterView
Uma visualização com filtro.
Representação JSON |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
Campos | |
---|---|
filterViewId
|
O ID da visualização de filtro. |
title
|
O nome da visualização de filtro. |
range
|
O intervalo que essa visualização com filtro abrange.
Ao gravar, apenas uma das opções
|
namedRangeId
|
O intervalo nomeado que serviu de base para a visualização de filtro, se houver.
Ao gravar, apenas uma das opções
|
sortSpecs[]
|
A ordem de classificação por coluna. Especificações posteriores são usadas quando os valores são iguais nas especificações anteriores. |
criteria
|
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 descontinuado em favor de
|
filterSpecs[]
|
Os critérios de filtro para mostrar/ocultar valores por coluna.
Tanto
|
ProtectedRange
Um intervalo protegido.
Representação JSON |
---|
{ "protectedRangeId": integer, "range": { object ( |
Campos | |
---|---|
protectedRangeId
|
O ID do intervalo protegido. Este campo é somente leitura. |
range
|
O intervalo que está sendo protegido. O intervalo pode ser totalmente ilimitado, caso em que é considerado uma página protegida.
Ao gravar, apenas uma das opções
|
namedRangeId
|
O intervalo nomeado que dá suporte a esse intervalo protegido, se houver.
Ao gravar, apenas uma das opções
|
description
|
A descrição do intervalo protegido. |
warningOnly
|
Verdadeiro se esse intervalo protegido vai 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 acionar um aviso pedindo que o usuário confirme a edição.
Ao gravar: se esse campo for verdadeiro, |
requestingUserCanEdit
|
Verdadeiro se o usuário que solicitou o intervalo protegido pode editar a área protegida. Este campo é somente leitura. |
unprotectedRanges[]
|
Lista de intervalos não protegidos em uma página protegida. Os intervalos não protegidos só são aceitos em páginas protegidas. |
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. A proteção |
Editores
Os editores de um intervalo protegido.
Representação JSON |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
Campos | |
---|---|
users[]
|
Os endereços de e-mail dos usuários com acesso de edição ao intervalo protegido. |
groups[]
|
Os endereços de e-mail dos grupos com acesso de edição ao intervalo protegido. |
domainUsersCanEdit
|
Verdadeiro se qualquer pessoa no domínio do documento tiver acesso de edição ao intervalo protegido. A proteção de domínio só é compatível com documentos dentro de um domínio. |
BasicFilter
O filtro padrão associado a uma página.
Representação JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
O intervalo que o filtro abrange. |
sortSpecs[]
|
A ordem de classificação por coluna. Especificações posteriores são usadas quando os valores são iguais nas especificações anteriores. |
criteria
|
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 descontinuado em favor de
|
filterSpecs[]
|
Os critérios de filtro por coluna.
Tanto |
BandedRange
Um intervalo com faixas (cores alternadas) em uma planilha.
Representação JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
Campos | |
---|---|
bandedRangeId
|
O ID do intervalo com faixas. |
range
|
O intervalo em que essas propriedades são aplicadas. |
rowProperties
|
Propriedades para faixas de linha. Essas propriedades são aplicadas linha por linha em todas as linhas do intervalo. Pelo menos uma das seguintes propriedades:
|
columnProperties
|
Propriedades para faixas de colunas. Essas propriedades são aplicadas em cada coluna do intervalo. É necessário especificar |
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:
-
headerColor
efooterColor
têm prioridade sobre as cores da faixa. -
firstBandColor
tem precedência sobresecondBandColor
. -
rowProperties
tem prioridade sobrecolumnProperties
.
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 ( |
Campos | |
---|---|
headerColor
|
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
|
headerColorStyle
|
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
|
A primeira cor que está alternando. (Obrigatório) Descontinuado: use
|
firstBandColorStyle
|
A primeira cor que está alternando. (Obrigatório) Se
|
secondBandColor
|
É a segunda cor que é alternada. (Obrigatório) Descontinuado: use
|
secondBandColorStyle
|
É a segunda cor que é alternada. (Obrigatório) Se
|
footerColor
|
A cor da última linha ou coluna. Se esse campo não for definido, a última linha ou coluna será preenchida com
|
footerColorStyle
|
A cor da última linha ou coluna. Se esse campo não for definido, a última linha ou coluna será preenchida com
|
DimensionGroup
Um grupo em um intervalo de linhas ou colunas em uma planilha, que pode conter ou ser contido em outros grupos. Um grupo pode ser fechado ou aberto como uma unidade na planilha.
Representação JSON |
---|
{
"range": {
object ( |
Campos | |
---|---|
range
|
O intervalo em que este grupo existe. |
depth
|
A profundidade do grupo, que representa quantos grupos têm um intervalo que contém totalmente o intervalo desse grupo. |
collapsed
|
Este campo é verdadeiro se o grupo estiver fechado. Um grupo recolhido permanecerá recolhido 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 de 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 for falso. |
Controle de filtros
Um seletor em uma página.
Representação JSON |
---|
{ "slicerId": integer, "spec": { object ( |
Campos | |
---|---|
slicerId
|
O ID do seletor. |
spec
|
A especificação do controle de filtros. |
position
|
A posição do seletor. O seletor só pode ser posicionado na planilha atual. Além disso, a largura e a altura do fatiador podem ser ajustadas automaticamente para ficarem dentro dos limites permitidos. |
SlicerSpec
As especificações de um fatiador.
Representação JSON |
---|
{ "dataRange": { object ( |
Campos | |
---|---|
dataRange
|
O intervalo de dados do controle de filtros. |
filterCriteria
|
Os critérios de filtragem do seletor. |
columnIndex
|
O índice de coluna baseado em zero na tabela de dados em que o filtro é aplicado. |
applyToPivotTables
|
Verdadeiro se o filtro for aplicado a tabelas dinâmicas. Se não for definido, o padrão será
|
title
|
O título do seletor. |
textFormat
|
O formato de texto do título no seletor. O campo de link não é aceito. |
backgroundColor
|
A cor de fundo do seletor. Descontinuado: use
|
backgroundColorStyle
|
A cor de fundo do controle de filtros. Se
|
horizontalAlignment
|
O alinhamento horizontal do título no seletor. Se não for especificado, o padrão será
|