Utiliser des masques de champ

Les masques de champ permettent aux appelants d'API de lister les champs qu'une requête doit renvoyer ou mettre à jour. L'utilisation d'un FieldMask permet à l'API d'éviter un travail inutile 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 vous n'avez souvent pas besoin de toutes les parties de la Spreadsheet ressource 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, ne listez explicitement que les champs dont vous avez besoin dans la réponse.

Le format du paramètre "fields" est le même que l'encodage JSON d'un 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 de champ peuvent être spécifiés en camelCase ou séparés_par_des_tirets_bas. Pour plus de commodité, plusieurs sous-champs du même type peuvent être listés entre parenthèses.

L'exemple de requête spreadsheets.get suivant utilise un masque de champ sheets.properties(sheetId,title,sheetType,gridProperties)pour ne récupérer que 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 Spreadsheet objet 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 devez ne mettre à jour que certains champs d'un objet en laissant les autres champs inchangés. Les requêtes de mise à jour dans une spreadsheets.batchUpdate opération utilisent des masques de champ pour indiquer à l'API les champs qui sont modifiés. La requête de mise à jour ignore les champs non spécifiés dans le masque de champ, en conservant leurs valeurs actuelles.

Vous pouvez également annuler la définition d'un champ en ne le spécifiant pas dans le message mis à jour, mais en l'ajoutant au masque. Cela efface la valeur précédente du 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 les AddSheetRequest pour ajouter une 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
            }
          }
        }
      }
    }
  ]
}