Introdução à API AdMob

Este guia é destinado a desenvolvedores que querem usar a API AdMob para receber dados de maneira programática na conta da AdMob.

Todas as chamadas da API Google AdMob precisam ser autorizadas pelo OAuth2 para que seu app possa interagir com serviços da Web em nome do usuário. O OAuth2 permite que o app cliente da API AdMob acesse a conta de um usuário sem precisar processar ou armazenar o nome de usuário ou a senha dele. Para uma visão geral da autorização, consulte Autorização.

Siga estas etapas para gerar as credenciais do OAuth2 e fazer sua primeira solicitação.

Pré-requisitos

Determinar seu tipo de autenticação

Confira na tabela abaixo qual tipo de autenticação é mais adequado para seu app:

Escolher o tipo de autenticação OAuth2 Se...
App para computador
  • Você está gerenciando todas as suas contas da API AdMob usando uma única conta de administrador de nível superior.
  • Você é um usuário novo ou quer começar rapidamente com a configuração mais simples.
  • Seu app autentica apenas usuários da Google AdMob em uma máquina.
Web app
  • Você quer se autenticar como um usuário que pode conceder permissão ao seu app para acessar os dados da conta da API AdMob.
  • Você quer gerar várias credenciais de autorização com facilidade para gerenciar contas de terceiros, por exemplo.
  • Seu app exige URLs de callback, que não são compatíveis com o fluxo de apps para computador.

Criar um projeto

Para começar a usar a API AdMob, primeiro crie ou selecione um projeto no console de APIs do Google e ative a API usando a ferramenta de configuração, que orienta você pelo processo e ativa a API AdMob automaticamente.

Como ativar a API para um projeto existente

As etapas a seguir se aplicam aos usuários com um projeto que preferem ativar manualmente a API AdMob.

Para ativar uma API para um projeto, faça o seguinte:

  1. Open the API Library no Google API Console.
  2. If prompted, select a project, or create a new one. A API Library lista todas as APIs disponíveis, agrupadas por família de produtos e popularidade.
  3. Se a API que você quer ativar não estiver visível na lista, use a pesquisa para encontrá-la ou clique em Ver tudo na família de produtos a que ela pertence.
  4. Selecione aquela que você quer habilitar e clique no botão Ativar.
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

Criar credenciais do OAuth2

As instruções a seguir indicam o processo de criação de um ID do cliente OAuth 2.0 para usar com o fluxo de apps instalados.

  1. Go to the Clients page.

  2. Clique em CRIAR CREDENCIAIS > ID do cliente OAuth.

    Se você não tiver configurado uma tela de consentimento do OAuth para o projeto, receberá instruções para fazer isso. Clique em CONFIGURAR TELA DE CONSENTIMENTO. Há várias maneiras de configurar a tela de permissão para usar seu ID do cliente OAuth 2.0.

    1. Defina o tipo de usuário como Externo e o status de publicação como Publicado.

    2. Ou defina o tipo de usuário como Externo e o status de publicação como Teste. Em seguida, adicione Usuários de teste selecionando Adicionar usuários para dar acesso ao ID do cliente OAuth 2.0.

      Confira mais informações sobre como configurar a tela de consentimento OAuth.

  3. Selecione App para computador ou Aplicativo da Web como o tipo de aplicativo, atribua um nome a ele e clique em Criar.

Quando terminar, você vai receber um ID do cliente OAuth 2.0 e uma chave secreta do cliente, que podem ser baixados no formato JSON e salvos para uso posterior.

Fazer uma solicitação

A API AdMob é criada com base em HTTP e JSON. Dessa forma, qualquer cliente HTTP padrão pode enviar solicitações a ela e analisar as respostas. No entanto, as bibliotecas de cliente da API do Google oferecem melhor integração de linguagem, mais segurança e suporte para fazer solicitações autorizadas. As bibliotecas de cliente estão disponíveis em várias linguagens de programação. Ao usá-las, não é preciso configurar as solicitações HTTP nem analisar as respostas manualmente.

Depois de criar as credenciais do OAuth 2.0, você poderá começar a usar a API AdMob. Para solicitar acesso usando o OAuth 2.0, seu app também precisa de informações de escopo:

Escopo Significado
https://www.googleapis.com/auth/admob.readonly Ver todos os dados da AdMob. Esses dados podem incluir informações da sua conta, configurações de inventário e mediação, relatórios e outros. Dados confidenciais, como pagamentos ou detalhes da campanha, não serão incluídos.
https://www.googleapis.com/auth/admob.report Ver relatórios de ganhos e desempenho de anúncios. Consulte o ID do publisher, o fuso horário e o código da moeda padrão.

Faça sua primeira solicitação para gerar um relatório usando exemplos em Java, PHP, Python ou curl.

Revogar tokens compartilhados

É possível revogar tokens compartilhados de duas maneiras:

  1. Acesse a página de permissões da sua Conta do Google e revogue o acesso do projeto relevante.

  2. Como alternativa, é possível revogar tokens de aplicativos da Web usando a API Google Identity.