Method: spreadsheets.values.batchGet

Retorna um ou mais intervalos de valores de uma planilha. O autor da chamada precisa especificar o ID da planilha e um ou mais intervalos.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
spreadsheetId

string

O ID da planilha da qual os dados serão recuperados.

Parâmetros de consulta

Parâmetros
ranges[]

string

A notação A1 ou R1C1 do intervalo do qual os valores serão recuperados.
majorDimension

enum (Dimension)

A dimensão principal que os resultados devem usar.

Por exemplo, se os dados da planilha forem: A1=1,B1=2,A2=3,B2=4, a solicitação de ranges=["A1:B2"],majorDimension=ROWS retornará [[1,2],[3,4]], enquanto a solicitação de ranges=["A1:B2"],majorDimension=COLUMNS retornará [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

Como os valores são representados na saída. A opção de renderização padrão é ValueRenderOption.FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Como datas, horas e durações são representadas na saída. Isso será ignorado se valueRenderOption for FORMATTED_VALUE. A opção de renderização dateTime padrão é SERIAL_NUMBER.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta ao recuperar mais de um intervalo de valores em uma planilha.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (ValueRange)
    }
  ]
}
Campos
spreadsheetId

string

O ID da planilha da qual os dados foram recuperados.
valueRanges[]

object (ValueRange)

Os valores solicitados. A ordem de ValueRanges é a mesma dos intervalos solicitados.

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.