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 de REST de Google y las API de gRPC. Un parámetro del sistema se puede especificar con 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 los protocolos HTTP, los parámetros del sistema se asignan a los parámetros de consulta de la URL HTTP y los encabezados HTTP, consulta la información que se ofrece a continuación. Por ejemplo, si tienes un parámetro del sistema $foo, se asigna a ?$foo=xxx en la URL (codificado como URL en conexión como ?%24foo=xxx).

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

Asignación gRPC

Para gRPC, los parámetros del sistema se envían a través de encabezados de solicitud HTTP normales. Consulta la tabla que se encuentra a continuación para obtener más información.

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
access_token,
oauth_token
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 La clave de API de Google, consulta los detalles en https://developers.google.com/console/help/#generatingdevkeys.
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.
$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 de strings NAME "/" SEMVER separada por espacios, en la que el NAME solo debe contener letras en minúsculas, dígitos y “-”, y el 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.
$userProject X-Goog-User-Project Un proyecto especificado por el emisor para fines de cuota y facturación. El emisor debe tener el permiso serviceusage.services.use en el proyecto.
¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...