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 inserido pelo usuário na célula. Por exemplo, 1234, 'Hello' ou =NOW() Observação: datas, horários e DateTime são representados como duplas no formato 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 existente.

effectiveFormat

object (CellFormat)

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

note

string

Qualquer nota na célula.

textFormatRuns[]

object (TextFormatRun)

Execuções de rich text aplicadas a 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 gravar um novo userEnteredValue, as execuções anteriores são 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 tabela dinâmica é calculado dinamicamente com base nos dados, agrupamentos, filtros, valores etc. Somente a célula superior esquerda da tabela dinâmica contém a definição dela. As outras células vão conter os valores calculados dos resultados do resumo nos campos effectiveValue.

dataSourceTable

object (DataSourceTable)

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

dataSourceFormula

object (DataSourceFormula)

Apenas saída. Informações sobre uma fórmula de fonte de dados na célula. O campo é definido se userEnteredValue for uma fórmula que faz referência a alguma DATA_SOURCE de página, 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: use backgroundColorStyle.

backgroundColorStyle

object (ColorStyle)

A cor de fundo da célula. Se backgroundColor também for definido, este 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 união para o 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 seja substituído por uma execução de formatação). A configuração de um link no nível da célula limpa os links existentes da célula. Definir o campo de link em um TextFormatRun tem precedência sobre o link no nível da célula.

textRotation

object (TextRotation)

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

NumberFormat

O formato de número de uma célula.

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

enum (NumberFormatType)

O tipo do formato de número. Ao gravar, 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 o Guia de formatos de data e número para mais informações sobre os padrões aceitos.

NumberFormatType

O formato de número da célula. Nesta documentação, a localidade é considerada como 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 de porcentagem, 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 hora, por exemplo, 3:59:00 PM
DATE_TIME Formatação de data + hora, por exemplo, 9/26/08 15:59:00
SCIENTIFIC Formatação de número científico, 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. Descontinuado. A largura é determinada pelo campo "style".

color
(deprecated)

object (Color)

A cor da borda. Descontinuado: use colorStyle.

colorStyle

object (ColorStyle)

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

Estilo

O estilo de uma borda.

Enums
STYLE_UNSPECIFIED O estilo não foi especificado. Não use isso.
DOTTED A borda é pontilhada.
DASHED A borda é 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 apenas ao atualizar uma borda para apagá-la.
DOUBLE A borda é formada por duas linhas sólidas.

Padding

A quantidade de padding em torno 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 à direita da célula.

bottom

integer

O padding inferior 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 é alinhado explicitamente ao centro da célula.
BOTTOM O texto é explicitamente alinhado à parte de baixo 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 mais longas que a largura da célula serão gravadas na próxima célula vazia. Se a próxima célula não estiver vazia, o comportamento será o mesmo de CLIP. O texto nunca será quebrado 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 as palavras que são mais longas 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á quebrado 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

As palavras mais longas que uma linha são agrupadas no nível do caractere, em vez de serem 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

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 um dos seguintes:
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. Ângulos positivos são inclinados para cima, e negativos são inclinados 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 execução de um formato de texto. O formato dessa execução continua até o índice inicial da próxima. Ao atualizar, todos os campos precisam ser definidos.

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

integer

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

format

object (TextFormat)

O formato dessa 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 que os dados na célula precisam atender.

inputMessage

string

Uma mensagem para mostrar ao usuário ao adicionar dados à célula.

strict

boolean

Verdadeiro se os dados inválidos precisarem ser rejeitados.

showCustomUi

boolean

Verdadeiro se a interface precisar ser personalizada com base no tipo de condição. Se verdadeiro, as condições "Lista" vão mostrar um menu suspenso.

DataSourceTable

Uma tabela de fonte de dados que permite ao usuário importar uma tabela estática de dados do DataSource para o app 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 na tabela da origem de dados. O padrão é SELECTED.

columns[]

object (DataSourceColumnReference)

Colunas selecionadas para a tabela da fonte de dados. O 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 da origem 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 do Planilhas para conferir o limite 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 O tipo de seleção de coluna padrão, não use.
SELECTED Selecione as colunas especificadas pelo campo columns.
SYNC_ALL

Sincronize todas as colunas atuais e futuras na origem de dados.

Se definido, a tabela da fonte de dados busca todas as colunas da fonte de dados 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 associada à fórmula.

dataExecutionStatus

object (DataExecutionStatus)

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