Parámetros del sistema

La plataforma de la API de Google proporciona un conjunto de funcionalidades comunes a todas las API de Google creadas con la plataforma. Para usar y controlar esa funcionalidad, 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 API REST de Google y API gRPC. Se puede especificar un parámetro del sistema utilizando un parámetro de consulta 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, los suelen usar las bibliotecas cliente proporcionadas por Google. 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 consulta URL o encabezados de solicitud HTTP. Por ejemplo, si tiene un parámetro del sistema $foo, se envía como ?$foo=xxx en la URL, o ?%24foo=xxx si está codificado en URL. Mira la tabla de abajo para más detalles.

NOTA: El prefijo “$$” se agrega para evitar conflictos con los parámetros de solicitud normales.

Asignación gRPC

Para las solicitudes gRPC, los parámetros del sistema se envían como encabezados de solicitud HTTP con claves en minúsculas. Mira la tabla de abajo para 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
Autorización Token de acceso de OAuth 2.0. Consulta la Guía de autenticación de Cloud Platform para obtener más información.
$alt,
alt
Formato de respuesta alternativa. Los valores admitidos son json (predeterminado), media, proto (protobuf binario).
$.xgafv Formato de error JSON. Los valores admitidos son 1, 2 (predeterminado). Solo los clientes heredados deben usar el formato de error 1 .
$callback,
callback
Parámetro de devolución de llamada de JSONP.
$ct Tipo de contenido Anulación del encabezado HTTP del tipo de contenido.
$fields,
fields
X-Goog-FieldMask FieldMask(google.protobuf.FieldMask) se usa para filtrar respuestas. Si está vacío, se mostrarán todos los campos.
$httpMethod 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 API de Google, consulte los detalles en https://cloud.google.com/docs/authentication/api-keys.
passwd,
password
Reservado para evitar poner contraseñas en las URL.
$prettyPrint,
prettyPrint
Respuesta de la impresión con sangría de JSON. Los valores admitidos son true, false. El valor predeterminado es true.
$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 cadenas NAME "/" SEMVER, donde NAME solo debe contener letras minúsculas, dígitos 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.
$userProject X-Goog-User-Project Un proyecto especificado por el emisor para fines de cuota y facturación. La persona que llama debe tener 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 API REST para las cuales el tiempo de espera del lado del cliente no es aplicable.