La API de Google Sheets te permite crear, borrar, copiar y eliminar hojas, y también controlar sus propiedades. En los ejemplos de esta página, se ilustra cómo puedes realizar algunas operaciones comunes de Hojas de cálculo con la API de Sheets.
Estos ejemplos se presentan en forma de solicitudes HTTP para que sean independientes del idioma. Para obtener información sobre cómo implementar una actualización por lotes en diferentes lenguajes con las bibliotecas cliente de las APIs de Google, consulta Actualiza hojas de cálculo.
En estos ejemplos, los marcadores de posición SPREADSHEET_ID y SHEET_ID indican dónde proporcionarías esos IDs. Puedes encontrar el ID de la hoja de cálculo en su URL. Puedes obtener el ID de la hoja con el método spreadsheets.get. Los rangos se especifican con la notación A1. Un ejemplo de rango es Hoja1!A1:D5.
Cómo agregar una hoja
En la siguiente muestra de código de spreadsheets.batchUpdate, se muestra cómo usar AddSheetRequest para agregar una hoja a una hoja de cálculo y, al mismo tiempo, establecer el título, el tamaño de la cuadrícula y el color de la pestaña.
La respuesta consta de un objeto AddSheetResponse, que contiene un objeto con las propiedades de la hoja creada (como su SHEET_ID).
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate{
"requests": [
{
"addSheet": {
"properties": {
"title": "Deposits",
"gridProperties": {
"rowCount": 20,
"columnCount": 12
},
"tabColor": {
"red": 1.0,
"green": 0.3,
"blue": 0.4
}
}
}
}
]
}Cómo borrar todos los valores de una hoja y conservar los formatos
En la siguiente muestra de código de spreadsheets.batchUpdate, se muestra cómo usar UpdateCellsRequest para quitar todos los valores de una hoja sin alterar el formato.
Si se especifica el campo userEnteredValue sin un valor correspondiente, se interpreta como una instrucción para borrar los valores del rango. Este parámetro de configuración también se puede usar con otros campos. Por ejemplo, cambiar el valor de fields a userEnteredFormat quita todo el formato compatible con la API de Sheets de la hoja, pero deja los valores de las celdas sin modificar.
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate{
"requests": [
{
"updateCells": {
"range": {
"sheetId": SHEET_ID
},
"fields": "userEnteredValue"
}
}
]
}Cómo copiar una hoja de una hoja de cálculo a otra
En el siguiente ejemplo de código de spreadsheet.sheets.copyTo, se muestra cómo copiar una sola hoja especificada por SHEET_ID de una hoja de cálculo a otra.
La variable TARGET_SPREADSHEET_ID en el cuerpo de la solicitud especifica la hoja de cálculo de destino. La copia conserva todos los valores, el formato, las fórmulas y otras propiedades del original. El título de la hoja copiada se establece como "Copia de [título de la hoja original]".
La respuesta consta de un objeto SheetProperties que describe las propiedades de la hoja creada.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/sheets/SHEET_ID:copyTo
{
"destinationSpreadsheetId": "TARGET_SPREADSHEET_ID"
}Cómo borrar una hoja
En la siguiente muestra de código de spreadsheets.batchUpdate, se muestra cómo usar DeleteSheetRequest para borrar una hoja especificada por SHEET_ID.
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate{
"requests": [
{
"deleteSheet": {
"sheetId": SHEET_ID
}
}
]
}Leer datos de la hoja
En la siguiente muestra de código de spreadsheets.get, se muestra cómo obtener información de la propiedad de la hoja de una hoja de cálculo, especificada por SHEET_ID y SPREADSHEET_ID. Este método se suele usar para determinar los metadatos de las hojas dentro de una hoja de cálculo específica, de modo que las operaciones adicionales puedan dirigirse a esas hojas. El parámetro de consulta fields especifica que solo se deben devolver los datos de las propiedades de la hoja (a diferencia de los datos de los valores de las celdas o los datos relacionados con toda la hoja de cálculo).
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?&fields=sheets.propertiesLa respuesta consta de un recurso Spreadsheet, que contiene un objeto Sheet con elementos SheetProperties. Si un campo de respuesta determinado se establece en el valor predeterminado, se omite de la respuesta.
{
"sheets": [
{
"properties": {
"sheetId": SHEET_ID,
"title": "Sheet1",
"index": 0,
"sheetType": "GRID",
"gridProperties": {
"rowCount": 100,
"columnCount": 20,
"frozenRowCount": 1
}
"tabColor": {
"blue": 1.0
}
},
...
],
}