Method: spreadsheets.get

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

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

  • Especifique uma máscara de campo que liste os campos desejados usando o parâmetro de URL fields no 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, uma prática recomendada é recuperar apenas os campos específicos que você quer.

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. É possível definir uma única célula (por exemplo, A1) ou várias células (por exemplo, A1:D5). Também é possível acessar células de outras planilhas 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 se cruzam com 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 serem recuperados da planilha.
includeGridData

boolean

Verdadeiro se os dados da grade devem ser retornados. Esse parâmetro é ignorado se uma máscara de campo tiver sido definida na solicitação.
excludeTablesInBandedRanges

boolean

Verdadeiro se as tabelas precisam ser excluídas nos intervalos agrupados. Falso se não for definido.

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.