Parâmetros de consulta padrão

Os parâmetros de consulta que se aplicam a todas as operações da API Cloud Billing são mostrados na tabela abaixo.

Observações sobre chaves de API e tokens de autenticação:

  1. O parâmetro key é necessário com todas as solicitações, a não ser que você forneça um token do OAuth 2.0 com a solicitação.
  2. É obrigatório enviar um token de autorização com as solicitações que exigem um escopo do OAuth. O OAuth 2.0 é o único protocolo de autorização compatível.
  3. É possível fornecer um token do OAuth 2.0 com qualquer solicitação:
    • usando o parâmetro de consulta access_token desta forma: ?access_token=oauth2-token;
    • usando o cabeçalho HTTP Authorization desta forma: Authorization: Bearer oauth2-token.

Todos os parâmetros são opcionais, exceto quando indicado.

Parâmetro Significado Observações
access_token O token do OAuth 2.0 para o usuário atual.
callback Função de retorno de chamada.
  • Nome da função de retorno de chamada JavaScript que lida com a resposta.
  • Usado em solicitações JavaScript JSON-P.
key Chave de API. (OBRIGATÓRIO*)
  • *Obrigatório, a menos que você forneça um token do OAuth 2.0.
  • A chave de API é usada para identificar o projeto, além de fornecer cotas, relatórios e acesso à API.
  • Veja a chave de API do seu projeto no Console do Google Cloud.
prettyPrint

Retorna uma resposta com recuos e quebras de linha.

  • Retornará a resposta em formato legível se for true.
  • Valor padrão: true.
  • Se for false, o tamanho do payload da resposta poderá ser reduzido, o que talvez melhore o desempenho em alguns ambientes.
quotaUser Alternativa para userIp.
  • Permite aplicar cotas por usuário de um aplicativo no lado do servidor, mesmo quando o endereço IP do usuário não for conhecido. Isso pode ocorrer, por exemplo, com aplicativos que executam cron jobs no App Engine em nome de um usuário.
  • Escolha qualquer string arbitrária que identifique um usuário de maneira exclusiva e que tenha até 40 caracteres.
  • Substituirá userIp se ambos forem fornecidos.
  • Saiba mais sobre Como limitar a utilização da API.
userIp Endereço IP do usuário final para o qual a chamada de API está sendo feita.