Renvoyer des champs spécifiques

Pour renvoyer les champs exacts dont vous avez besoin et améliorer les performances, utilisez le paramètre système fields dans votre appel de méthode.

Ce document explique comment utiliser le paramètre fields dans Google Drive.

Fonctionnement du paramètre "fields"

Le paramètre fields utilise un FieldMask pour filtrer les réponses. Les masques de champ permettent de spécifier un sous-ensemble de champs qu'une requête doit renvoyer. Le masquage de champ est une bonne pratique à appliquer pour vous assurer de ne pas demander de données inutiles. Vous pourrez ainsi réduire le temps de traitement.

Si vous ne spécifiez pas le paramètre fields, le serveur renvoie un ensemble de champs par défaut spécifiques à la méthode. Par exemple, la méthode list sur la méthode files ne renvoie que les champs kind, id, name et mimeType. La méthode get sur la ressource permissions renvoie un ensemble différent de champs par défaut.

Pour toutes les méthodes des ressources about, comments (sauf delete) et replies (sauf delete), vous devez définir le paramètre fields. Ces méthodes ne renvoient pas un ensemble de champs par défaut.

Une fois qu'un serveur a traité une requête valide incluant le paramètre fields, il renvoie le code d'état HTTP 200 OK ainsi que les données demandées. Si le paramètre fields comporte une erreur ou s'il n'est pas valide pour une autre raison, le serveur renvoie le code d'état HTTP 400 Bad Request, ainsi qu'un message d'erreur indiquant la raison pour laquelle votre sélection de champs est incorrecte. Par exemple, files.list(fields='files(id,capabilities,canAddChildren)') génère l'erreur "Sélection de champ non valide canAddChildren". Le paramètre de champs correct pour cet exemple est files.list(fields='files(id,capabilities/canAddChildren)').

Pour déterminer les champs que vous pouvez renvoyer à l'aide du paramètre fields, consultez la page de documentation de la ressource que vous interrogez. Par exemple, pour savoir quels champs vous pouvez renvoyer pour un fichier, consultez la documentation sur la ressource files. Pour en savoir plus sur les termes de requête spécifiques aux fichiers, consultez Termes et opérateurs de requête de recherche.

Règles de format des paramètres de champ

Le format de la valeur du paramètre de requête "fields" repose globalement sur la syntaxe XPath. Voici les règles de mise en forme du paramètre fields. Toutes ces règles utilisent des exemples liés à la méthode files.get.

  • Incluez une liste dont les éléments sont séparés par une virgule pour sélectionner plusieurs champs, comme 'name, mimeType'.

  • Utilisez a/b pour sélectionner le champ b imbriqué dans le champ a, par exemple 'capabilities/canDownload'. Pour en savoir plus, consultez Récupérer les champs d'une ressource imbriquée.

  • Incluez un sous-sélecteur pour demander un ensemble de sous-champs spécifiques de tableaux ou d'objets en plaçant des expressions entre parenthèses : "()". Par exemple, 'permissions(id)' ne renvoie que l'ID d'autorisation pour chaque élément du tableau d'autorisations.

  • Pour renvoyer tous les champs d'un objet, utilisez un astérisque (*) comme caractère générique dans les sélections de champs. Par exemple, 'permissions/permissionDetails/*' sélectionne tous les champs d'informations disponibles pour chaque autorisation. Notez que l'utilisation du caractère générique peut avoir un impact négatif sur les performances de la requête.

Requête

Dans cet exemple, nous fournissons le paramètre de chemin d'accès à l'ID de fichier et plusieurs champs en tant que paramètre de requête dans la requête. La réponse renvoie les valeurs de champ pour l'ID de fichier.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=name,starred,shared

Réponse

{
  "name": "File1",
  "starred": false,
  "shared": true
  }
}

Récupérer les champs d'une ressource imbriquée

Lorsqu'un champ fait référence à une autre ressource, vous pouvez spécifier les champs de la ressource imbriquée à récupérer.

Par exemple, pour récupérer le champ role (ressource imbriquée) de la ressource permissions, utilisez l'une des options suivantes :

  • permissions.get correspond à fields=role.
  • permissions.get avec fields=* pour afficher tous les champs permissions.
  • files.get avec fields=permissions(role) ou fields=permissions/role.
  • files.get avec fields=permissions pour afficher tous les champs permissions.
  • changes.list correspond à fields=changes(file(permissions(role))).

Pour récupérer plusieurs champs, utilisez une liste d'éléments séparés par une virgule. Par exemple, files.list avec fields=files(id,name,createdTime,modifiedTime,size).

Requête

Dans cet exemple, nous fournissons le paramètre de chemin d'accès à l'ID de fichier et plusieurs champs, y compris certains champs de la ressource d'autorisations imbriquée, en tant que paramètre de requête dans la requête. La réponse renvoie les valeurs de champ pour l'ID de fichier.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=name,starred,shared,permissions(kind,type,role)

Réponse

{
  "name": "File1",
  "starred": false,
  "shared": true,
  "permissions": [
    {
      "kind": "drive#permission",
      "type": "user",
      "role": "owner"
    }
  ]
}