Parâmetros do sistema

A plataforma de APIs do Google oferece um conjunto de funcionalidades em comum para todas as APIs do Google criadas nela. Para usar e controlar essa funcionalidade, a plataforma pré-define um conjunto especial de parâmetros de solicitação chamados parâmetros do sistema. Esses parâmetros estão disponíveis em todas as APIs REST do Google e APIs gRPC. Um parâmetro do sistema pode ser especificado usando um parâmetro de consulta HTTP ou um cabeçalho HTTP. Somente os cabeçalhos HTTP são compatíveis com APIs gRPC do Google.

A maioria dos usuários não precisará usar esses parâmetros. No entanto, muitas vezes eles são usados pelas bibliotecas de cliente fornecidas pelo Google. Se você precisar escrever um código personalizado para acessar as APIs do Google diretamente, os parâmetros do sistema poderão ser úteis em casos como o controle de pretty-printing do JSON ou a especificação de chaves de API.

Mapeamento de HTTP

Para solicitações HTTP, os parâmetros do sistema são enviados como parâmetros de consulta de URL ou cabeçalhos de solicitação HTTP. Por exemplo, se você tiver um parâmetro do sistema $foo, ele será enviado como ?$foo=xxx no URL ou ?%24foo=xxx se codificado por URL. Veja mais detalhes na tabela abaixo.

Observação: o prefixo "$" é adicionado para evitar conflitos com parâmetros de solicitação normais.

Mapeamento da gRPC

Para solicitações gRPC, os parâmetros do sistema são enviados como cabeçalhos de solicitação HTTP com chaves em letras minúsculas. Veja mais detalhes na tabela abaixo.

Definições

A tabela a seguir lista todos os parâmetros do sistema e as definições deles.

Parâmetro de consulta do URL Cabeçalho HTTP/gRPC Descrição
Autorização Token de acesso do OAuth 2.0. Consulte o Guia de autenticação do Cloud Platform para mais detalhes.
$alt,
alt
Formato de resposta alternativo. Os valores aceitos são json (padrão), media, proto (protobuf binário).
$.xgafv Formato de erro JSON. Os valores aceitos são 1, 2 (padrão). O formato de erro 1 só deve ser usado por clientes legados.
$callback,
callback
Parâmetro de callback JSONP.
$ct Tipo de conteúdo Substituição de cabeçalho de tipo de conteúdo HTTP.
$fields,
fields
X-Goog-FieldMask FieldMask(google.protobuf.FieldMask) usado para filtragem de resposta. Se estiver vazio, todos os campos serão retornados.
$httpMethod X-HTTP-Method-Override O método HTTP pretendido para a solicitação. Alguns proxies de rede não aceitam todos os métodos HTTP.
$key,
key
X-Goog-Api-Key Chave de API do Google, veja detalhes em https://cloud.google.com/docs/authentication/api-key.
passwd,
password
Reservado para evitar a colocação de senhas nos URLs.
$prettyPrint,
prettyPrint
Resposta de pretty-print do JSON. Os valores aceitos são true, false. O valor padrão é true.
$outputDefaults Força a saída de valores proto padrão para respostas do JSON.
$unique Parâmetro de consulta exclusivo para desativar o armazenamento de consultas em cache.
X-Goog-Api-Client Identificação do cliente da API. O valor é uma lista separada por espaços de strings NAME "/" SEMVER, em que NAME deve conter apenas letras minúsculas, dígitos e "-", e SEMVER deve ser uma string de versão semântica. Por exemplo: 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 Um projeto especificado pelo autor da chamada para fins de cotas e faturamento. O autor da chamada precisa ter a permissão serviceusage.services.use no projeto.
Tempo limite do servidor X Tempo limite (em segundos, valor flutuante) para o servidor concluir o processamento da solicitação. Esse parâmetro do sistema se aplica somente a APIs REST para as quais o tempo limite do cliente não é aplicável.