Primeiros passos com a API AdMob

Este guia é destinado a desenvolvedores que querem usar a API AdMob para receber informações sobre a conta da AdMob de maneira programática.

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

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

Pré-requisitos

Determinar o tipo de autenticação

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

Escolher o tipo de autenticação do OAuth2 Se...
App para computador
  • Você estiver gerenciando todas as suas contas da API AdMob usando uma única conta de administrador de nível superior.
  • for um usuário iniciante ou quiser começar rapidamente com a configuração mais simples.
  • Seu app só autentica os usuários da Google AdMob em uma máquina.
App da Web
  • Você quer fazer a autenticação como um usuário que pode conceder permissão ao seu app para acessar os dados da conta da API AdMob.
  • quiser facilmente gerar várias credenciais de autorização para gerenciar contas de terceiros, por exemplo;
  • Seu app exige URLs de callback. Esses URLs não são compatíveis com o fluxo do app 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 usando a ferramenta de configuração, que orienta você no processo e ativa a API AdMob automaticamente.

Como ativar a API para um projeto atual

As etapas a seguir se aplicam aos usuários que têm um projeto e preferem ativar a API AdMob manualmente.

Para habilitar uma API para o seu projeto:

  1. Open the API Library no Google API Console .
  2. If prompted, select a project, or create a new one. O API Library lista todas as APIs disponíveis, agrupadas por família de produtos e popularidade.
  3. Se a API que você deseja ativar não estiver visível na lista, use a pesquisa para encontrá-la ou clique em Ver tudo na família de produtos à qual pertence.
  4. Selecione a API que você deseja ativar 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 orientam você no processo de criação de um ID do cliente OAuth 2.0 para usar com o fluxo de apps instalados.

  1. Go to the Credentials page.

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

    Se você ainda não configurou uma tela de permissão OAuth para o projeto, vamos redirecionar você para fazer isso. Clique em CONFIGURAR TELA DE CONSENTIMENTO. Há várias maneiras de configurar sua tela de consentimento 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 conceder acesso e usar o ID do cliente OAuth 2.0.

      Veja mais informações sobre como configurar a tela de permissão OAuth.

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

Quando terminar, você vai receber um ID e uma chave secreta do cliente do OAuth 2.0. Faça o download dessa chave no formato JSON e salve-a para uso posterior.

Fazer uma solicitação

A API AdMob foi criada com base em HTTP e JSON. Portanto, qualquer cliente HTTP padrão pode enviar solicitações para ela e analisar as respostas. No entanto, as bibliotecas de cliente das APIs 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ê estará pronto para 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 Confira todos os dados da AdMob. Isso pode incluir informações da 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 editor, 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 os tokens compartilhados de duas maneiras:

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

  2. Também é possível revogar os tokens de aplicativos da Web usando a API Google Identity.