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 de planilhas
  • Atualizar a formatação da planilha
  • Gerenciar páginas conectadas

Confira a seguir uma lista de termos comuns usados na API Sheets:

Planilha

O objeto principal nas 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 e pode ser derivada do URL dela. Os IDs de 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
Planilha

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 uma planilha title como parte do objeto SheetProperties.

ID da planilha
O identificador exclusivo de uma página específica em uma planilha. É uma string específica que contém letras, números e alguns caracteres especiais que fazem referência a uma planilha e pode ser derivada do URL da planilha. Os IDs de planilha são estáveis, mesmo que o nome da planilha mude. Para conferir um 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 e as coordenadas da célula inicial e final usando letras de coluna e números de linha. Esse método é o mais comum e útil ao fazer referência a um intervalo absoluto de células.

Mostrar exemplos

  • Sheet1!A1:B2 se refere a todas as células nas duas primeiras linhas e colunas da planilha 1.
  • Sheet1!A:A se refere a todas as células da primeira coluna da Página1.
  • Sheet1!1:2 faz referência a todas as células nas duas primeiras linhas da Página1.
  • Sheet1!A5:A faz referência a todas as células da primeira coluna da Página 1, a partir da linha 5.
  • A1:B2 faz referência a todas as células das duas primeiras linhas e colunas da primeira página visível.
  • Sheet1 faz referência a todas as células da Página1.
  • 'Jon's_Data'!A1:D5 se refere a todas as células das cinco primeiras linhas e quatro colunas de uma planilha chamada "Dados_de_João".
  • '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 necessárias para nomes de planilhas com espaços, caracteres especiais ou uma combinação alfanumérica.

Dica: sempre que possível, use nomes distintos para objetos nas planilhas. Por exemplo, A1 (sem aspas) se refere à célula A1 na primeira página visível. 'A1' se refere a uma planilha com o nome A1. Da mesma forma, "Sheet1" se refere a uma planilha com o nome "Sheet1". No entanto, se houver um intervalo nomeado com o título "Planilha1", "Planilha1" se refere ao intervalo nomeado e 'Sheet1' se refere à 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 e as coordenadas da célula inicial e final 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 a uma determinada posição da célula.

Mostrar exemplos

  • Sheet1!R1C1:R2C2 faz referência às duas primeiras células das duas primeiras linhas da planilha 1.
  • R1C1:R2C2 faz referência às duas primeiras células das duas primeiras linhas da primeira página 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 definido que não pode ser modificado. Um recurso ProtectedRange representa um intervalo protegido.