Las máscaras de campo son una forma para que los llamadores de API enumeren los campos que una solicitud debe mostrar o actualizar. El uso de una FieldMask permite que la API evite trabajos innecesarios y mejora el rendimiento. Se usa una máscara de campo para los métodos de lectura y actualización de la API de Hojas de cálculo de Google.
Realiza operaciones de lectura con una máscara de campo
Las hojas de cálculo pueden ser grandes y, a menudo, no necesitas cada parte del recurso Spreadsheet que se muestra en una solicitud de lectura. Para limitar lo que se muestra en una respuesta de la API de Hojas de cálculo, puedes usar el parámetro de URL fields. Para obtener el mejor rendimiento, lista de forma explícita solo los campos que necesitas en la respuesta.
El formato del parámetro de los campos es el mismo que la codificación JSON de una FieldMask. Dicho en pocas palabras, varios campos diferentes están separados por comas y los subcampos se separan con puntos. Los nombres de los campos se pueden especificar en camelCase o separate_by_guion bajos. Para mayor comodidad, se pueden enumerar varios subcampos del mismo tipo entre paréntesis.
En el siguiente ejemplo de solicitud spreadsheets.get, se usa una máscara de campo sheets.properties(sheetId,title,sheetType,gridProperties) para recuperar solo el ID, el título, SheetType y GridProperties de un objeto SheetProperties de la hoja en todas las hojas de una hoja de cálculo:
GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId?fields=sheets.properties(sheetId,title,sheetType,gridProperties)
La respuesta a esta llamada de método es un objeto Spreadsheet que contiene los componentes solicitados en la máscara de campo. Ten en cuenta que sheetType=OBJECT no contiene gridProperties:
{
"sheets": [
{
"properties": {
"sheetId": SHEET_ID,
"title": "TITLE",
"sheetType": "GRID",
"gridProperties": {
"rowCount": 1000,
"columnCount": 25
}
}
},
{
"properties": {
"sheetId": SHEET_ID,
"title": "TITLE",
"sheetType": "OBJECT"
}
}
]
}
Actualiza con una máscara de campo
A veces, solo necesitas actualizar ciertos campos de un objeto y debes dejar los otros campos sin modificar. Las solicitudes de actualización dentro de una operación spreadsheets.batchUpdate usan máscaras de campo para indicarle a la API qué campos se cambian. La solicitud de actualización ignora los campos que no se especifiquen en la máscara de campo, lo que los deja con sus valores actuales.
También puedes quitar un campo si no lo especificas en el mensaje actualizado y lo agregas a la máscara. Esto borra cualquier valor que el campo tenía antes.
La sintaxis de las máscaras de campo de actualización es la misma que la de las máscaras de campo de lectura.
En el siguiente ejemplo, se usa AddSheetRequest para agregar una hoja nueva de tipo Grid, inmovilizar la primera fila y cambiar el color de la pestaña de la hoja nueva de color rojo:
POST https://sheets.googleapis.com/v1/spreadsheets/spreadsheetId:batchUpdate
{
"spreadsheetId": "SPREADSHEET_ID",
"replies": [
{
"addSheet": {
"properties": {
"sheetId": SHEET_ID,
"title": "TITLE",
"index": 6,
"sheetType": "GRID",
"gridProperties": {
"rowCount": 1000,
"columnCount": 26,
"frozenRowCount": 1
},
"tabColor": {
"red": 0.003921569
},
"tabColorStyle": {
"rgbColor": {
"red": 0.003921569
}
}
}
}
}
]
}