Method: spreadsheets.values.batchGet

Muestra uno o más rangos de valores de una hoja de cálculo. El emisor debe especificar el ID de la hoja de cálculo y uno o más rangos.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
spreadsheetId

string

El ID de la hoja de cálculo de la que se recuperarán los datos.

Parámetros de consulta

Parámetros
ranges[]

string

La notación A1 o notación R1C1 del rango del que se recuperarán los valores.

majorDimension

enum (Dimension)

Es la dimensión principal que se debe usar en los resultados.

Por ejemplo, si los datos de la hoja de cálculo son A1=1,B1=2,A2=3,B2=4, la solicitud de ranges=["A1:B2"],majorDimension=ROWS mostrará [[1,2],[3,4]], mientras que la solicitud de ranges=["A1:B2"],majorDimension=COLUMNS mostrará [[1,3],[2,4]].

valueRenderOption

enum (ValueRenderOption)

Cómo se deben representar los valores en el resultado. La opción de renderización predeterminada es ValueRenderOption.FORMATTED_VALUE.

dateTimeRenderOption

enum (DateTimeRenderOption)

Cómo se deben representar las fechas, las horas y las duraciones en el resultado Se ignora si valueRenderOption es FORMATTED_VALUE. La opción de renderización predeterminada de dateTime es SERIAL_NUMBER.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta cuando se recupera más de un rango de valores en una hoja de cálculo.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (ValueRange)
    }
  ]
}
Campos
spreadsheetId

string

El ID de la hoja de cálculo de la que se recuperaron los datos.

valueRanges[]

object (ValueRange)

Son los valores solicitados. El orden de los ValueRanges es el mismo que el de los rangos solicitados.

Alcances de autorización

Se necesita uno de los siguientes alcances de 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 obtener más información, consulta la guía de autorización.