La plataforma de la API de Google proporciona un conjunto de funcionalidades comunes a todas las API de Google creadas con la plataforma. Para usarlas y controlarlas, la plataforma cuenta con un conjunto predefinido y especial de parámetros de solicitudes, que se conocen como parámetros del sistema. Estos parámetros están disponibles en todas las API de REST y de gRPC de Google. Además, se pueden especificar mediante un parámetro de búsqueda HTTP o un encabezado HTTP. Para las API de gRPC de Google, solo se admiten los encabezados HTTP.
La mayoría de los usuarios no necesitarán usar estos parámetros directamente. Sin embargo, las bibliotecas cliente que proporciona Google los suelen usar. Si necesitas escribir un código personalizado a fin de acceder de forma directa a las API de Google, los parámetros del sistema pueden ser útiles para realizar tareas como el control de impresión con sangría de JSON o la especificación de claves de API.
Asignación HTTP
Para las solicitudes HTTP, los parámetros del sistema se envían como parámetros de búsqueda de URL o encabezados de solicitudes 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 gRPC
Para las solicitudes gRPC, los parámetros del sistema se envían como encabezados de solicitudes HTTP con claves en minúsculas. 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). |
|
$.xgafv |
Es el formato de error JSON. Los valores admitidos son 1 y 2 (predeterminado). Solo las bibliotecas cliente de la API de Google deben usar el formato de error 1. |
|
$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 se usa para filtrar respuestas. Si está vacío, se deben mostrar todos los campos, a menos que se documente lo contrario. |
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 Para obtener más información, consulta https://cloud.google.com/docs/authentication/api-keys. |
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 seudo identificador de usuario 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 de 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 |
Identificación de la API de cliente. 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. | |
$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 es válido para las API de REST a las que no se aplica el tiempo de espera del cliente. | |
x-goog-request-params |
Pasar parámetros adicionales para las solicitudes de gRPC en formato de consulta de URL Por ejemplo: x-goog-request-params: service=pubsub.googleapis.com&release=2021-11-01r0. |
Registro de cambios
- 11-2021: Se publicó la documentación de
x-goog-request-params. - 2 de febrero de 2021. 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.