Lectura básica

La API de Hojas de cálculo de Google te permite leer valores de celdas, rangos, conjuntos de rangos, y hojas enteras. Los ejemplos de esta página ilustran algunas prácticas de lectura operaciones con el spreadsheets.values recurso. También puedes leer los valores de las celdas con el spreadsheets.get, pero generalmente spreadsheets.values.get o spreadsheets.values.batchGet es más fácil.

Estos ejemplos se presentan en forma de solicitudes HTTP como lenguaje neutrales. Para aprender a implementar operaciones de lectura en diferentes idiomas con la API de Google API de cliente, consulta Leer y escribir celda de salida.

En estos ejemplos, el marcador de posición SPREADSHEET_ID indica dónde debería proporcionar el ID de la hoja de cálculo que se puede descubrir en la URL de la hoja de cálculo. Los rangos para leer son especificar con notación A1 en la solicitud URL. Un rango de ejemplo es Hoja1!A1:D5.

Datos de origen

Para estos ejemplos, supongamos que la hoja de cálculo que se está leyendo tiene la siguiente fuente: datos en su primera hoja ("Sheet1"). Las cadenas de la primera fila son etiquetas para las columnas individuales. Para ver ejemplos de cómo leer de otras hojas en para tu hoja de cálculo, consulta Notación A1.

	A	B	C	D
1	Elemento	Costo	Almacenado	Fecha de envío
2	Rueda de la fortuna	USD 20.50	4	1/3/2016
3	Puerta	$15	2	15/3/2016
4	Motor	USD 100	1	20/3/2016
5	Totales	USD 135.5	7	20/3/2016

Cómo leer un solo rango

Lo siguiente spreadsheets.values.get muestra de código muestra cómo leer los valores del rango Sheet1!A1:D5 y devuelve en la respuesta. Se omiten las filas y columnas finales que estén vacías.

Aquí se muestra el protocolo de solicitud.

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5

La respuesta consta de un ValueRange que describe los valores de rango. El Campo majorDimension indica que los arrays son listas de valores organizadas por filas.

{
  "range": "Sheet1!A1:D5",
  "majorDimension": "ROWS",
  "values": [
    ["Item", "Cost", "Stocked", "Ship Date"],
    ["Wheel", "$20.50", "4", "3/1/2016"],
    ["Door", "$15", "2", "3/15/2016"],
    ["Engine", "$100", "1", "30/20/2016"],
    ["Totals", "$135.5", "7", "3/20/2016"]
  ],
}

Cómo leer un solo rango agrupado por columna

Lo siguiente spreadsheets.values.get la muestra de código muestra cómo leer los valores del rango Sheet1!A1:D3 y devuelve con ellos en la respuesta, pero agrupados por columna. Las filas y columnas finales vacías se omitido.

Aquí se muestra el protocolo de solicitud.

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D3?majorDimension=COLUMNS

La respuesta consta de un ValueRange que describe los valores de rango. El Campo majorDimension indica que los arrays son listas de valores organizadas por columnas.

{
  "range": "Sheet1!A1:D3",
  "majorDimension": "COLUMNS",
  "values": [
    ["Item", "Wheel", "Door"],
    ["Cost", "$20.50", "$15"],
    ["Stocked", "4", "2"],
    ["Ship Date", "3/1/2016", "3/15/2016"]
  ],
}

Cómo leer un solo rango con opciones de renderización

Lo siguiente spreadsheets.values.get muestra de código muestra cómo leer los valores del rango Sheet1!A1:D5 y devuelve en la respuesta, pero usa opciones de renderización para administrar cómo esa información el resultado. El Parámetro de configuración de ValueRenderOption de FORMULA indica que las fórmulas se deben mostrar en lugar de el valor calculado y el DateTimeRenderOption la configuración de SERIAL_NUMBER indica que las fechas se deben mostrar como números. También es posible usar otras opciones de configuración. Las filas y columnas finales vacías se omitido.

Aquí se muestra el protocolo de solicitud.

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5?
            valueRenderOption=FORMULA&dateTimeRenderOption=SERIAL_NUMBER

La respuesta consta de un ValueRange que describe los valores de rango. El Campo majorDimension indica que los arrays son listas de valores organizadas por filas.

{
  "range": "Sheet1!A1:D5",
  "majorDimension": "ROWS",
  "values": [
    ["Item", "Cost", "Stocked", "Ship Date"],
    ["Wheel", "$20.50", "4", "42430"],
    ["Door", "$15", "2", "42444"],
    ["Engine", "$100", "1", "42449"],
    ["Totals", "=SUM(B2:B4)", "=SUM(C2:C4)", "=MAX(D2:D4)"]
  ],
}

Leer varios rangos

Lo siguiente spreadsheets.values.batchGet de código muestra cómo leer valores de los rangos Sheet1!B:B y Sheet1!D:D y los devuelve en la respuesta. El Parámetro de configuración de ValueRenderOption de UNFORMATTED_VALUE indica que los valores se calculan, pero no se formatean en la respuesta. Se omiten las filas y columnas finales que estén vacías.

Aquí se muestra el protocolo de solicitud.

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values:batchGet?
            ranges=Sheet1!B:B&ranges=Sheet1!D:D&valueRenderOption=UNFORMATTED_VALUE&majorDimension=COLUMNS

La respuesta a esta llamada de método consiste en un objeto con el ID de la hoja de cálculo. y un array de ValueRange objetos correspondientes a cada rango solicitado, enumerados en el orden en que fueron solicitado. El Campo majorDimension indica que los arrays son listas de valores organizadas por columnas. Por ejemplo:

{
  "spreadsheetId": SPREADSHEET_ID,
  "valueRanges": [
    {
      "range": "Sheet1!B1:B1000",
      "majorDimension": "COLUMNS",
      "values": [
        ["Cost",20.5,15,100,135.5]
      ]
    },
    {
      "range": "Sheet1!D1:D1000",
      "majorDimension": "COLUMNS",
      "values": [
        ["Ship Date",42430,42444,42449,42449]
      ]s
    }
  ]
}

Leer varios rangos en varias hojas

Lo siguiente spreadsheets.values.batchGet muestra de código muestra cómo leer valores de rangos en las hojas Sheet1!A1:D5, Products!D1:D100 y Sales!E4:F6, y los devuelve en la respuesta. El Parámetro de configuración de ValueRenderOption de UNFORMATTED_VALUE indica que los valores se calculan, pero no se formatean en la respuesta. Se omiten las filas y columnas finales que estén vacías.

Aquí se muestra el protocolo de solicitud.

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values:batchGet?
            ranges=Sheet1!A1:D5&ranges=Products!D1:D100&ranges=Sales!E4:F6&valueRenderOption=UNFORMATTED_VALUE&majorDimension=COLUMNS

La respuesta a esta llamada de método consiste en un objeto con el ID de la hoja de cálculo. y un array de ValueRange objetos correspondientes a cada rango solicitado, enumerados en el orden en que fueron solicitado. El Campo majorDimension indica que los arrays son listas de valores organizadas por columnas. Por ejemplo:

{
  "spreadsheetId": SPREADSHEET_ID,
  "valueRanges": [
    {
      "range": "Sheet1!A1:D5",
      "majorDimension": "COLUMNS",
      "values": [
        [...],
        [...]
      ]
    },
    {
      "range": "Products!D1:D100",
      "majorDimension": "COLUMNS",
      "values": [
        [...]
      ]
    },
    {
      "range": "Sales!E4:F6",
      "majorDimension": "COLUMNS",
      "values": [
        [...],
        [...]
      ]
    }
  ]
}