Visão geral da API Google Sheets

A API Google Sheets é uma interface RESTful que permite ler e modificar os dados de uma planilha. Os usos mais comuns dessa API incluem as seguintes tarefas:

  • Criar planilhas
  • Ler e gravar valores de célula da planilha
  • Atualizar formatação da planilha
  • Gerenciar as páginas conectadas

Veja abaixo uma lista de termos comuns usados na API Sheets:

Planilha

O objeto principal nas Planilhas Google que pode conter várias páginas, cada uma com informações estruturadas contidas nas células. Um recurso de planilha representa cada planilha e tem um valor spreadsheetId exclusivo, contendo letras, números, hifens ou sublinhados. Você pode encontrar o ID da planilha em um URL do Planilhas Google:

https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0

Página

Uma página ou guia em uma planilha. Um recurso da planilha representa cada página e tem um título exclusivo e um valor numérico de sheetId. É possível encontrar o ID da planilha em um URL do Planilhas Google:

https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId

Célula

Um campo individual de texto ou dados em uma planilha. As células são organizadas em linhas e colunas e podem ser agrupadas como um intervalo de células. Um recurso CellData representa cada célula, mas não tem um valor de ID exclusivo. Em vez disso, as coordenadas de linha e coluna identificam as células.

Notação A1

Uma sintaxe usada para definir uma célula ou intervalo de células com uma string que contém o nome da página, além das coordenadas inicial e final da célula usando letras de coluna e números de linha. Esse método é o mais comum e útil ao referenciar um intervalo absoluto de células.

Mostrar exemplos

  • Sheet1!A1:B2 refere-se às duas primeiras células das duas primeiras linhas da Sheet1.
  • Sheet1!A:A refere-se a todas as células da primeira coluna da Sheet1.
  • Sheet1!1:2 refere-se a todas as células nas duas primeiras linhas da Sheet1.
  • Sheet1!A5:A refere-se a todas as células da primeira coluna da Planilha 1, da linha 5 em diante.
  • A1:B2 refere-se às duas primeiras células nas duas primeiras linhas da primeira página visível.
  • Sheet1 refere-se a todas as células da Sheet1.
  • 'My Custom Sheet'!A:A refere-se a todas as células da primeira coluna de uma página chamada "Minha planilha personalizada". As aspas simples são obrigatórias para nomes de páginas com espaços, caracteres especiais ou uma combinação alfanumérica.
  • 'My Custom Sheet' refere-se a todas as células em "Minha planilha personalizada".

Dica: sempre que possível, use nomes diferentes para os objetos nas planilhas. Por exemplo, A1 se refere à célula A1 na primeira página visível, enquanto "A1" se refere a todas as células de uma planilha chamada A1. Da mesma forma, Sheet1 refere-se a todas as células da Sheet1. No entanto, se houver um intervalo nomeado "Sheet1", ele vai se referir ao intervalo nomeado e "Sheet1" vai se referir à planilha.
Notação R1C1

Uma sintaxe usada para definir uma célula ou intervalo de células com uma string que contém o nome da página, além das coordenadas inicial e final da célula usando números de linha e de coluna. Esse método é menos comum do que a notação A1, mas pode ser útil ao referenciar um intervalo de células em relação à posição de uma determinada célula.

Mostrar exemplos

  • Sheet1!R1C1:R2C2 refere-se às duas primeiras células das duas primeiras linhas da Sheet1.
  • R1C1:R2C2 refere-se às duas primeiras células nas duas primeiras linhas da primeira página visível.
  • Sheet1!R[3]C[1] refere-se à célula que está três linhas abaixo e a uma coluna à direita da célula atual.
Intervalo nomeado

Uma célula ou intervalo de células definido com um nome personalizado para simplificar referências em todo um aplicativo. Um recurso FilterView representa um intervalo nomeado.

Intervalo protegido

Uma célula ou intervalo de células definido que não pode ser modificado. Um recurso ProtectedRange representa um intervalo protegido.

Próximas etapas