La API de Google Sheets te permite crear, borrar, copiar y borrar hojas de cálculo. controlan sus propiedades. Los ejemplos de esta página ilustran cómo puedes realizar algunas operaciones comunes de Hojas de cálculo con el API de Hojas de cálculo.
Estos ejemplos se presentan en forma de solicitudes HTTP como lenguaje neutrales. Para aprender a implementar una actualización por lotes en diferentes idiomas con las bibliotecas cliente de la API de Google, consulta Actualización hojas de cálculo.
En estos ejemplos, los marcadores de posición SPREADSHEET_ID y SHEET_ID
se indica dónde se deben proporcionar esos ID. Puedes encontrar la hoja de cálculo
ID en la URL de la hoja de cálculo. Puedes obtener
el ID de la hoja mediante el
spreadsheets.get. El
los rangos se especifican con la notación A1. Los
el rango de ejemplo es Hoja1!A1:D5.
Agregar una hoja
Lo siguiente
spreadsheets.batchUpdate
de muestra de código muestra cómo usar el
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
color de pestaña.
La respuesta consta de un
AddSheetResponse,
que contiene un objeto con las propiedades de la hoja creada (como su
SHEET_ID).
El protocolo de solicitud se muestra a continuación.
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
}
}
}
}
]
}
Borrar todos los valores de una hoja sin perder los formatos
Lo siguiente
spreadsheets.batchUpdate
de muestra de código muestra cómo usar el
UpdateCellsRequest
para quitar todos los valores de una hoja sin modificar el formato.
Especificar el valor
Campo userEnteredValue
sin un valor correspondiente se interpreta como una instrucción para borrar valores
dentro del rango. Este parámetro de configuración también se puede usar con otros campos. Por ejemplo:
cambiando el valor de fields a
Se quitó userEnteredFormat
todos los formatos compatibles con la API de Hojas de cálculo
de la hoja, pero deja los valores de las celdas intactos.
El protocolo de solicitud se muestra a continuación.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"updateCells": {
"range": {
"sheetId": SHEET_ID
},
"fields": "userEnteredValue"
}
}
]
}
Copiar una hoja de una hoja de cálculo a otra
Lo siguiente
spreadsheet.sheets.copyTo
la muestra de código muestra cómo copiar una sola hoja especificada por SHEET_ID
de una hoja de cálculo a otra hoja de cálculo.
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 en "Copiar
de [título de la hoja original]".
La respuesta consta de un
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
Lo siguiente
spreadsheets.batchUpdate
de muestra de código muestra cómo usar el
DeleteSheetRequest
para borrar una hoja especificada por SHEET_ID.
El protocolo de solicitud se muestra a continuación.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"deleteSheet": {
"sheetId": SHEET_ID
}
}
]
}
Leer datos de la hoja
Lo siguiente
Muestra de código spreadsheets.get
muestra cómo obtener información de las propiedades de sheet
desde una hoja de cálculo, especificada por SHEET_ID
y SPREADSHEET_ID. Este método suele usarse para determinar la
metadatos de las hojas dentro de una hoja de cálculo específica, para que se puedan realizar operaciones adicionales
orientar esas hojas. El parámetro de consulta fields especifica solo la propiedad de la hoja.
los datos deben devolverse (en lugar de datos de valores de celdas o datos relacionados con la
toda la hoja de cálculo).
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?&fields=sheets.properties
La respuesta consta de un
Spreadsheet
recurso, que contiene un
Un objeto Sheet con
SheetProperties
o de terceros. Si un campo de respuesta determinado se establece con 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
}
},
...
],
}