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 o 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 do 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ê durante o processo e ativa a API AdMob automaticamente.

Ativação da API para um projeto atual

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

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

  1. Abra a biblioteca de APIs no Console de APIs do Google.
  2. Se for solicitado, selecione um projeto ou crie um novo. A biblioteca de APIs 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. Se necessário, ative o faturamento.
  6. Se for solicitado, leia e aceite os Termos de Serviço da API.

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. Acesse a página "Clientes".

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

    Se você não tiver configurado uma tela de permissão OAuth para esse projeto antes, será direcionado para fazer isso agora. Clique em CONFIGURAR TELA DE PERMISSÃO. 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 a eles para usar seu ID do cliente OAuth 2.0.

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

  3. Selecione Aplicativo para computador ou Aplicativo da Web como o tipo de aplicativo, dê 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. É possível fazer o download dessa chave no formato JSON e salvar 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 a ela e analisar as respostas. No entanto, as bibliotecas de cliente de 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.

Com as credenciais do OAuth 2.0 criadas, você já pode 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. 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 performance do anúncio e ganhos. Consulte o ID do publisher, o fuso horário e o código de 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, você pode revogar tokens de aplicativos da Web usando a API Google Identity.