Introdução à API AdMob

Importante: as novas funções e permissões do usuário afetam os dados retornados pela API AdMob. Saiba mais

Este guia é destinado a desenvolvedores que querem usar a API AdMob para receber dados na 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 serviços da Web em nome do usuário. O OAuth2 permite que seu app cliente da API AdMob acesse a conta da AdMob de um usuário sem precisar processar ou armazenar o nome de usuário ou a senha. Para ter 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

• Uma Conta do Google

• Uma conta da Google AdMob.

• Familiaridade com os conceitos básicos do REST e a autorização de solicitações com o OAuth 2.0.

Determinar seu tipo de autenticação

Consulte a tabela abaixo para saber qual tipo de autenticação é mais apropriado 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ê for um usuário iniciante ou quiser começar rapidamente com a configuração mais simples. O app só autentica usuários da Google AdMob de 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. Você quer gerar várias credenciais de autorização para gerenciar contas de terceiros, por exemplo. Seu app requer URLs de callback. Os URLs de callback não são aceitos no fluxo de apps para computador.

Importante: você ainda pode escolher o fluxo de apps para computador, mesmo que esteja desenvolvendo um app para execução em um servidor. A diferença é se a autorização do OAuth é concluída localmente ou remotamente. Um fluxo para computador exige que a autorização seja concluída na máquina local, enquanto o fluxo da Web permite que a autorização seja concluída no servidor de autorização do Google.

Criar um projeto

Para começar a usar a API AdMob, primeiro é necessário criar ou selecionar um projeto no console de APIs do Google e ativar 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 atual

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

Criar credenciais 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.

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 consentimento para usar o 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 ao ID do cliente OAuth 2.0.

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

3. Selecione App para computador ou Aplicativo da Web como o tipo, dê um nome 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 salvá-la 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 da API do Google oferecem melhor integração de linguagens, 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.

Observação: na primeira vez que você ativar o fluxo OAuth, será necessário informar seu ID de editor da AdMob e aceitar uma solicitação de autorização no navegador. Antes de aceitar, verifique se você fez login com uma Conta do Google que tem acesso à sua conta da AdMob. Seu app será autorizado a acessar dados em nome da conta que estiver conectada no momento.

Depois de criar as credenciais do OAuth 2.0, 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	Acessar 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	Acessar relatórios de desempenho de anúncios e ganhos. Confira o ID do editor, fuso horário e 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, é possível revogar os tokens de aplicativos da Web usando a API Google Identity.