Paramètres système

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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 HTTP 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. Toutefois, ils sont souvent utilisées 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.

Mappage HTTP

Pour les requêtes HTTP, les paramètres système sont envoyés en tant que paramètres de requête URL ou en-têtes de requête HTTP. Par exemple, si vous disposez d'un paramètre système $foo, il est envoyé en tant que ?$foo=xxx dans l'URL ou ?%24foo=xxx s'il est encodé au format URL. Pour en savoir plus, consultez le tableau ci-dessous.

Mappage gRPC

Pour les requêtes gRPC, les paramètres système sont envoyés en tant qu'en-têtes de requête HTTP avec des clés en minuscules. 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
Authorization Identifiants d'authentification. Consultez la section Présentation de l'authentification pour en savoir plus.
$alt,
alt
Format de réponse alternatif. Les valeurs compatibles sont json (par défaut), media, proto.
$.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 bibliothèques clientes des API Google.
$callback,
callback
Paramètre de rappel JSONP.
$ct Content-Type Remplacement d'en-tête de la requête HTTP Content-Type.
$fields,
fields
X-Goog-FieldMask FieldMask utilisé pour le filtrage des réponses. Si ce paramètre n'est pas spécifié, tous les champs doivent être renvoyés, sauf indication contraire.
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 la page https://cloud.google.com/docs/authentication/api-keys pour plus de détails.
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 compatibles sont true (par défaut) et false.
quotaUser X-Goog-Quota-User Pseudo-identifiant utilisateur pour la facturation des quotas par utilisateur. S'il n'est pas spécifié, le compte principal authentifié est utilisé. En l'absence de compte principal authentifié, l'adresse IP du client est utilisée. Lorsque le paramètre est spécifié, une clé API valide comportant des restrictions de service doit être utilisée pour identifier le projet de quota. Dans le cas contraire, ce paramètre est ignoré.
$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 des espaces, 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 X-Goog-Api-Client : python/3.5.0 grpc-google-pubsub-v1/0.1.0-beta2 linux/2.7.0.
X-Goog-Request-Reason Contient un motif pour la requête, qui doit être enregistré dans la journalisation d'audit. Un exemple de motif serait un numéro de ticket de demande d'assistance.
$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.
X-Server-Timeout Délai d'attente (en secondes, valeur flottante) pour que le serveur termine le traitement de la requête. Ce paramètre système ne s'applique qu'aux API REST pour lesquelles le délai d'attente côté client n'est pas applicable.
x-goog-request-params Transmet des paramètres supplémentaires pour les requêtes gRPC au format de requête d'URL. Par exemple : x-goog-request-params: service=pubsub.googleapis.com&release=2021-11-01r0.

Changelog

  • 11/2021 Documentation publiée pour x-goog-request-params.
  • 02/2021 Documentation publiée pour quotaUser.
  • 07/2020 Paramètres de requête OAuth 2.0 obsolètes.
  • 10/2019 Introduction du paramètre système X-Server-Timeout.
  • 10/2017 Introduction du paramètre système X-Goog-User-Project.