La API de Hojas de cálculo de Google te permite agregar, quitar y manipular filas y columnas en las hojas. En los ejemplos de esta página, se muestra cómo se pueden lograr algunas operaciones comunes de filas y columnas con la API de Hojas de cálculo.
Estos ejemplos se presentan en forma de solicitudes HTTP para que sean neutrales en cuanto al idioma. Para obtener información sobre cómo implementar una actualización por lotes en diferentes idiomas con las bibliotecas cliente de la API de Google, consulta Cómo actualizar 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 la URL de la hoja de cálculo. Puedes obtener el ID de la hoja con el método spreadsheets.get
. Los rangos se especifican con la notación A1. Un
rango de ejemplo es Hoja1!A1:D5.
Cómo ajustar el ancho de la columna o la altura de la fila
En la siguiente muestra de código spreadsheets.batchUpdate
, se muestra cómo usar UpdateDimensionPropertiesRequest
para actualizar la propiedad de ancho de la columna A a 160 píxeles. Una segunda solicitud actualiza la propiedad de altura de fila de las primeras tres filas a 40 píxeles. El campo dimension
determina si la operación se aplica a las columnas o filas de una hoja.
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{ "requests": [ { "updateDimensionProperties": { "range": { "sheetId":SHEET_ID
, "dimension": "COLUMNS", "startIndex": 0, "endIndex": 1 }, "properties": { "pixelSize": 160 }, "fields": "pixelSize" } }, { "updateDimensionProperties": { "range": { "sheetId":SHEET_ID
, "dimension": "ROWS", "startIndex": 0, "endIndex": 3 }, "properties": { "pixelSize": 40 }, "fields": "pixelSize" } } ] }
Cómo agregar filas o columnas vacías
En la siguiente muestra de código de spreadsheets.batchUpdate
, se muestra cómo usar AppendDimensionRequest
para agregar filas y columnas. La primera solicitud agrega tres filas vacías al final de una hoja, mientras que la segunda agrega una sola columna vacía. El campo dimension
determina si la operación se aplica a las columnas o filas de una hoja.
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{ "requests": [ { "appendDimension": { "sheetId":SHEET_ID
, "dimension": "ROWS", "length": 3 } }, { "appendDimension": { "sheetId":SHEET_ID
, "dimension": "COLUMNS", "length": 1 } } ] }
Cambia el tamaño de una columna automáticamente
En la siguiente
muestra de código de spreadsheets.batchUpdate
,
se muestra cómo usar AutoResizeDimensionsRequest
para cambiar el tamaño de las columnas A:C, según el tamaño del contenido de la columna. El campo dimension
indica que la operación se aplica a las columnas de la hoja.
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{
"requests": [
{
"autoResizeDimensions": {
"dimensions": {
"sheetId": SHEET_ID
,
"dimension": "COLUMNS",
"startIndex": 0,
"endIndex": 3
}
}
}
]
}
Cambia el tamaño de una fila automáticamente
En la siguiente
muestra de código de spreadsheets.batchUpdate
,
se muestra cómo usar AutoResizeDimensionsRequest
para borrar las alturas de las filas de las primeras tres filas. Luego, las alturas de las filas aumentan de forma dinámica según el contenido de las celdas de cada fila. El campo dimension
indica que la operación se aplica a las filas de la hoja.
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{
"requests": [
{
"autoResizeDimensions": {
"dimensions": {
"sheetId": SHEET_ID
,
"dimension": "ROWS",
"startIndex": 0,
"endIndex": 3
}
}
}
]
}
Cómo borrar filas o columnas
En la siguiente muestra de código de spreadsheets.batchUpdate
, se muestra cómo usar DeleteDimensionRequest
para borrar las primeras tres filas de una hoja. Una segunda solicitud borra las columnas B:D.
El campo dimension
determina si la operación se aplica a las columnas o filas de una hoja.
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{ "requests": [ { "deleteDimension": { "range": { "sheetId":SHEET_ID
, "dimension": "ROWS", "startIndex": 0, "endIndex": 3 } } }, { "deleteDimension": { "range": { "sheetId":SHEET_ID
, "dimension": "COLUMNS", "startIndex": 1, "endIndex": 4 } } }, ], }
Cómo insertar una fila o columna vacía
En la siguiente muestra de código de spreadsheets.batchUpdate
, se muestra cómo usar InsertDimensionRequest
para insertar columnas o filas en un índice en particular (como anteponer filas vacías en la parte superior de una hoja). La primera solicitud inserta dos columnas vacías en la columna C.
Una segunda solicitud inserta tres filas vacías que comienzan en la fila 1.
El campo dimension
determina si la operación se aplica a las columnas o filas de una hoja.
Si es verdadero, el campo inheritFromBefore
le indica a la API de Hojas de cálculo que le asigne a las filas o columnas nuevas las mismas propiedades que a la fila o columna anterior y, si es falso, que herede de las dimensiones después de las filas o columnas nuevas.
inheritFromBefore
no puede ser verdadero si se inserta una fila en la fila 1 o una columna en la columna A.
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{ "requests": [ { "insertDimension": { "range": { "sheetId":SHEET_ID
, "dimension": "COLUMNS", "startIndex": 2, "endIndex": 4 }, "inheritFromBefore": true } }, { "insertDimension": { "range": { "sheetId":SHEET_ID
, "dimension": "ROWS", "startIndex": 0, "endIndex": 3 }, "inheritFromBefore": false } }, ], }
Cómo mover una fila o columna
En la siguiente
muestra de código de spreadsheets.batchUpdate
,
se muestra cómo usar MoveDimensionRequest
para mover la columna A a la posición de la columna D. Una segunda solicitud mueve las filas del 5 al 10 a la posición 20.
El campo dimension
determina si la operación se aplica a las columnas o filas de una hoja. El campo destinationIndex
determina dónde mover los datos de origen con un índice de inicio basado en cero.
A continuación, se muestra el protocolo de solicitud.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{ "requests": [ { "moveDimension": { "source": { "sheetId":SHEET_ID
, "dimension": "COLUMNS", "startIndex": 0, "endIndex": 1 }, "destinationIndex": 3 } }, { "moveDimension": { "source": { "sheetId":SHEET_ID
, "dimension": "ROWS", "startIndex": 4, "endIndex": 10 }, "destinationIndex": 19 } }, ], }