Las máscaras de campo son una forma en que los llamadores de la API pueden enumerar los campos que una solicitud debe devolver o actualizar. El uso de un FieldMask permite que la API evite el trabajo innecesario y mejore el rendimiento. Se usa una máscara de campo para los métodos de lectura y actualización en la API de Google Slides.
Para comparar lo que se devuelve en un cuerpo de respuesta cuando no usas una máscara de campo con lo que se devuelve cuando la usas, consulta Cómo trabajar con recursos parciales.
Lectura con una máscara de campo
Las presentaciones pueden ser grandes y, a menudo, no necesitas todas las partes del recurso presentations que devuelve una solicitud de lectura. Puedes limitar lo que se devuelve en una respuesta de la API de Slides con el parámetro de URL fields. Para obtener el mejor rendimiento, enumera de forma explícita solo los campos que necesitas en la respuesta.
El formato del parámetro fields es el mismo que el de la codificación JSON de un FieldMask. En resumen, los diferentes campos se separan con comas y los subcampos, con puntos. Los nombres de los campos se pueden especificar en camelCase o separados_por_guiones_bajos. Para mayor comodidad, se pueden enumerar varios subcampos del mismo tipo entre paréntesis.
En el siguiente ejemplo de solicitud del método presentations.get, se usa una máscara de campo de slides.pageElements(objectId,size,transform) para recuperar solo el ID del objeto, Size, y la transformación de un objeto pageElement en todas las diapositivas de una presentación:
GET https://slides.googleapis.com/v1/presentations/presentationId?fields=slides.pageElements(objectId,size,transform)
La respuesta a esta llamada de método es un objeto presentations que contiene los componentes solicitados en la máscara de campo:
{
"slides": [
{
"pageElements": [
{
"objectId": "OBJECT_ID",
"size": {
"width": {
"magnitude": 3000000,
"unit": "EMU"
},
"height": {
"magnitude": 3000000,
"unit": "EMU"
}
},
"transform": {
"scaleX": 1,
"scaleY": 1
"translateX": 311708,
"translateY": 744575,
"unit": "EMU"
}
},
{
"objectId": "OBJECT_ID",
"size": {
"width": {
"magnitude": 3000000,
"unit": "EMU"
},
"height": {
"magnitude": 3000000,
"unit": "EMU"
}
},
"transform": {
"scaleX": 1,
"scaleY": 1
"translateX": 311700,
"translateY": 2834125,
"unit": "EMU"
}
}
]
}
]
}Actualiza con una máscara de campo
A veces, solo necesitas actualizar ciertos campos en un objeto y no modificar los otros campos. Las solicitudes de actualización dentro de un método presentations.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 especifican en la máscara de campo y los deja con sus valores actuales.
También puedes anular la configuración de un campo si no lo especificas en el mensaje actualizado, pero lo agregas a la máscara. Esto borrará cualquier valor que el campo haya tenido anteriormente.
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 el método UpdateShapePropertiesRequest para cambiar el relleno de color de una forma al color del tema DARK1 y anular el contorno de la forma:
POST https://slides.googleapis.com/v1/presentations/presentationId:batchUpdate
{
"requests": [
{
"updateShapeProperties": {
"objectId": OBJECT_ID,
"shapeProperties": {
"shapeBackgroundFill": {
"solidFill": {
"color": {
"themeColor": "DARK1"
}
}
}
},
"fields": "shapeBackgroundFill.solidFill.color,outline"
}
}
]
}