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 entrambi i metodi di lettura e di aggiornamento nell'API Fogli Google.
Lettura con una maschera del campo
I fogli di lavoro possono essere di grandi dimensioni e spesso non è necessaria ogni parte della risorsa Spreadsheet restituita da una richiesta di lettura. Puoi limitare ciò che viene restituito in una risposta dell'API Fogli usando 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 spreadsheets.get utilizza una maschera di campo sheets.properties(sheetId,title,sheetType,gridProperties) per recuperare solo l'ID foglio, il titolo, SheetType e GridProperties di un oggetto SheetProperties in tutti i fogli di un foglio di lavoro:
GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId?fields=sheets.properties(sheetId,title,sheetType,gridProperties)
La risposta a questa chiamata al metodo è un oggetto Spreadsheet contenente i componenti richiesti nella maschera del campo. Tieni presente che sheetType=OBJECT non contiene gridProperties:
{
"sheets": [
{
"properties": {
"sheetId": SHEET_ID,
"title": "TITLE",
"sheetType": "GRID",
"gridProperties": {
"rowCount": 1000,
"columnCount": 25
}
}
},
{
"properties": {
"sheetId": SHEET_ID,
"title": "TITLE",
"sheetType": "OBJECT"
}
}
]
}
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 spreadsheets.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 AddSheetRequest per aggiungere un nuovo foglio di tipo Grid, bloccare la prima riga e colorare di rosso la scheda del nuovo foglio:
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
}
}
}
}
}
]
}