Planilha
Uma página em uma planilha.
Representação JSON |
---|
{ "properties": { object ( |
Campos | |
---|---|
properties
|
As propriedades da página. |
data[]
|
Dados na grade, se for uma planilha.
O número de objetos GridData retornados depende do número de intervalos solicitados nessa página. Por exemplo, se isso representar
Para uma página |
merges[]
|
Os intervalos que foram mesclados. |
conditionalFormats[]
|
As regras de formatação condicional nesta página. |
filterViews[]
|
As visualizações com filtro nessa página. |
protectedRanges[]
|
Os intervalos protegidos nesta página. |
basicFilter
|
O filtro nessa página, se houver. |
charts[]
|
As especificações de cada gráfico nesta página. |
bandedRanges[]
|
As faixas (em cores alternadas) variam nesta página. |
developerMetadata[]
|
Os metadados do desenvolvedor associados a uma página. |
rowGroups[]
|
Todos os grupos de linhas desta página, ordenados de acordo com o aumento do índice inicial do intervalo e, em seguida, por profundidade do grupo. |
columnGroups[]
|
Todos os grupos de colunas nesta página, ordenados de acordo com o aumento do índice inicial e depois da profundidade de grupos. |
slicers[]
|
Os controles de filtros nesta página. |
Propriedades da página
Propriedades de uma página.
Representação JSON |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
Campos | |
---|---|
sheetId
|
O ID da página. Não podem ser negativas. Este campo não pode ser alterado depois de definido. |
title
|
O nome da página. |
index
|
O índice da página dentro da planilha. Ao adicionar ou atualizar propriedades da página, se esse campo for excluído, a página será adicionada ou movida para o final da lista de páginas. Ao atualizar índices de páginas ou inserir páginas, o movimento é considerado em índices "antes da movimentação". Por exemplo, se houvesse três páginas (S1, S2, S3) para mover S1 para a frente de S2, o índice teria que ser definido como 2. Uma solicitação de atualização do índice da página será ignorada se o índice solicitado for idêntico ao índice atual das páginas ou se o novo índice solicitado for igual ao índice da página atual + 1. |
sheetType
|
O tipo de página. O padrão é |
gridProperties
|
Propriedades adicionais da página caso esta seja uma grade. Se for uma planilha de objetos com um gráfico ou uma imagem, esse campo estará ausente. Ao escrever, é um erro definir qualquer propriedade de grade em páginas que não sejam de grade.
Se a página for uma |
tabColor
|
A cor da guia na IU. Obsoleto: use |
tabColorStyle
|
A cor da guia na IU. Se |
rightToLeft
|
Verdadeiro se a página for uma página RTL em vez de LTR. |
dataSourceSheetProperties
|
Apenas saída. Se presente, o campo contém propriedades específicas da página |
Tipo de planilha
O tipo de página.
Enums | |
---|---|
SHEET_TYPE_UNSPECIFIED
|
Valor padrão, não use. |
GRID
|
A página é uma grade. |
OBJECT
|
A página não tem grade e, em vez disso, tem um objeto como um gráfico ou uma imagem. |
DATA_SOURCE
|
A página se conecta a um DataSource externo e mostra a visualização dos dados.
|
PropriedadesDeGrade
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 que estão congeladas na grade. |
frozenColumnCount
|
O número de colunas que estão congeladas na grade. |
hideGridlines
|
Verdadeiro se a grade não estiver exibindo linhas de grade na IU. |
rowGroupControlAfter
|
Verdadeiro se o controle de agrupamento de linhas for exibido após o grupo. |
columnGroupControlAfter
|
Verdadeiro se a alternância do controle de agrupamento de colunas for exibida depois do grupo. |
DataSourceSheetProperties
Propriedades adicionais de uma página DATA_SOURCE
.
Representação JSON |
---|
{ "dataSourceId": string, "columns": [ { object ( |
Campos | |
---|---|
dataSourceId
|
O ID do |
columns[]
|
As colunas exibidas na página, correspondentes aos valores em |
dataExecutionStatus
|
O status de execução dos dados. |
Dados da grade
Dados na grade, bem como metadados sobre as dimensões.
Representação JSON |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
Campos | |
---|---|
startRow
|
A primeira linha a que este GridData se refere, com base em zero. |
startColumn
|
A primeira coluna a que este GridData se refere, com base em zero. |
rowData[]
|
Os dados na grade, uma entrada por linha, começando com a linha em startRow. Os valores em RowData corresponderão a colunas que começam em |
rowMetadata[]
|
Metadados sobre as linhas solicitadas na grade, começando com a linha em |
columnMetadata[]
|
Metadados sobre as colunas solicitadas na grade, começando com a coluna em |
Dados de linha
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 largura (se uma coluna) da dimensão em pixels. |
developerMetadata[]
|
Os metadados do desenvolvedor associados a uma única linha ou coluna. |
dataSourceColumnReference
|
Apenas saída. Se definida, esta será uma coluna em uma página de fonte de dados. |
Regra de formato condicional
Uma regra que descreve um formato condicional.
Representação JSON |
---|
{ "ranges": [ { object ( |
Campos | |
---|---|
ranges[]
|
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 precisa ser definida exatamente.
rule pode ser apenas uma das seguintes opções:
|
|
booleanRule
|
A formatação é "ativada" ou "desativada" de acordo com a regra. |
gradientRule
|
A formatação varia de acordo com os gradientes da regra. |
Regra booleana
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 aplicar. A formatação condicional só pode aplicar um subconjunto de formatação:
|
GradientRule
Uma regra que aplica um formato de escala de cores gradientes com base nos pontos de interpolação listados. O formato de uma célula varia de acordo com seu 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 intermediário opcional. |
maxpoint
|
O ponto de interpolação final. |
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 escolhido.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color
|
A cor que este ponto de interpolação deve usar. Obsoleto: use |
colorStyle
|
A cor que este ponto de interpolação deve usar. Se |
type
|
Como o valor deve ser interpretado. |
value
|
O valor usado por este ponto de interpolação. Pode ser uma fórmula. Não utilizado 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 sobre o intervalo do formato condicional. |
MAX
|
O ponto de interpolação usa o valor máximo nas células sobre o 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 fornecida sobre todas as células no intervalo do formato condicional. Isso será equivalente a |
PERCENTILE
|
O ponto de interpolação é o percentil fornecido sobre 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 erros no intervalo são ignorados durante o nivelamento).
|
Visualização de filtro
Uma visualização com filtro.
Representação JSON |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
Campos | |
---|---|
filterViewId
|
O ID da visualização com filtro. |
title
|
O nome da visualização com filtro. |
range
|
O intervalo abrangido por essa visualização de filtro.
Durante a gravação, é possível definir apenas um entre |
namedRangeId
|
O intervalo nomeado pelo qual esta visualização de filtro é apoiada, se houver.
Durante a gravação, é possível definir apenas um entre |
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. |
criteria
|
Os critérios para mostrar/ocultar valores por coluna. A chave do mapa é o índice da coluna, e o valor são os critérios dessa coluna.
Este campo está obsoleto e foi substituído por |
filterSpecs[]
|
Os critérios de filtro para mostrar/ocultar valores por coluna.
Tanto |
Intervalo protegido
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. Nesse caso, ele é considerado uma página protegida.
Durante a gravação, é possível definir apenas um entre |
namedRangeId
|
O intervalo nomeado pelo qual esse intervalo protegido é protegido, se houver.
Durante a gravação, é possível definir apenas um entre |
description
|
A descrição deste intervalo protegido. |
warningOnly
|
Verdadeiro se este intervalo protegido mostrar um aviso ao editar. A proteção baseada em avisos significa que todos os usuários podem editar dados no intervalo protegido, exceto quando a edição exibe um aviso pedindo que o usuário confirme a edição.
Durante a gravação: se este campo for verdadeiro, |
requestingUserCanEdit
|
Verdadeiro se o usuário que solicitou este intervalo protegido puder editar a área protegida. Este campo é somente leitura. |
unprotectedRanges[]
|
A lista de intervalos desprotegidos em uma página protegida. Intervalos não protegidos só são compatíveis com páginas protegidas. |
editors
|
Os usuários e grupos com acesso de edição ao intervalo protegido. Este campo só é visível para usuários com acesso para editar o intervalo protegido e o documento. Os editores não são compatíveis com 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 para edição ao intervalo protegido. |
groups[]
|
Os endereços de e-mail de grupos com acesso para edição ao intervalo protegido. |
domainUsersCanEdit
|
Verdadeiro se qualquer pessoa no domínio do documento tiver acesso para editar o intervalo protegido. A proteção de domínio só é compatível com documentos dentro de um domínio. |
Filtro básico
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. As 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 são os critérios dessa coluna.
Este campo está obsoleto e foi substituído por |
filterSpecs[]
|
Os critérios de filtro por coluna.
Tanto |
Cordilheira Banded
Um intervalo de faixas (em cores alternadas) em uma página.
Representação JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
Campos | |
---|---|
bandedRangeId
|
O ID do intervalo de faixas. |
range
|
O intervalo no qual essas propriedades são aplicadas. |
rowProperties
|
Propriedades das bandas de linha. Essas propriedades são aplicadas linha por linha em todas as linhas no intervalo. Pelo menos um entre |
columnProperties
|
Propriedades de faixas de colunas. Essas propriedades são aplicadas coluna por coluna em todas as colunas do intervalo. Pelo menos um entre |
Propriedades de banda
Propriedades que fazem referência 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 banda. -
firstBandColor
tem prioridade 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 terá prioridade sobre o cabeçalho da coluna na célula superior esquerda, mas o cabeçalho da coluna terá 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 este campo for definido, a primeira linha ou coluna será preenchida com essa cor, e as cores serão alternadas entre
|
headerColorStyle
|
A cor da primeira linha ou coluna. Se este campo for definido, a primeira linha ou coluna será preenchida com essa cor, e as cores serão alternadas entre
|
firstBandColor
|
A primeira cor alternada. Obrigatório: use |
firstBandColorStyle
|
A primeira cor alternada. (Obrigatório) Se |
secondBandColor
|
A segunda cor alternada. Obrigatório: use |
secondBandColorStyle
|
A segunda cor alternada. (Obrigatório) Se |
footerColor
|
A cor da última linha ou coluna. Se este campo não for definido, a última linha ou coluna será preenchida com |
footerColorStyle
|
A cor da última linha ou coluna. Se este campo não for definido, a última linha ou coluna será preenchida com |
Grupo de dimensões
Um grupo sobre um intervalo de linhas ou colunas em uma página, que pode conter ou estar contido em outros grupos. Um grupo pode ser recolhido ou expandido como uma unidade na página.
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
O intervalo no qual este grupo existe. |
depth
|
A profundidade do grupo, representando quantos grupos têm um intervalo que contém totalmente o intervalo desse grupo. |
collapsed
|
Este campo será verdadeiro se esse grupo estiver recolhido. Um grupo recolhido permanece recolhido se um grupo sobreposto em uma profundidade menor for expandido. Um valor verdadeiro não significa que todas as dimensões do grupo estão ocultas, pois a visibilidade de uma dimensão pode ser alterada independentemente da propriedade do grupo. No entanto, quando esta propriedade for atualizada, todas as dimensões dentro dela serã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 ( |
Campos | |
---|---|
slicerId
|
É o ID do controle de filtros. |
spec
|
A especificação do controle de filtros. |
position
|
A posição do controle de filtros. O controle de filtros só pode ser posicionado na página 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 ( |
Campos | |
---|---|
dataRange
|
É o intervalo de dados do controle de filtros. |
filterCriteria
|
Os critérios de filtragem do controle de filtros. |
columnIndex
|
O índice de coluna com base em zero na tabela de dados à qual o filtro é aplicado. |
applyToPivotTables
|
Verdadeiro se o filtro for aplicável a tabelas dinâmicas. Se não for definido, o padrão será |
title
|
O título do controle de filtros. |
textFormat
|
O formato de texto do título no controle de filtros. O campo de link não é compatível. |
backgroundColor
|
É a cor do plano de fundo do controle de filtros. Obsoleto: use |
backgroundColorStyle
|
É a cor do plano de fundo do controle de filtros. Se |
horizontalAlignment
|
O alinhamento horizontal do título no controle de filtros. Se não for especificado, o padrão será |