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)
  },
  "chipRuns": [
    {
      object (ChipRun)
    }
  ]
}
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 data/hora são representados como números de ponto flutuante de precisão dupla 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 atual.

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 contiver 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 anotação na célula.

textFormatRuns[]

object (TextFormatRun)

Execuções de rich text aplicadas a subseções da célula. As execuções só são válidas 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 herdam as propriedades da célula, a menos que sejam alteradas explicitamente.

Ao gravar, as novas execuções vão substituir as anteriores. Ao escrever 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.

Ao gravar, a nova regra de validação de dados vai substituir qualquer regra anterior.

pivotTable

object (PivotTable)

Uma tabela dinâmica ancorada nessa célula. O tamanho da tabela dinâmica é calculado de forma dinâmica com base nos dados, agrupamentos, filtros, valores etc. Somente a célula no canto superior esquerdo contém a definição da tabela dinâmica. As outras células vão conter os valores calculados dos resultados da rotação nos campos effectiveValue.

dataSourceTable

object (DataSourceTable)

Uma tabela de fonte de dados ancorada nessa célula. O tamanho da tabela da fonte de dados é calculado dinamicamente com base na configuração dela. Somente a primeira célula da tabela de fonte de dados contém a definição dela. 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 uma planilha DATA_SOURCE, por exemplo, =SUM(DataSheet!Column).

chipRuns[]

object (ChipRun)

Opcional. Execuções de ícones aplicados a subseções da célula. As propriedades de uma execução começam em um índice específico no texto e continuam até a próxima execução.

Ao ler, todas as execuções com e sem chip são incluídas. As corridas sem chip terão um Chip vazio.

Ao escrever, apenas as execuções com chips são incluídas. As execuções que contêm chips têm comprimento 1 e são representadas no texto inserido pelo usuário por um símbolo de marcador de posição "@". As novas execuções vão substituir as anteriores. Escrever um novo userEnteredValue vai apagar as execuções anteriores.

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 estiver 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 quebra de linha 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. Definir um link no nível da célula limpa os links atuais dela. 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 com base na localidade da planilha 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 en_US, mas o formato real depende da localidade da planilha.

Tipos enumerados
NUMBER_FORMAT_TYPE_UNSPECIFIED O formato do número não é especificado e se baseia 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 de data, por exemplo, 9/26/2008
TIME Formatação de hora, 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. 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.

Tipos enumerados
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 ao redor da célula, em pixels. Ao atualizar o padding, todos os campos precisam ser especificados.

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

integer

O padding da parte de cima da célula.

right

integer

O padding à direita da célula.

bottom

integer

O padding da parte de baixo da célula.

left

integer

O padding à esquerda da célula.

VerticalAlign

O alinhamento vertical do texto em uma célula.

Tipos enumerados
VERTICAL_ALIGN_UNSPECIFIED O alinhamento vertical não foi especificado. Não use isso.
TOP O texto é alinhado explicitamente à parte de cima da célula.
MIDDLE O texto está explicitamente alinhado ao centro da célula.
BOTTOM O texto está explicitamente alinhado à parte de baixo da célula.

WrapStrategy

Como ajustar o texto em uma célula.

Tipos enumerados
WRAP_STRATEGY_UNSPECIFIED O valor padrão. Não use.
OVERFLOW_CELL

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

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

Essa estratégia representa a antiga estratégia de quebra do Google Sheets, em que palavras maiores que uma linha são cortadas em vez de quebradas. Essa estratégia não é compatível com todas as plataformas e está sendo desativada. Exemplo: 

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

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

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

As palavras maiores que uma linha são quebradas 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.

Tipos enumerados
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 deve ser renderizado explicitamente. Se não for especificado, o hiperlink será vinculado.

Tipos enumerados
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 desejada. Medido em graus. Os valores válidos estão entre -90 e 90. Ângulos positivos são inclinados para cima, e ângulos negativos são inclinados para baixo.

Observação: para a direção do texto da esquerda para a direita, os ângulos positivos estão no sentido anti-horário. Já para a direita para a esquerda, eles estão no sentido horário.

vertical

boolean

Se for 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 execução. Ao atualizar, todos os campos precisam ser definidos.

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

integer

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

format

object (TextFormat)

O formato desta execução. 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 corresponder.

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 for 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 Google Sheets. Isso também é conhecido como "Extrair" no editor do Google Sheets.

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 a que a tabela de origem 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. O columnSelectionType precisa ser SELECTED.

filterSpecs[]

object (FilterSpec)

Filtre as especificações na tabela de fonte de dados.

sortSpecs[]

object (SortSpec)

Classifique as especificações na tabela da fonte de dados. O resultado da tabela de 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 ver o limite padrão e máximo.

dataExecutionStatus

object (DataExecutionStatus)

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

DataSourceTableColumnSelectionType

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

Tipos enumerados
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED O tipo de seleção de coluna padrão. Não use.
SELECTED Seleciona as colunas especificadas pelo campo columns.
SYNC_ALL

Sincronize 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 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 da execução de dados.

ChipRun

A execução de um chip. O chip continua até o índice inicial da próxima execução.

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

integer

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

chip

object (Chip)

Opcional. O ícone desta execução.

Ícone

O ícone inteligente.

Representação JSON 
{

  // Union field properties can be only one of the following:
  "personProperties": {
    object (PersonProperties)
  },
  "richLinkProperties": {
    object (RichLinkProperties)
  }
  // End of list of possible types for union field properties.
}
Campos
Campo de união properties. As propriedades do ícone. properties pode ser apenas um dos seguintes:
personProperties

object (PersonProperties)

Propriedades de uma pessoa vinculada.

PersonProperties

Propriedades específicas de uma pessoa vinculada.

Representação JSON 
{
  "email": string,
  "displayFormat": enum (DisplayFormat)
}
Campos
email

string

Obrigatório. O endereço de e-mail vinculado a essa pessoa. Esse campo está sempre presente.

displayFormat

enum (DisplayFormat)

Opcional. O formato de exibição do ícone de usuário. Se não for definido, o formato de exibição padrão será usado.

DisplayFormat

Formato de exibição preferido, quando disponível.

Tipos enumerados
DISPLAY_FORMAT_UNSPECIFIED Valor padrão. Não usar.
DEFAULT Formato de exibição padrão.
LAST_NAME_COMMA_FIRST_NAME Formato de exibição de sobrenome e nome.
EMAIL Formato de exibição de e-mail.

RichLinkProperties

Propriedades de um link para um recurso do Google, como um arquivo no Drive, um vídeo do YouTube, um endereço do Maps ou um evento do Google Agenda. Somente arquivos do Drive podem ser gravados como chips. Todos os outros tipos de links avançados são somente leitura.

Os URIs não podem exceder 2.000 bytes ao serem gravados.

OBSERVAÇÃO: para gravar ícones de arquivos do Drive, é necessário ter pelo menos um dos escopos do OAuth drive.file, drive.readonly ou drive.

Representação JSON 
{
  "uri": string,
  "mimeType": string
}
Campos
uri

string

Obrigatório. O URI do link. Esse campo está sempre presente.

mimeType

string

Apenas saída. O tipo MIME do link, se houver um (por exemplo, quando é um arquivo no Drive).