Le maschere di campo consentono ai chiamanti API di elencare i campi che una richiesta dovrebbe restituire o aggiornare. L'utilizzo di una FieldMask consente all'API di evitare lavoro non necessario e migliora le prestazioni. Una maschera di campo viene utilizzata per i metodi di lettura e di aggiornamento nell'API Fogli Google.
Lettura con una maschera dei campi
I fogli di lavoro possono essere grandi e spesso non è necessario restituire ogni parte della risorsa Spreadsheet da una richiesta di lettura. Puoi limitare ciò che viene restituito in una risposta dell'API Fogli utilizzando il parametro URL fields. Per ottenere le migliori prestazioni, elenca esplicitamente solo i campi necessari nella risposta.
Il formato del parametro dei campi è lo stesso della codifica JSON di una maschera di campo. In breve, più campi diversi sono separati da virgole, mentre i campi secondari sono separati da punti. I nomi dei campi possono essere specificati in camelCase o separate_by_underscores. Per praticità, tra parentesi possono essere elencati più sottocampi dello stesso tipo.
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 dei campi. 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"
}
}
]
}
Aggiornamento con una maschera dei campi
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 i campi non specificati nella maschera dei campi, lasciandoli con i valori attuali.
Puoi anche annullare l'impostazione di un campo non specificandolo nel messaggio aggiornato, ma aggiungendolo alla maschera. In questo modo viene cancellato qualsiasi valore assegnato in precedenza al campo.
La sintassi per le maschere dei campi 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
}
}
}
}
}
]
}