La plate-forme d'API de Google définit des paramètres système pour contrôler les fonctionnalités communes aux API REST et gRPC, telles que les clés API, les masques de champ de réponse, l'attribution de quotas et la mise en forme JSON. Selon le protocole, vous transmettez les paramètres système à un service en tant que paramètres de requête URL ou en-têtes HTTP. Vous pouvez spécifier ces paramètres directement lorsque vous écrivez du code personnalisé, bien que des outils tels que les bibliothèques clientes fournies par Google en gèrent automatiquement un grand nombre.
Mise en correspondance 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.
Mise en correspondance 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 acceptées sont json (par défaut), media, proto, sse (flux JSON). |
|
$apiVersion |
X-Goog-Api-Version |
Version de l'API à utiliser. Toutes les API ne sont pas compatibles avec ce paramètre. Consultez la documentation de l'API avant de l'utiliser. |
$.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 de l'en-tête de 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 |
Méthode HTTP prévue pour la requête. Certains proxys réseau 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 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 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 de requête, destiné à être enregistré dans la journalisation d'audit. Un exemple de motif serait un numéro de ticket de demande d'assistance. Pour les journaux d'audit, les caractères du motif déterminent si le motif est encodé en base64 avant d'être associé à l'entrée de journal. Les motifs qui ne contiennent que des lettres, des chiffres et des espaces sont conservés en texte brut. Les motifs qui incluent d'autres caractères sont encodés en base64. | |
$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 |
Transmission de paramètres supplémentaires pour les requêtes gRPC. La valeur doit être encodée en tant que chaîne de requête URL (par exemple, key1=value1&key2=value2).Les clés et valeurs spécifiques compatibles avec cet en-tête dépendent du service et de la méthode d'API Google individuels appelés. Il n'existe pas d'ensemble unique et universel de paramètres pour cet en-tête. Consultez toujours la documentation de l'API spécifique avec laquelle vous interagissez pour déterminer les paramètres compatibles ou obligatoires. Voici quelques utilisations courantes :
x-goog-request-params: name=projects/my-project/locations/us-central1&foo=bar |
Journal des modifications
- 10/2026 Documentation publiée pour
X-Goog-Api-Version. - 06/2026 Documentation mise à jour pour
x-goog-request-params. - 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.