Method: spreadsheets.get

Retorna a planilha no ID fornecido. O autor da chamada precisa especificar o ID da planilha.

Por padrão, dados dentro de grades não são retornados. É possível incluir dados de grade de duas maneiras:

  • Especifique uma máscara de campo listando os campos desejados usando o parâmetro de URL fields em HTTP

  • Defina o parâmetro de URL includeGridData como verdadeiro. Se uma máscara de campo for definida, o parâmetro includeGridData será ignorado.

Para planilhas grandes, como prática recomendada, recupere apenas os campos específicos da planilha que você deseja.

Para recuperar apenas subconjuntos de dados da planilha, use o parâmetro de URL ranges. Os intervalos são especificados usando a notação A1. Você pode definir uma única célula (por exemplo, A1) ou várias células (por exemplo, A1:D5). Você também pode acessar células de outras páginas na mesma planilha (por exemplo, Sheet2!A1:C4) ou recuperar vários intervalos de uma vez (por exemplo, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Limitar o intervalo retorna apenas as partes da planilha que cruzam os intervalos solicitados.

Solicitação HTTP

GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
spreadsheetId

string

A planilha a ser solicitada.

Parâmetros de consulta

Parâmetros
ranges[]

string

Os intervalos a recuperar da planilha.
includeGridData

boolean

Verdadeiro se for necessário retornar dados de grade. Esse parâmetro será ignorado se uma máscara de campo tiver sido definida na solicitação.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Spreadsheet.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.readonly

Para mais informações, consulte o Guia de autorização.