Cells

CellData

Dados sobre uma célula específica.

Representação JSON
{
  "userEnteredValue": {
    object (ExtendedValue)
  },
  "effectiveValue": {
    object (ExtendedValue)
  },
  "formattedValue": string,
  "userEnteredFormat": {
    object (CellFormat)
  },
  "effectiveFormat": {
    object (CellFormat)
  },
  "hyperlink": string,
  "note": string,
  "textFormatRuns": [
    {
      object (TextFormatRun)
    }
  ],
  "dataValidation": {
    object (DataValidationRule)
  },
  "pivotTable": {
    object (PivotTable)
  },
  "dataSourceTable": {
    object (DataSourceTable)
  },
  "dataSourceFormula": {
    object (DataSourceFormula)
  }
}
Campos
userEnteredValue

object (ExtendedValue)

O valor que o usuário inseriu na célula. Por exemplo: 1234, 'Hello' ou =NOW() Observação: Datas, Times e DateTimes são representados como duplos em serial number .

effectiveValue

object (ExtendedValue)

O valor efetivo da célula. Para células com fórmulas, esse é o valor calculado. Para células com literais, é o mesmo que userEnteredValue. Este campo é somente leitura.

formattedValue

string

O valor formatado da célula. É o valor mostrado ao usuário. Este campo é somente leitura.

userEnteredFormat

object (CellFormat)

O formato que o usuário inseriu para a célula.

Ao gravar, o novo formato será mesclado com o formato atual.

effectiveFormat

object (CellFormat)

O formato efetivo sendo usado pela célula. Isso inclui os resultados da aplicação de qualquer formatação condicional e, se a célula contiver uma fórmula, o formato de número calculado. Se o formato efetivo for o padrão, o formato efetivo não será gravado. Este campo é somente leitura.

note

string

Qualquer nota na célula.

textFormatRuns[]

object (TextFormatRun)

Execuções de rich text aplicadas às subseções da célula. As execuções são válidas apenas em strings inseridas pelo usuário, não em fórmulas, booleanos ou números. As propriedades de uma execução começam em um índice específico no texto e continuam até a próxima execução. As execuções herdarão as propriedades da célula, a menos que sejam alteradas explicitamente.

Ao gravar, as novas execuções substituem as anteriores. Ao escrever um novo userEnteredValue, execuções anteriores foram apagadas.

dataValidation

object (DataValidationRule)

Uma regra de validação de dados na célula, se houver.

Durante a gravação, a nova regra de validação de dados vai substituir qualquer regra anterior.

pivotTable

object (PivotTable)

Uma tabela dinâmica ancorada nesta célula. O tamanho da própria tabela dinâmica é calculado dinamicamente com base em seus dados, agrupamento, filtros, valores etc. Somente a célula no canto superior esquerdo da tabela dinâmica contém a definição da tabela dinâmica. As outras células conterão os valores calculados dos resultados da tabela dinâmica em suas effectiveValue campos.

dataSourceTable

object (DataSourceTable)

Uma tabela de fonte de dados ancorada nesta célula. O tamanho da própria tabela de fonte de dados é calculado dinamicamente com base na configuração. Somente a primeira célula da tabela de fonte de dados contém a definição dela. As outras células conterão os valores de exibição do resultado da tabela de fonte de dados em seu effectiveValue campos.

dataSourceFormula

object (DataSourceFormula)

Apenas saída. Informações sobre uma fórmula de fonte de dados na célula. O campo é definido se userEnteredValue é uma fórmula que referencia algumas DATA_SOURCE planilha, por exemplo, =SUM(DataSheet!Column)

CellFormat

O formato de uma célula.

