Visão geral da API Google Sheets

A API Google Sheets é uma interface RESTful que permite ler e modificar os dados de uma planilha. Com a API Sheets, você pode:

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

Confira uma lista de termos comuns usados na API Google Sheets:

Planilha

O objeto principal no Planilhas Google. Ele pode conter vários Sheets, cada um com informações estruturadas contidas em Cells. O recurso spreadsheets representa uma planilha. Ele contém um valor spreadsheetId exclusivo.

ID da planilha
O identificador exclusivo de uma planilha. É uma string específica que contém letras, números e alguns caracteres especiais que fazem referência a uma planilha. Ela pode ser derivada do URL da planilha. Os IDs das planilhas são estáveis, mesmo que o nome delas mude.
https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit?gid=SHEET_ID#gid=SHEET_ID
Página

Uma página ou guia em uma planilha. O recurso Sheets representa uma página. Ele contém um valor numérico sheetId exclusivo e title da planilha como parte do objeto SheetProperties.

ID da planilha
O identificador exclusivo de uma planilha específica. É um número inteiro específico que contém números que fazem referência a uma planilha e pode ser derivado do URL dela. Os IDs das planilhas são estáveis, mesmo que o nome delas mude. Por exemplo, consulte ID da planilha.
Cell

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. O recurso Cells 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 um intervalo de células com uma string que contém o nome da planilha mais as coordenadas das células inicial e final 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.
  • Sheet1!A1:B2 se refere a todas as células nas duas primeiras linhas e colunas da Sheet1.
  • Sheet1!A:A se refere a todas as células na primeira coluna da Sheet1.
  • Sheet1!1:2 se refere a todas as células nas duas primeiras linhas da Sheet1.
  • Sheet1!A5:A se refere a todas as células da primeira coluna da Sheet1, da linha 5 em diante.
  • A1:B2 se refere a todas as células nas duas primeiras linhas e colunas da primeira página visível.
  • Sheet1 se refere a todas as células na Sheet1.
  • 'Jon's_Data'!A1:D5 se refere a todas as células nas cinco primeiras linhas e quatro colunas de uma planilha chamada "Jon's_Data".
  • 'My Custom Sheet'!A:A se refere a todas as células da primeira coluna de uma planilha chamada "Minha planilha personalizada".
  • 'My Custom Sheet' se refere a todas as células em "Minha planilha personalizada".

As aspas simples são obrigatórias para nomes de planilhas com espaços ou caracteres especiais.

Dica: sempre que possível, use nomes diferentes para objetos nas suas planilhas. Por exemplo, A1 (sem aspas) se refere à célula A1 na primeira planilha visível. 'A1' se refere a uma página com o nome A1. Da mesma forma, "Página1" se refere a uma planilha com o nome "Página1". No entanto, se houver um intervalo nomeado chamado "Planilha1", "Planilha1" se referirá ao intervalo nomeado, e 'Sheet1' se referirá à planilha.

Notação R1C1
Uma sintaxe usada para definir uma célula ou um intervalo de células com uma string que contém o nome da planilha mais as coordenadas das células inicial e final usando números de linha e 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 célula específica.
  • Sheet1!R1C1:R2C2 se refere às duas primeiras células nas duas primeiras linhas da Sheet1.
  • R1C1:R2C2 se refere às duas primeiras células nas duas primeiras linhas da primeira planilha visível.
  • Sheet1!R[3]C[1] se refere à célula que está três linhas abaixo e uma coluna à direita da célula atual.
Intervalo nomeado
Uma célula ou um intervalo de células definido com um nome personalizado para simplificar as referências em um aplicativo. Um recurso FilterView representa um intervalo nomeado.
Intervalo protegido
Uma célula ou um intervalo de células definidos que não podem ser modificados. Um recurso ProtectedRange representa um intervalo protegido.