Parâmetros de consulta padrão

Os parâmetros de consulta aplicados a todas as operações da Google Cloud Billing API são mostrados na tabela a seguir.

Notas sobre chaves de API e tokens de autenticação:

  1. O parâmetro key é obrigatório em todas as solicitações, a não ser que você forneça um token 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. OAuth 2.0 é o único protocolo de autorização compatível.
  3. É possível fornecer um token OAuth 2.0 com qualquer solicitação, de uma das duas maneiras:
    • Com o parâmetro de consulta access_token, como este: ?access_token=oauth2-token
    • Com o cabeçalho HTTP Authorization, como este: Authorization: Bearer oauth2-token

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

Parâmetro Significado Observações
access_token Token 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 JSON-P do JavaScript.
key Chave de API. (OBRIGATÓRIO*)
  • *Esse parameter é 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.
  • Encontre a chave de API do projeto no Console do Google Cloud Platform.
prettyPrint

Retorna uma resposta com recuos e quebras de linha.

  • Retorna a resposta em um formato legível se for true.
  • Valor padrão: true.
  • Quando o parameter está configurado como false, o tamanho do payload da resposta pode ser reduzido, melhorando o desempenho em alguns ambientes.
quotaUser Alternativa para userIp.
  • Com esse parameter, aplique 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.
  • Substitui userIp se ambos são fornecidos.
  • Saiba mais sobre Como limitar o uso da API.
userIp Endereço IP do usuário final para o qual a chamada de API está sendo feita.
  • Com ele, aplique cotas por usuário ao chamar a API de um aplicativo no lado do servidor.
  • Saiba mais sobre Como limitar o uso da API.

Esta página foi útil? Conte sua opinião sobre: