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 Slides.

Pour comparer ce qui est renvoyé dans un corps de réponse lorsque vous n'utilisez pas de masque de champ et lorsque vous en utilisez un, consultez Utiliser des ressources partielles.

Lire avec un masque de champ

Les présentations peuvent être volumineuses, et vous n'avez souvent pas besoin de toutes les parties de la presentations ressource renvoyée par une requête de lecture. Vous pouvez limiter ce qui est renvoyé dans une réponse de l'API Slides à 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 de méthode suivant presentations.get utilise un masque de champ slides.pageElements(objectId,size,transform)pour ne récupérer que l'ID d'objet, Size, et la transformation d'un objet pageElement sur toutes les diapositives d'une présentation :

GET https://slides.googleapis.com/v1/presentations/presentationId?fields=slides.pageElements(objectId,size,transform)

La réponse à cet appel de méthode est un presentations objet contenant les composants demandés dans le masque de champ :

{
  "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"
          }
        }
     ]
    }
  ]
}

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 presentations.batchUpdate méthode 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.

Un masque de champ * est traité comme un caractère générique et est une abréviation pour spécifier chaque champ d'un message. La syntaxe des caractères génériques peut produire des résultats indésirables si l'API est mise à jour à l'avenir, car les champs en lecture seule et les champs nouvellement ajoutés peuvent entraîner des erreurs. Pour les applications de production, listez toujours les champs spécifiques mis à jour dans les masques de champ et évitez d'utiliser des caractères génériques *.

L'exemple suivant utilise la UpdateShapePropertiesRequest méthode pour remplacer la couleur de remplissage d'une forme par la couleur de thème DARK1 et annuler la définition du contour de la forme :

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"
      }
    }
  ]
}