Method: accounts.adSources.adapters.list
Stay organized with collections
Save and categorize content based on your preferences.
List the adapters of the ad source.
HTTP request
GET https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters
The URL uses gRPC Transcoding
syntax.
Path parameters
| Parameters |
parent
|
string
Required. The parent which owns this collection of adapters. Format: accounts/{publisherId}/adSources/{adSourceId}
|
Query parameters
| Parameters |
pageSize
|
integer
The maximum number of adapters to return. If unspecified or 0, at most 10,000 adapters will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.
|
pageToken
|
string
A page token, received from a previous adapters.list
call. Provide this to retrieve the subsequent page.
|
Request body
The request body must be empty.
Response body
Response for the ListAdaptersRequest.
If successful, the response body contains data with the following structure:
| Fields |
adapters[]
|
object ( Adapter
)
The adapter.
|
nextPageToken
|
string
Used to set the pageToken
in the ListAdapterRequest
to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/admob.monetization
-
https://www.googleapis.com/auth/admob.readonly
For more information, see the OAuth 2.0 Overview
.
Adapter
Describes adapters supported by each mediation ad source.
Adapters correspond to a specific SDK implementation of the ad source, and are each associated with a single platform and a list of supported ad unit formats. Adapters may also require setting some configurations to perform ad requests. Configurations can be specified in the AdUnitMapping by setting the adUnitConfigurations
key/value pairs. For example, the adUnitConfigurations can be used to pass various IDs to the adapter's third-party SDK.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eLists available adapters for a given ad source, including details like platform, supported ad formats, and required configurations.\u003c/p\u003e\n"],["\u003cp\u003eProvides details on how to make the API request, including required parameters and authorization scopes.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of adapters, each with its unique ID, display name, and configuration metadata.\u003c/p\u003e\n"],["\u003cp\u003eAdapter configuration metadata defines the necessary settings for integrating the adapter with ad units.\u003c/p\u003e\n"],["\u003cp\u003ePagination is supported to retrieve large lists of adapters using page tokens.\u003c/p\u003e\n"]]],["To list adapters, send a `GET` request to `https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters`. The `parent` path parameter specifies the ad source. Use `pageSize` and `pageToken` query parameters to manage the number of results. The request body should be empty. A successful response returns a JSON object containing an array of `adapters` and `nextPageToken` for pagination. Each adapter has details such as `name`, `adapterId`, `title`, `platform`, supported `formats`, and `adapterConfigMetadata`.\n"],null,["# Method: accounts.adSources.adapters.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAdaptersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Adapter](#Adapter)\n - [JSON representation](#Adapter.SCHEMA_REPRESENTATION)\n- [AdapterConfigMetadata](#AdapterConfigMetadata)\n - [JSON representation](#AdapterConfigMetadata.SCHEMA_REPRESENTATION)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nList the adapters of the ad source.\n\n### HTTP request\n\n`GET https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent which owns this collection of adapters. Format: accounts/{publisherId}/adSources/{adSourceId} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of adapters to return. If unspecified or 0, at most 10,000 adapters will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000. |\n| `pageToken` | `string` A page token, received from a previous `adapters.list` call. Provide this to retrieve the subsequent page. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse for the ListAdaptersRequest.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adapters\": [ { object (/admob/api/reference/rest/v1beta/accounts.adSources.adapters/list#Adapter) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adapters[]` | `object (`[Adapter](/admob/api/reference/rest/v1beta/accounts.adSources.adapters/list#Adapter)`)` The adapter. |\n| `nextPageToken` | `string` Used to set the `pageToken` in the `ListAdapterRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admob.monetization`\n- `\n https://www.googleapis.com/auth/admob.readonly`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nAdapter\n-------\n\nDescribes adapters supported by each mediation ad source.\n\nAdapters correspond to a specific SDK implementation of the ad source, and are each associated with a single platform and a list of supported ad unit formats. Adapters may also require setting some configurations to perform ad requests. Configurations can be specified in the AdUnitMapping by setting the [adUnitConfigurations](#AdUnitMapping.ad_unit_configurations) key/value pairs. For example, the adUnitConfigurations can be used to pass various IDs to the adapter's third-party SDK.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"adapterId\": string, \"title\": string, \"platform\": string, \"formats\": [ string ], \"adapterConfigMetadata\": [ { object (/admob/api/reference/rest/v1beta/accounts.adSources.adapters/list#AdapterConfigMetadata) } ] } ``` |\n\n| Fields ||\n|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of the adapter. Format is: accounts/{publisherId}/adSources/{adSourceId}/adapters/{adapterId}. |\n| `adapterId` | `string` Output only. ID of this adapter. It is used to set [adapterId](#AdUnitMapping.adapter_id). |\n| `title` | `string` Output only. The display name of this adapter. |\n| `platform` | `string` Output only. Mobile application platform supported by this adapter. Supported values are: IOS, ANDROID, WINDOWS_PHONE |\n| `formats[]` | `string` Output only. Indicates the formats of the ad units supported by this adapter. |\n| `adapterConfigMetadata[]` | `object (`[AdapterConfigMetadata](/admob/api/reference/rest/v1beta/accounts.adSources.adapters/list#AdapterConfigMetadata)`)` Output only. Configuration metadata associated with this adapter. |\n\nAdapterConfigMetadata\n---------------------\n\nConfiguration metadata associated with this adapter. They are used to define the adUnitConfigurations associated with AdUnitMappings for the this adapter.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------|\n| ``` { \"adapterConfigMetadataId\": string, \"adapterConfigMetadataLabel\": string, \"isRequired\": boolean } ``` |\n\n| Fields ||\n|------------------------------|-------------------------------------------------------------------------------------------------------------|\n| `adapterConfigMetadataId` | `string` This is used to fill the key of the [adUnitConfigurations](#AdUnitMapping.ad_unit_configurations). |\n| `adapterConfigMetadataLabel` | `string` Name of the adapter configuration metadata. |\n| `isRequired` | `boolean` Whether this metadata is required for configuring the AdUnitMappings. |"]]
