Le maschere di campo consentono ai chiamanti API di elencare i campi che una richiesta deve restituire o aggiornare. L'utilizzo di una FieldMask consente all'API di evitare il lavoro non necessario e migliora le prestazioni. Una maschera di campo viene utilizzata per i metodi di lettura e aggiornamento nell'API Presentazioni Google.
Lettura con una maschera del campo
Le presentazioni possono essere grandi e spesso non è necessaria ogni parte della risorsa Presentation restituita da una richiesta di lettura. Puoi limitare ciò che viene restituito in una risposta dell'API Presentazioni utilizzando il parametro URL fields. Per ottenere prestazioni ottimali, elenca esplicitamente solo i campi necessari nella risposta.
Il formato del parametro dei campi è lo stesso della codifica JSON di una maschera per i campi. In breve, i vari campi sono separati da virgole e i sottocampi sono separati da punti. I nomi dei campi possono essere specificati in camelCase o separate_by_underscores. Per praticità, più sottocampi dello stesso tipo possono essere elencati tra parentesi.
Il seguente esempio di richiesta presentations.get utilizza una maschera di campo slides.pageElements(objectId,size,transform) per recuperare solo l'ID oggetto Size e trasformare un oggetto pageElement in tutte le slide di una presentazione:
GET https://slides.googleapis.com/v1/presentations/presentationId?fields=slides.pageElements(objectId,size,transform)
La risposta a questa chiamata al metodo è un oggetto Presentation contenente i componenti richiesti nella maschera del 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"
}
}
]
}
]
}
Aggiorna con una maschera del campo
A volte è necessario aggiornare solo alcuni campi di un oggetto, lasciando invariati gli altri. Le richieste di aggiornamento all'interno di un'operazione presentations.batchUpdate utilizzano le maschere dei campi per indicare all'API quali campi vengono modificati. La richiesta di aggiornamento ignora tutti i campi non specificati nella maschera del campo, lasciandoli con i valori correnti.
Puoi anche annullare l'impostazione di un campo non specificandolo nel messaggio aggiornato, ma aggiungendolo alla maschera. In questo modo viene cancellato qualsiasi valore che il campo aveva precedentemente.
La sintassi per le maschere del campo di aggiornamento è la stessa delle maschere dei campi di lettura.
L'esempio seguente utilizza l'elemento UpdateShapePropertiesRequest per modificare il riempimento di colore di una forma con il colore del tema DARK1 e annullare l'impostazione del contorno della 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"
}
}
]
}