Representação JSON
{
  "numberFormat": {
    object (NumberFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "borders": {
    object (Borders)
  },
  "padding": {
    object (Padding)
  },
  "horizontalAlignment": enum (HorizontalAlign),
  "verticalAlignment": enum (VerticalAlign),
  "wrapStrategy": enum (WrapStrategy),
  "textDirection": enum (TextDirection),
  "textFormat": {
    object (TextFormat)
  },
  "hyperlinkDisplayType": enum (HyperlinkDisplayType),
  "textRotation": {
    object (TextRotation)
  }
}
Campos
numberFormat

object (NumberFormat)

Um formato que descreve como os valores numéricos devem ser representados para o usuário.

backgroundColor
(deprecated)

object (Color)

A cor de fundo da célula. Descontinuado: uso backgroundColorStyle:

backgroundColorStyle

object (ColorStyle)

A cor de fundo da célula. Se backgroundColor também for definido, esse campo terá precedência.

borders

object (Borders)

As bordas da célula.

padding

object (Padding)

O padding da célula.

horizontalAlignment

enum (HorizontalAlign)

O alinhamento horizontal do valor na célula.

verticalAlignment

enum (VerticalAlign)

O alinhamento vertical do valor na célula.

wrapStrategy

enum (WrapStrategy)

A estratégia de ajuste do valor na célula.

textDirection

enum (TextDirection)

A direção do texto na célula.

textFormat

object (TextFormat)

O formato do texto na célula (a menos que substituído por uma execução de formato). Definir um link no nível da célula aqui limpa os links existentes na célula. Definir o campo do link em uma TextFormatRun tem precedência sobre o link em nível de célula.

textRotation

object (TextRotation)

A rotação aplicada ao texto na célula.

NumberFormat

O formato numérico de uma célula.

Representação JSON
{
  "type": enum (NumberFormatType),
  "pattern": string
}
Campos
type

enum (NumberFormatType)

O tipo de formato de número. Ao escrever, esse campo precisa ser definido.

pattern

string

String de padrão usada para formatação. Se não for definido, um padrão padrão baseado na localidade do usuário será usado, se necessário, para o tipo especificado. Consulte a Guia de formatos de data e número para mais informações sobre os padrões compatíveis.

NumberFormatType

O formato numérico da célula. Nesta documentação, a localidade é considerada en_US, mas o formato real depende da localidade da planilha.

Enums
NUMBER_FORMAT_TYPE_UNSPECIFIED O formato do número não é especificado e é baseado no conteúdo da célula. Não use isso explicitamente.
TEXT Formatação de texto, por exemplo 1000.12
NUMBER Formatação de números, por exemplo, 1,000.12
PERCENT Formatação percentual, por exemplo 10.12%
CURRENCY Formatação de moeda, por exemplo, $1,000.12
DATE Formatação da data, por exemplo, 9/26/2008
TIME Formatação de tempo, por exemplo, 3:59:00 PM
DATE_TIME Formatação de data e hora, por exemplo 9/26/08 15:59:00
SCIENTIFIC Formatação de números científicos, por exemplo, 1.01E+03

Bordas

As bordas da célula.

Representação JSON
{
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  }
}
Campos
top

object (Border)

A borda superior da célula.

bottom

object (Border)

A borda inferior da célula.

left

object (Border)

A borda esquerda da célula.

right

object (Border)

A borda direita da célula.

Borda

Uma borda ao longo de uma célula.

Representação JSON
{
  "style": enum (Style),
  "width": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
Campos
style

enum (Style)

O estilo da borda.

width
(deprecated)

integer

A largura da borda, em pixels. Obsoleto. a largura é determinada pelo "estilo" .

color
(deprecated)

object (Color)

A cor da borda. Descontinuado: uso colorStyle:

colorStyle

object (ColorStyle)

A cor da borda. Se color também for definido, esse campo terá precedência.

Estilo

O estilo de uma borda.

Enums
STYLE_UNSPECIFIED O estilo não está especificado. Não use isso.
DOTTED A borda é pontilhada.
DASHED A borda está tracejada.
SOLID A borda é uma linha sólida fina.
SOLID_MEDIUM A borda é uma linha sólida média.
SOLID_THICK A borda é uma linha sólida grossa.
NONE Sem borda. Usado somente ao atualizar uma borda para apagá-la.
DOUBLE A borda é composta por duas linhas sólidas.

Padding

A quantidade de padding ao redor da célula, em pixels. Ao atualizar o preenchimento, todos os campos precisam ser especificados.

Representação JSON
{
  "top": integer,
  "right": integer,
  "bottom": integer,
  "left": integer
}
Campos
top

integer

O padding superior da célula.

right

integer

O padding direito da célula.

bottom

integer

O padding da parte de baixo da célula.

left

integer

O padding esquerdo da célula.

VerticalAlign

O alinhamento vertical do texto em uma célula.

Enums
VERTICAL_ALIGN_UNSPECIFIED O alinhamento vertical não foi especificado. Não use isso.
TOP O texto é explicitamente alinhado à parte superior da célula.
MIDDLE O texto é explicitamente alinhado ao meio da célula.
BOTTOM O texto é explicitamente alinhado à parte inferior da célula.

WrapStrategy

Como ajustar o texto em uma célula.

Enums
WRAP_STRATEGY_UNSPECIFIED O valor padrão, não use.
OVERFLOW_CELL

As linhas que forem maiores que a largura da célula serão escritas na célula seguinte, desde que essa célula esteja vazia. Se a próxima célula não estiver vazia, o comportamento será o mesmo que CLIP: O texto nunca será ajustado para a próxima linha, a menos que o usuário insira manualmente uma nova linha. Exemplo:

| First sentence. |
| Manual newline that is very long. <- Text continues into next cell
| Next newline.   |
LEGACY_WRAP

Essa estratégia de quebra de linha representa a antiga estratégia das Planilhas Google, em que palavras maiores que uma linha são cortadas, e não quebradas. Essa estratégia não está disponível em todas as plataformas e será desativada. Exemplo:

| Cell has a |
| loooooooooo| <- Word is clipped.
| word.      |
CLIP

As linhas que forem maiores que a largura da célula serão cortadas. O texto nunca será ajustado para a próxima linha, a menos que o usuário insira manualmente uma nova linha. Exemplo:

| First sentence. |
| Manual newline t| <- Text is clipped
| Next newline.   |
WRAP

Palavras que são maiores que uma linha são quebradas no nível dos caracteres, e não cortadas. Exemplo:

| Cell has a |
| loooooooooo| <- Word is broken.
| ong word.  |

TextDirection

A direção do texto em uma célula.

Enums
TEXT_DIRECTION_UNSPECIFIED A direção do texto não foi especificada. Não use isso.
LEFT_TO_RIGHT A direção do texto da esquerda para a direita foi definida pelo usuário.
RIGHT_TO_LEFT A direção do texto da direita para a esquerda foi definida pelo usuário.

HyperlinkDisplayType

Define se um hiperlink será renderizado explicitamente. Se não for especificado, o hiperlink será vinculado.

Enums
LINKED Um hiperlink precisa ser renderizado explicitamente.
PLAIN_TEXT Um hiperlink não deve ser renderizado.

TextRotation

A rotação aplicada ao texto em uma célula.

Representação JSON
{

  // Union field type can be only one of the following:
  "angle": integer,
  "vertical": boolean
  // End of list of possible types for union field type.
}
Campos
Campo de união type: O tipo de rotação, vertical ou angular. type pode ser apenas uma das seguintes opções:
angle

integer

O ângulo entre a orientação padrão e a orientação desejada. Medida em graus. Os valores válidos estão entre -90 e 90. Os ângulos positivos são inclinados para cima, e os negativos, para baixo.

Observação: para a direção do texto LTR, os ângulos positivos estão no sentido anti-horário. Para RTL, eles estão no sentido horário.

vertical

boolean

Se verdadeiro, o texto será lido de cima para baixo, mas a orientação dos caracteres individuais não será alterada. Exemplo:

| V |
| e |
| r |
| t |
| i |
| c |
| a |
| l |

TextFormatRun

Uma sequência de formato de texto. O formato dessa execução continua até o índice inicial da próxima execução. Ao atualizar, todos os campos devem ser definidos.

Representação JSON
{
  "startIndex": integer,
  "format": {
    object (TextFormat)
  }
}
Campos
startIndex

integer

O índice de caracteres baseado em zero em que a execução começa, em unidades de código UTF-16.

format

object (TextFormat)

O formato desta execução. Os valores ausentes herdam o formato da célula.

DataValidationRule

Uma regra de validação de dados.

Representação JSON
{
  "condition": {
    object (BooleanCondition)
  },
  "inputMessage": string,
  "strict": boolean,
  "showCustomUi": boolean
}
Campos
condition

object (BooleanCondition)

A condição à qual os dados na célula precisam corresponder.

inputMessage

string

Uma mensagem a ser mostrada ao usuário quando você adicionar dados à célula.

strict

boolean

Verdadeiro se os dados inválidos forem rejeitados.

showCustomUi

boolean

Verdadeiro se a interface precisar ser personalizada com base no tipo de condição. Se verdadeiro, "List" condições exibirá uma lista suspensa.

DataSourceTable

Uma tabela de fonte de dados, que permite ao usuário importar uma tabela estática de dados da DataSource para o Planilhas. Isso também é conhecido como "Extrair", no editor do Planilhas.

Representação JSON
{
  "dataSourceId": string,
  "columnSelectionType": enum (DataSourceTableColumnSelectionType),
  "columns": [
    {
      object (DataSourceColumnReference)
    }
  ],
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "rowLimit": integer,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Campos
dataSourceId

string

O ID da fonte de dados à qual a tabela de fonte de dados está associada.

columnSelectionType

enum (DataSourceTableColumnSelectionType)

O tipo para selecionar colunas da tabela de fonte de dados. O padrão é SELECTED:

columns[]

object (DataSourceColumnReference)

Colunas selecionadas para a tabela de fonte de dados. A columnSelectionType precisa ser SELECTED.

filterSpecs[]

object (FilterSpec)

Especificações de filtro na tabela da fonte de dados.

sortSpecs[]

object (SortSpec)

Classifique as especificações na tabela da fonte de dados. O resultado da tabela de fonte de dados é classificado com base nas especificações de classificação em ordem.

rowLimit

integer

O limite de linhas a serem retornadas. Se não for definido, um limite padrão será aplicado. Consulte o editor das Planilhas para conferir os limites padrão e máximo.

dataExecutionStatus

object (DataExecutionStatus)

Apenas saída. O status de execução dos dados.

DataSourceTableColumnSelectionType

Os tipos de seleção de coluna da tabela de fonte de dados.

Enums
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED Não use o tipo de seleção de coluna padrão.
SELECTED Selecionar colunas especificadas por columns .
SYNC_ALL

Sincronizar todas as colunas atuais e futuras na fonte de dados.

Se definido, a tabela da fonte de dados vai buscar todas as colunas na fonte no momento da atualização.

DataSourceFormula

Uma fórmula de fonte de dados.

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

string

O ID da fonte de dados à qual a fórmula está associada.

dataExecutionStatus

object (DataExecutionStatus)

Apenas saída. O status de execução dos dados.