Parâmetros de consulta padrão

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

Observações (sobre chaves de API e tokens de autorização):

  1. O parâmetro key é obrigatório em todas as solicitações, a menos que você forneça um token OAuth 2.0 com a solicitação.
  2. É necessário enviar um token de autorização com todas as solicitações marcadas com (AUTHENTICATED). OAuth 2.0 é o protocolo de autorização preferencial.
  3. Você pode fornecer um token OAuth 2.0 com qualquer solicitação da seguinte maneira:
    • Usando o parâmetro de consulta access_token como este: ?access_token=oauth2-token
    • Usando 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 do usuário atual.
callback Função de retorno.
  • Nome da função de retorno JavaScript que trata a resposta.
  • Usado em solicitações JavaScript JSON-P.
fields Seletor que especifica um subconjunto de campos a serem incluídos na resposta.
  • Para mais informações, consulte a seção resposta parcial no documento “Dicas de desempenho”.
  • Use tendo em vista um melhor desempenho.
key Chave de API. (OBRIGATÓRIO*)
  • *Obrigatório, a menos que você forneça um token OAuth 2.0.
  • Sua chave de API identifica o projeto e fornece acesso à API, cota e aos relatórios.
  • Receba a chave de API de seu projeto no Google Developers Console.
prettyPrint

Retorna uma resposta com indentações e quebras de linha.

  • Retorna a resposta em um formato legível por humanos se true.
  • Valor padrão: false.
  • Quando for false, o tamanho da carga útil da resposta poderá ser reduzido, o que poderá resultar em um melhor desempenho em alguns ambientes.
quotaUser Alternativa para userIp.
  • Permite que você aplique cotas por usuário em um aplicativo do servidor mesmo em casos nos quais o endereço IP do usuário seja desconhecido. Isso pode ocorrer, por exemplo, com aplicativos que realizam tarefas cron no App Engine em nome de um usuário.
  • Você pode escolher qualquer string arbitrária que identifique um usuário com exclusividade, mas ela está limitada a 40 caracteres.
  • Substitui userIp caso ambos sejam fornecidos.
  • Saiba mais sobre o uso de limites.
userIp O endereço IP do usuário final para o qual a chamada da API está sendo feita.
  • Permite que você aplique cotas por usuário durante a chamada da API em um aplicativo do servidor.
  • Saiba mais sobre o uso de limites.