Les masques de champ permettent aux appelants d'API de répertorier les champs qu'une requête doit renvoyer ou mettre à jour. L'utilisation de FieldMask permet à l'API d'éviter des tâches inutiles et d'améliorer les performances. Un masque de champ est utilisé pour les méthodes de lecture et de mise à jour dans l'API Google Sheets.
Lire avec un masque de champ
Les feuilles de calcul peuvent être volumineuses, et souvent vous n'avez pas besoin de tout ce qui est nécessaire à la ressource Spreadsheet renvoyée par une requête de lecture. Vous pouvez limiter ce qui est renvoyé dans une réponse de l'API Sheets à l'aide du paramètre d'URL fields. Pour des performances optimales, n'indiquez explicitement que les champs dont vous avez besoin dans la réponse.
Le format du paramètre "fields" est identique à celui de l'encodage JSON d'un paramètre FieldMask. En bref, plusieurs champs différents sont séparés par une virgule et les sous-champs sont séparés par un point. Les noms des champs peuvent être spécifiés en camelCase ou en Separate_by_underscores. Pour plus de commodité, vous pouvez placer plusieurs sous-champs du même type entre parenthèses.
L'exemple de requête spreadsheets.get suivant utilise un masque de champ sheets.properties(sheetId,title,sheetType,gridProperties) pour extraire uniquement l'ID de la feuille, le titre, SheetType et GridProperties d'un objet SheetProperties sur toutes les feuilles d'une feuille de calcul:
GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId?fields=sheets.properties(sheetId,title,sheetType,gridProperties)
La réponse à cet appel de méthode est un objet Spreadsheet contenant les composants demandés dans le masque de champ. Notez que sheetType=OBJECT ne contient pas gridProperties:
{
"sheets": [
{
"properties": {
"sheetId": SHEET_ID,
"title": "TITLE",
"sheetType": "GRID",
"gridProperties": {
"rowCount": 1000,
"columnCount": 25
}
}
},
{
"properties": {
"sheetId": SHEET_ID,
"title": "TITLE",
"sheetType": "OBJECT"
}
}
]
}
Mettre à jour avec un masque de champ
Parfois, vous ne devez mettre à jour que certains champs d'un objet, tout en laissant les autres champs inchangés. Les requêtes de mise à jour dans une opération spreadsheets.batchUpdate utilisent des masques de champ pour indiquer à l'API quels champs sont modifiés. La requête de mise à jour ignore tous les champs qui ne sont pas spécifiés dans le masque de champ, et les conserve avec leurs valeurs actuelles.
Vous pouvez également annuler la définition d'un champ en l'ajoutant au masque plutôt qu'en le spécifiant dans le message mis à jour. Cette opération efface la valeur précédemment attribuée au champ.
La syntaxe des masques de champ de mise à jour est la même que celle des masques de champ de lecture.
L'exemple suivant utilise AddSheetRequest pour ajouter une nouvelle feuille de type Grid, figer la première ligne et colorer l'onglet de la nouvelle feuille en rouge:
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
}
}
}
}
}
]
}