Paramètres de requête standards

Les paramètres de requête qui s'appliquent à toutes les opérations de l'API Resource Manager sont présentés dans le tableau ci-dessous.

Remarques (sur les clés API et les jetons d'authentification) :

  1. Le paramètre key est obligatoire avec toute requête, à moins de fournir un jeton OAuth 2.0.
  2. Vous devez envoyer un jeton d'autorisation avec chaque requête nécessitant un champ d'application OAuth. OAuth 2.0 est le seul protocole d'autorisation compatible.
  3. Il existe deux manières de fournir un jeton OAuth 2.0 avec une requête :
    • Utiliser le paramètre de requête access_token comme suit : ?access_token=oauth2-token
    • Utiliser l'en-tête HTTP Authorization comme suit : Authorization: Bearer oauth2-token

Sauf indication contraire, tous les paramètres sont facultatifs.

Paramètre Signification Notes
access_token Jeton OAuth 2.0 pour l'utilisateur actuel.
  • Un moyen de fournir un jeton OAuth 2.0.
callback Fonction de rappel.
  • Il s'agit du nom de la fonction de rappel JavaScript qui gère la réponse.
  • Utilisée dans les requêtes JSON-P JavaScript.
fields Sélecteur permettant de spécifier un sous-ensemble de champs à inclure dans la réponse.
  • Pour en savoir plus, consultez la section relative aux réponses partielles.
  • Utilisé pour optimiser les performances.
key Clé API (OBLIGATOIRE*)
  • * Obligatoire à moins de fournir un jeton OAuth 2.0.
  • Votre clé API identifie votre projet et vous donne accès à l'API, aux quotas et aux rapports.
  • Obtenez la clé API de votre projet à partir de la console Google Cloud Platform.
prettyPrint

Renvoie une réponse avec des indentations et des sauts de ligne.

  • Si la valeur de ce paramètre est définie sur true, la réponse est obtenue dans un format plus lisible.
  • La valeur par défaut est true.
  • Lorsque ce paramètre est défini sur false, la taille de la réponse peut être réduite, ce qui améliore les performances dans certains environnements.
quotaUser Alternative à userIp.
  • L'utilisation de ce paramètre vous permet d'appliquer les quotas par utilisateur provenant d'une application côté serveur, même si l'adresse IP de l'utilisateur est inconnue. Cela est utile par exemple dans le cas d'applications qui exécutent dans App Engine des tâches Cron pour le compte d'un utilisateur.
  • La chaîne permettant d'identifier un utilisateur de manière unique peut être définie selon votre choix, tant qu'elle ne dépasse pas 40 caractères.
  • Le paramètre userIp est remplacé s'il est utilisé conjointement avec ce paramètre.
  • En savoir plus sur la limitation de l'utilisation de l'API
userIp Adresse IP de l'utilisateur final pour le compte duquel l'appel d'API est effectué.
  • Ce paramètre vous permet d'appliquer des quotas par utilisateur lorsque l'appel d'API provient d'une application côté serveur.
  • En savoir plus sur la limitation de l'utilisation de l'API

Cette page vous a-t-elle été utile ? Évaluez-la :

Envoyer des commentaires concernant…

Documentation relative à Resource Manager