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 pour chaque demande, sauf si vous fournissez un jeton OAuth 2.0 avec la demande.
  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 :
    • À l’aide du paramètre de requête access_token comme suit : ?access_token=oauth2-token
    • À l’aide de 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.
  • Pour obtenir la clé API de votre projet, accédez à Google Cloud Console.
prettyPrint

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

  • Renvoie une réponse sous un format lisible si la valeur est true.
  • Valeur par défaut : true
  • Lorsque la valeur est 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.
  • Vous pouvez définir librement la chaîne permettant d'identifier un utilisateur de manière unique, sans dépasser la limite de 40 caractères.
  • Remplace userIp si les deux sont fournis.
  • Obtenez plus d'informations sur la limitation de l'utilisation des 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.
  • Obtenez plus d'informations sur la limitation de l'utilisation des API.