La API de Google Sheets te permite leer valores de celdas, rangos, conjuntos de rangos y hojas enteras. En los ejemplos de esta página, se muestran algunas operaciones de lectura comunes con el recurso spreadsheets.values. También puedes leer los valores de las celdas con el método spreadsheets.get, pero, por lo general, es más fácil usar spreadsheets.values.get o spreadsheets.values.batchGet.
Estos ejemplos se presentan en forma de solicitudes HTTP para que tengan lenguaje neutro. Si quieres aprender a implementar lecturas en diferentes lenguajes con las bibliotecas cliente de la API de Google, consulta Cómo leer y escribir valores de celdas.
En estos ejemplos, el marcador de posición SPREADSHEET_ID indica dónde se debe proporcionar el ID de la hoja de cálculo, que se puede descubrir en la URL de la hoja de cálculo. Los rangos en los que se leerá se especifican con la notación A1 en la URL de la solicitud. Un rango de ejemplo es Hoja1!A1:D5.
Datos de origen
Para estos ejemplos, supongamos que la hoja de cálculo que se lee tiene los siguientes datos de origen en su primera hoja (“Sheet1”). Las cadenas de la primera fila son las etiquetas de las columnas individuales. Para ver ejemplos de cómo leer desde otras hojas de 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 | Engine | USD 100 | 1 | 20/3/2016 |
| 5 | Totales | $135.5 | 7 | 20/3/2016 |
Cómo leer un solo rango
En la siguiente muestra de código spreadsheets.values.get, se indica cómo leer los valores del rango Sheet1!A1:D5 y se muestran en la respuesta. Se omiten las filas y columnas finales que estén vacías.
A continuación, se muestra el protocolo de solicitud.
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5
La respuesta consta de un objeto ValueRange que describe los valores del rango. El campo majorDimension indica que los arreglos son listas de valores organizados 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"]
],
}
Leer un solo rango agrupado por columna
En la siguiente muestra de código spreadsheets.values.get, se indica cómo leer los valores del rango Sheet1!A1:D3 y se muestran en la respuesta, pero agrupados por columna. Se omiten las filas y columnas finales vacías.
A continuación, 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 objeto ValueRange que describe los valores del rango. El campo majorDimension indica que los arrays son listas de valores organizados 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"]
],
}
Lee un solo rango con opciones de renderización
En la siguiente muestra de código spreadsheets.values.get, se indica cómo leer los valores del rango Sheet1!A1:D5 y se muestran en la respuesta, pero se usan opciones de renderización para administrar la forma en que se muestra esa información. La configuración ValueRenderOption de FORMULA indica que se deben mostrar las fórmulas en lugar del valor calculado, y la configuración de DateTimeRenderOption de SERIAL_NUMBER indica que las fechas se deben mostrar como números.
También se pueden usar otras opciones de configuración. Se omiten las filas y columnas finales vacías.
A continuación, 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 objeto ValueRange que describe los valores del rango. El campo majorDimension indica que los arreglos son listas de valores organizados 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)"]
],
}
Cómo leer varios rangos
En la siguiente muestra de código de spreadsheets.values.batchGet, se indica cómo leer valores de los rangos Sheet1!B:B y Sheet1!D:D, y los muestra en la respuesta. La configuración ValueRenderOption de UNFORMATTED_VALUE indica que se calculan los valores, pero que no se les da formato en la respuesta. Se omiten las filas y columnas finales que estén vacías.
A continuación, 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 este método consiste en un objeto con el ID de la hoja de cálculo y un arreglo de objetos ValueRange correspondientes a cada rango solicitado, enumerados en el orden en que se solicitaron. El campo majorDimension indica que los arrays son listas de valores organizados 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]
]
}
]
}