Paramètres système

La plate-forme d'API Google fournit un ensemble de fonctionnalités communes à toutes les API Google qu'elle permet de créer. Pour utiliser et contrôler cette fonctionnalité, la plate-forme prédéfinit un ensemble spécial de paramètres de requête appelés paramètres système. Ces paramètres sont disponibles dans toutes les API Google REST et gRPC. Un paramètre système peut être spécifié à l'aide d'un paramètre de requête ou d'un en-tête HTTP. Pour les API gRPC Google, seuls les en-têtes HTTP sont disponibles.

La plupart des utilisateurs n'auront pas besoin d'utiliser ces paramètres directement, mais ils sont souvent utilisés par les bibliothèques clientes fournies par Google. Si vous devez écrire du code personnalisé pour accéder directement aux API Google, les paramètres système peuvent s'avérer utiles, par exemple pour le contrôle de l'impression de la version correctement formatée en JSON ou la spécification de clés API.

Mise en correspondance HTTP

Pour les protocoles HTTP, les paramètres système sont mappés vers les paramètres de requête d'URL HTTP et les en-têtes HTTP, comme ci-dessous. Par exemple, si vous possédez un paramètre système $foo, il est mappé vers ?$foo=xxx dans l'URL (URL encodée sur le réseau en tant que ?%24foo=xxx).

REMARQUE : Le préfixe " $" est ajouté pour éviter tout conflit avec les paramètres de requête habituels.

Mise en correspondance gRPC

Pour gRPC, les paramètres système sont envoyés via des en-têtes de requête HTTP habituels. Pour en savoir plus, consultez le tableau ci-dessous.

Définitions

Le tableau suivant répertorie tous les paramètres système et leurs définitions.

Paramètre de requête d'URL En-tête HTTP/gRPC Description
access_token,
oauth_token
Authorization Jeton d'accès OAuth 2.0. Pour en savoir plus, consultez le Guide d'authentification de Cloud Platform.
$alt,
alt
Format de réponse alternatif. Les valeurs compatibles sont json (par défaut), media, proto (protobuf binaire).
$.xgafv Format d'erreur JSON. Les valeurs compatibles sont 1, 2 (par défaut). Le format d'erreur 1 ne doit être utilisé que par les anciens clients.
$callback,
callback
Paramètre de rappel JSONP.
$ct Content-Type Remplacement d'en-tête de l'élément Content-Type HTTP.
$fields,
fields
X-Goog-FieldMask Masque de champ (google.protobuf.FieldMask) utilisé pour le filtrage des réponses. Si ce paramètre n'est pas spécifié, tous les champs seront renvoyés.
$httpMethod X-HTTP-Method-Override La méthode HTTP prévue pour la requête. Certains serveurs proxy n'acceptent pas toutes les méthodes HTTP.
$key,
key
X-Goog-Api-Key Clé API Google, consultez les détails sur https://developers.google.com/console/help/#generatingdevkeys.
passwd,
password
Sert exclusivement à éviter de saisir des mots de passe dans les URL.
$prettyPrint,
prettyPrint
Imprime la version correctement formatée de la réponse JSON. Les valeurs possibles sont true ou false.
$outputDefaults Force la sortie des valeurs proto par défaut pour les réponses JSON.
$unique Paramètre de requête unique permettant de désactiver la mise en cache des requêtes.
X-Goog-Api-Client Identification du client de l'API. La valeur est une liste de chaînes NAME "/" SEMVER séparées par un espace, où NAME ne doit contenir que des lettres minuscules, des chiffres et "-", et où SEMVER doit être une chaîne de version sémantique. Par exemple, pour Client X-Goog-Api : python/3.5.0 grpc-google-pubsub-v1/0.1.0-beta2 linux/2.7.0.
$userProject X-Goog-User-Project Projet spécifié par l'appelant à des fins de quota et de facturation. L'appelant doit disposer de l'autorisation serviceusage.services.use sur le projet.