Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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.
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:
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.
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.
Selecione aquela que você quer habilitar e clique no botão Ativar.
If prompted, enable billing.
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.
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.
Defina o tipo de usuário como Externo e o status de publicação como Publicado.
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.
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:
[null,null,["Última atualização 2025-08-31 UTC."],[[["\u003cp\u003eThis guide helps developers programmatically access AdMob account data using the AdMob API, requiring OAuth2 authorization for secure interactions.\u003c/p\u003e\n"],["\u003cp\u003eBefore starting, ensure you have a Google Account, an AdMob account, and familiarity with REST basics and OAuth 2.0 authorization.\u003c/p\u003e\n"],["\u003cp\u003eChoose the appropriate authentication type (Desktop or Web app) based on your app's needs and authorization process.\u003c/p\u003e\n"],["\u003cp\u003eCreate or select a Google API project and enable the AdMob API to get started, then generate OAuth2 credentials for authorization.\u003c/p\u003e\n"],["\u003cp\u003eMake your first API request using provided code examples (Java, PHP, Python, or curl) and manage token revocation for security.\u003c/p\u003e\n"]]],["To use the AdMob API, developers must authorize requests via OAuth2. Key actions include creating a project in the Google API Console and enabling the AdMob API. Developers then generate OAuth2 credentials, choosing between desktop or web app authentication types. The OAuth consent screen must be configured. Finally, with created credentials and specifying the scope (`admob.readonly` or `admob.report`), developers can use HTTP or Google API client libraries to make their first API request and start retrieving AdMob data. Shared tokens can be revoked.\n"],null,["| **Important:** New user roles and permissions will affect data returned by the AdMob API. [Learn more](//support.google.com/admob/answer/2784628)\n\nThis guide is for developers who want to use the AdMob API to\nprogrammatically get\ndata in their AdMob account.\n\nAll Google AdMob API calls must be authorized through\n[OAuth2](/identity/protocols/oauth2) so your app can interact with web services\non the user's behalf. OAuth2 enables your AdMob API client app to access a\nuser's AdMob account without having to handle or store the user's username or\npassword. For an overview of authorization, see\n[Authorization](/admob/api/v1/how-tos/authorizing).\n\nPerform the following steps to generate the OAuth2 credentials and make your\nfirst request.\n\nPrerequisites\n\n- A [Google Account](//google.com/accounts/NewAccount).\n\n- A [Google AdMob account](//admob.google.com/home/get-started).\n\n- Familiarity with [REST basics](/admob/api/v1/prereqs#rest) and [authorizing requests with\n OAuth 2.0](/admob/api/v1/how-tos/authorizing).\n\nDetermine your authentication type\n\nCheck the table below to see which **authentication type** is most appropriate\nfor your app:\n\n| Choose your OAuth2 authentication type | If ... |\n|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Desktop app** | - You're managing all of your AdMob API accounts using a single top level manager account. - You're a first-time user, or want to get started quickly with the simplest setup. - Your app only authenticates Google AdMob users from one machine. |\n| **Web app** | - You want to authenticate as a user who can grant permission to your app to access their AdMob API account data. - You want to easily generate multiple authorization credentials, to manage third-party accounts for example. - Your app requires callback URLs. Callback URLs are not supported in the desktop app flow. |\n\n| **Key Point:** You can still choose the desktop app flow even if you're developing an app to run on a server. The difference is whether the OAuth authorization is completed locally or remotely. A desktop flow requires authorization to be completed on the local machine, whereas the web-flow lets authorization be completed on Google's authorization server.\n\nCreate a project\n\nTo get started using the AdMob API, you need to first create or select a\nproject in the Google API Console and enable the API using [the setup\ntool](https://console.cloud.google.com/start/api?id=admob.googleapis.com&credential=client_key),\nwhich guides you through the process and activates the AdMob API\nautomatically. \n\nEnabling the API for an existing project\n\nThe following steps apply to users who have an existing project and prefer to\nactivate the AdMob API for it manually.\n\nTo enable an API for your project:\n\n1. [Open the API Library](https://console.developers.google.com/apis/library) in the Google API Console.\n2. If prompted, select a project, or create a new one. The API Library lists all available APIs, grouped by product family and popularity.\n3. If the API you want to enable isn't visible in the list, use search to find it, or click **View All** in the product family it belongs to.\n4. Select the API you want to enable, then click the **Enable** button.\n5. If prompted, enable billing.\n6. If prompted, read and accept the API's Terms of Service.\n\nCreate OAuth2 credentials\n\nThe following instructions guide you through the process of creating an OAuth\n2.0 client ID to use with the [installed app\nflow](/identity/protocols/OAuth2InstalledApp).\n\n1. Go to the [Clients page](https://console.developers.google.com/auth/clients).\n2. Click **CREATE CREDENTIALS \\\u003e OAuth client ID**.\n\n If you hadn't configured an OAuth consent screen for this project\n previously, you'll be directed to do so now. Click **CONFIGURE CONSENT\n SCREEN**. There are multiple ways to configure your consent screen to\n use your OAuth 2.0 client ID.\n 1. Set your user type to **External** and publishing status to **Published**.\n 2. Or, set your user type to **External** and publishing status to\n **Testing** , then add **Test users** by selecting **add users** to\n give them access to use your OAuth 2.0 client ID.\n\n See additional information on [setting up your OAuth consent\n screen](//support.google.com/cloud/answer/10311615).\n3. Select **Desktop app** or **Web Application** as the application type, give\n it a name, then click **Create**.\n\nWhen done, you are presented with an OAuth 2.0 client ID and client secret,\nwhich you can download in JSON format and save for later use.\n\nMake a request\n\nThe AdMob API is built on HTTP and JSON, so any standard HTTP client can send\nrequests to it and parse the responses. However, the [Google API client\nlibraries](/admob/api/v1/libraries) provide better language integration,\nimproved security, and support for making authorized requests. The client\nlibraries are available in a number of programming languages; by using them you\ncan avoid the need to manually set up HTTP requests and parse the responses.\n| **Note:** The first time you activate the OAuth flow, you are asked to provide your AdMob publisher ID and accept an authorization prompt in your browser. Before accepting, make sure you're signed in with a Google Account that has access to your AdMob account. Your app is then authorized to access data on behalf of whichever account is currently logged in.\n\nWith [OAuth 2.0 credentials created](#credentials), you're ready to start using\nthe AdMob API. To request access using OAuth 2.0, your app also needs scope\ninformation:\n\n\n| Scope | Meaning |\n|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `https://www.googleapis.com/auth/admob.readonly` | See all AdMob data. This may include account information, inventory and mediation settings, reports, and other data. This doesn't include sensitive data, such as payments or campaign details. |\n| `https://www.googleapis.com/auth/admob.report` | See ad performance and earnings reports. See publisher ID, timezone, and default currency code. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nMake your first request to generate a report using examples in\n[Java](/admob/api/v1/reporting#java-client-library),\n[PHP](/admob/api/v1/reporting#php-client-library),\n[Python](/admob/api/v1/reporting#python-client-library) or\n[curl](/admob/api/v1/reporting#curl-command-line).\n\nRevoke shared tokens\n\nYou can revoke shared tokens in two ways:\n\n1. Navigate to your [Google account\n permissions page](//myaccount.google.com/permissions) and revoke access from\n the relevant project.\n\n2. Alternatively, you can revoke web application tokens using the [Google\n Identity API](/identity/protocols/oauth2/web-server#tokenrevoke)."]]
