This guide is for developers who want to use the AdMob API to programmatically get information about their AdMob account.
All Google AdMob API calls must be authorized through OAuth2 so your app can interact with web services on the user's behalf. OAuth2 enables your AdMob API client app to access a user's AdMob account without having to handle or store the user's username or password. For an overview of authorization, see Authorization.
Perform the following steps to generate the OAuth2 credentials and make your first request.
Determine your authentication type
Check the table below to see which authentication type is most appropriate for your app:
|Choose your OAuth2 authentication type||If ...|
Create a project
To get started using the AdMob API, you need to first create or select a project in the Google API Console and enable the API using the setup tool, which guides you through the process and activates the AdMob API automatically.
Enabling the API for an existing project
The following steps apply to users who have an existing project and prefer to activate the AdMob API for it manually.
To enable an API for your project:
- Open the API Library in the Google API Console.
- If prompted, select a project, or create a new one. The API Library lists all available APIs, grouped by product family and popularity.
- 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.
- Select the API you want to enable, then click the Enable button.
- If prompted, enable billing.
- If prompted, read and accept the API's Terms of Service.
Create OAuth2 credentials
The following instructions guide you through the process of creating an OAuth 2.0 client ID to use with the installed app flow.
- Go to the Credentials page.
Click CREATE CREDENTIALS > OAuth client ID.
If you hadn't configured an OAuth consent screen for this project previously, you'll be directed to do so now. Click CONFIGURE CONSENT SCREEN. There are multiple ways to configure your consent screen to use your OAuth 2.0 client ID.
- Set your user type to External and publishing status to Published.
Or, set your user type to External and publishing status to Testing, then add Test users by selecting add users to give them access to use your OAuth 2.0 client ID.
See additional information on setting up your OAuth consent screen.
Select Desktop app or Web Application as the application type, give it a name, then click Create.
When done, you are presented with an OAuth 2.0 client ID and client secret, which you can download in JSON format and save for later use.
Make a request
The AdMob API is built on HTTP and JSON, so any standard HTTP client can send requests to it and parse the responses. However, the Google API client libraries provide better language integration, improved security, and support for making authorized requests. The client libraries are available in a number of programming languages; by using them you can avoid the need to manually set up HTTP requests and parse the responses.
With OAuth 2.0 credentials created, you're ready to start using the AdMob API. To request access using OAuth 2.0, your app also needs scope information:
||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.|
||See ad performance and earnings reports. See publisher ID, timezone, and default currency code.|
Revoke shared tokens
You can revoke shared tokens in two ways: