La plataforma de APIs de Google define parámetros del sistema para controlar la funcionalidad común en las APIs de REST y gRPC, como claves de API, máscaras de campos de respuesta, atribución de cuota y formato JSON. Según el protocolo, pasas los parámetros del sistema a un servicio como parámetros de consulta de URL o encabezados HTTP. Puedes especificar estos parámetros directamente cuando escribes código personalizado, aunque herramientas como las bibliotecas cliente proporcionadas por Google controlan muchos de ellos automáticamente.
Asignación HTTP
Para las solicitudes HTTP, los parámetros del sistema se envían como parámetros de consulta de URL o encabezados de solicitud HTTP. Por ejemplo, si tienes el parámetro del sistema $foo, se envía como ?$foo=xxx en la URL o ?%24foo=xxx si está codificado como URL. Consulta la siguiente tabla para obtener más detalles.
Asignación de gRPC
Para las solicitudes de gRPC, los parámetros del sistema se envían como encabezados de la solicitud HTTP con claves en minúscula. Consulta la siguiente tabla para obtener más detalles.
Definiciones
En la siguiente tabla, se enumeran todos los parámetros del sistema y sus definiciones.
| Parámetro de consulta de URL | Encabezado HTTP/gRPC | Descripción |
|---|---|---|
Authorization |
Credenciales de autenticación. Consulta Descripción general de la autenticación para obtener más información. | |
$alt,alt |
Formato de respuesta alternativa. Los valores admitidos son json (predeterminado), media, proto y sse (transmisiones JSON). |
|
$apiVersion |
X-Goog-Api-Version |
La versión de la API que se usará. No todas las APIs admiten este parámetro: consulta la documentación de la API antes de usarlo. |
$.xgafv |
Es el formato de error JSON. Los valores admitidos son 1 y 2 (predeterminado). El formato de error 1 solo debe usarse en las bibliotecas cliente de la API de Google. |
|
$callback,callback |
Parámetro de devolución de llamada de JSONP. | |
$ct |
Content-Type |
Es la anulación del encabezado de la solicitud del tipo de contenido HTTP. |
$fields,fields |
X-Goog-FieldMask |
FieldMask que se usa para el filtrado de respuestas. Si está vacío, se deben mostrar todos los campos, a menos que se indique lo contrario en la documentación. |
X-HTTP-Method-Override |
El método HTTP previsto para la solicitud. Algunos proxies de red no aceptan todos los métodos HTTP. | |
$key,key |
X-Goog-Api-Key |
Clave de API de Google. Consulta https://cloud.google.com/docs/authentication/api-keys para obtener más información. |
passwd,password |
Es un parámetro reservado para evitar poner contraseñas en URL. | |
$prettyPrint,prettyPrint |
Es la respuesta de JSON en un formato legible. Los valores admitidos son true y false (predeterminado). |
|
quotaUser |
X-Goog-Quota-User |
Un identificador de usuario falso para cobrar cuotas por usuario. Si no se especifica, se usa la principal autenticada. Si no hay una principal autenticada, se usará la dirección IP del cliente. Cuando se especifica, se debe usar una clave de API válida con restricciones del servicio para identificar el proyecto de cuota. De lo contrario, se ignora este parámetro. |
$outputDefaults |
Se generan valores predeterminados proto para las respuestas de JSON. | |
$unique |
Parámetro de consulta único para inhabilitar el almacenamiento en caché de solicitudes. | |
X-Goog-Api-Client |
Es la identificación del cliente de API. El valor es una lista separada por espacios de strings NAME "/" SEMVER, en la que NAME solo debe contener letras minúsculas, dígitos y guiones, y SEMVER debe ser una string de versión semántica. Por ejemplo: X-Goog-Api-Client: python/3.5.0 grpc-google-pubsub-v1/0.1.0-beta2 linux/2.7.0. |
|
X-Goog-Request-Reason |
Contiene un motivo para realizar la solicitud, que se debe registrar en el registro de auditoría. Un motivo de ejemplo sería un número de ticket de casos de ayuda. En el caso de los registros de auditoría, los caracteres del motivo determinan si este se codifica en base64 antes de adjuntarse a la entrada de registro. Los motivos que incluyen solo letras, dígitos y espacios se conservan en texto sin formato. Los motivos que incluyen otros caracteres se codifican en base64. | |
$userProject |
X-Goog-User-Project |
Un proyecto especificado por el emisor para fines de cuota y facturación. El llamador debe tener el permiso serviceusage.services.use en el proyecto. |
X-Server-Timeout |
Es el tiempo de espera (expresado en segundos con un número de punto flotante) para que el servidor termine de procesar la solicitud. Este parámetro del sistema solo se aplica a las APIs de REST para las que no corresponde el tiempo de espera del cliente. | |
x-goog-request-params |
Pasa parámetros adicionales para las solicitudes de gRPC. El valor debe ser una cadena de consulta de URL codificada (p.ej., key1=value1&key2=value2).Las claves y los valores específicos admitidos en este encabezado dependen del servicio y el método de la API de Google individuales que se llamen. No hay un conjunto único y universal de parámetros para este encabezado. Siempre consulta la documentación de la API específica con la que interactúas para determinar qué parámetros son compatibles o necesarios. Los usos comunes incluyen los siguientes:
x-goog-request-params: name=projects/my-project/locations/us-central1&foo=bar |
Registro de cambios
- 2026-10 Se publicó la documentación de
X-Goog-Api-Version. - 2026-06 Se actualizó la documentación de
x-goog-request-params. - 2021-11 Se publicó la documentación de
x-goog-request-params. - 2021-02 Se publicó la documentación de
quotaUser. - Parámetros de consulta obsoletos de OAuth 2.0 de 2020-07.
- 2019-10 Se incorporó el parámetro del sistema
X-Server-Timeout. - 2017-10 Se incorporó el parámetro del sistema
X-Goog-User-Project.