La plataforma de APIs de Google proporciona un conjunto de funciones comunes a todas las APIs de Google creadas con la plataforma. Para usar y controlar estas funciones, la plataforma predefine un conjunto especial de parámetros de solicitud llamados parámetros del sistema. Estos parámetros están disponibles en todas las APIs REST y gRPC de Google. Un parámetro de sistema se puede especificar mediante un parámetro de consulta HTTP o un encabezado HTTP. En el caso de las APIs gRPC de Google, solo se admiten encabezados HTTP.
La mayoría de los usuarios no necesitarán usar estos parámetros directamente. Sin embargo, las bibliotecas de cliente que proporciona Google las suelen usar. Si necesitas escribir código personalizado para acceder directamente a las APIs de Google, los parámetros del sistema pueden ser útiles en casos como controlar la impresión bonita de JSON o especificar claves de API.
Asignación HTTP
En las solicitudes HTTP, los parámetros del sistema se envían como parámetros de consulta de URL o como encabezados de solicitud HTTP. Por ejemplo, si tiene un parámetro de sistema $foo, se envía como ?$foo=xxx en la URL o como ?%24foo=xxx si está codificado como URL. Consulta los detalles en la tabla de abajo.
Asignación de gRPC
En el caso de las solicitudes gRPC, los parámetros del sistema se envían como encabezados de solicitud HTTP con claves en minúsculas. En la tabla siguiente puedes ver más detalles.
Definiciones
En la tabla siguiente 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 la descripción general de la autenticación para obtener más información. | |
$alt,alt |
Formato de respuesta alternativo. Los valores admitidos son json (valor predeterminado), media, proto y sse (flujos JSON). |
|
$.xgafv |
Formato de error JSON. Los valores admitidos son 1 y 2 (valor predeterminado). El formato de error 1 solo deben usarlo las bibliotecas de cliente de las APIs de Google. |
|
$callback,callback |
Parámetro de retrollamada JSONP. | |
$ct |
Content-Type |
Anulación del encabezado de solicitud HTTP Content-Type. |
$fields,fields |
X-Goog-FieldMask |
FieldMask se usa para filtrar las respuestas. Si está vacío, se deben devolver todos los campos, a menos que se indique lo contrario. |
X-HTTP-Method-Override |
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 |
Reservado para evitar que se incluyan contraseñas en las URLs. | |
$prettyPrint,prettyPrint |
Imprime la respuesta JSON de forma legible. Los valores admitidos son true (valor predeterminado) y false. |
|
quotaUser |
X-Goog-Quota-User |
Un identificador de usuario seudónimo para aplicar cuotas por usuario. Si no se especifica, se usa la entidad autenticada. Si no hay ningún principal autenticado, se usará la dirección IP del cliente. Si se especifica, se debe usar una clave de API válida con restricciones de servicio para identificar el proyecto de cuota. De lo contrario, este parámetro se ignora. |
$outputDefaults |
Fuerza la salida de los valores predeterminados de proto en las respuestas JSON. | |
$unique |
Parámetro de consulta único para inhabilitar el almacenamiento en caché de solicitudes. | |
X-Goog-Api-Client |
Identificación del cliente de la API. El valor es una lista de cadenas NAME "/" SEMVER separadas por espacios, donde NAME solo debe contener letras minúsculas, números y "-", y SEMVER debe ser una cadena 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 hacer la solicitud, que se registrará en el registro de auditoría. Por ejemplo, el número de una incidencia de asistencia. 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 del registro. Los motivos que solo incluyan letras, dígitos y espacios se conservarán en texto sin formato. Los motivos que incluyen otros caracteres están codificados en Base64. | |
$userProject |
X-Goog-User-Project |
Proyecto especificado por la persona que llama para la cuota y la facturación. El llamador debe tener el permiso serviceusage.services.use en el proyecto. |
X-Server-Timeout |
Tiempo de espera (en segundos, valor flotante) para que el servidor termine de procesar la solicitud. Este parámetro del sistema solo se aplica a las APIs REST para las que no se aplica el tiempo de espera del lado del cliente. | |
x-goog-request-params |
Transfiere 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
- 2021-11 Se publica la documentación de
x-goog-request-params. - 2021-02 Se publica la documentación de
quotaUser. - Julio del 2020: se han retirado los parámetros de consulta de OAuth 2.0.
- 2019-10 Se ha introducido el parámetro del sistema
X-Server-Timeout. - 2017-10 Se ha introducido el parámetro del sistema
X-Goog-User-Project.