- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Adapter
- AdapterConfigMetadata
- Examples
- Try it!
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 |
Required. The parent which owns this collection of adapters. Format: accounts/{publisherId}/adSources/{adSourceId} |
Query parameters
Parameters | |
---|---|
pageSize |
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 |
A page token, received from a previous |
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:
JSON representation |
---|
{
"adapters": [
{
object ( |
Fields | |
---|---|
adapters[] |
The adapter. |
nextPageToken |
Used to set the |
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.
JSON representation |
---|
{
"name": string,
"adapterId": string,
"title": string,
"platform": string,
"formats": [
string
],
"adapterConfigMetadata": [
{
object ( |
Fields | |
---|---|
name |
Output only. Resource name of the adapter. Format is: accounts/{publisherId}/adSources/{adSourceId}/adapters/{adapterId}. |
adapterId |
Output only. ID of this adapter. It is used to set adapterId. |
title |
Output only. The display name of this adapter. |
platform |
Output only. Mobile application platform supported by this adapter. Supported values are: IOS, ANDROID, WINDOWS_PHONE |
formats[] |
Output only. Indicates the formats of the ad units supported by this adapter. |
adapterConfigMetadata[] |
Output only. Configuration metadata associated with this adapter. |
AdapterConfigMetadata
Configuration metadata associated with this adapter. They are used to define the adUnitConfigurations associated with AdUnitMappings for the this adapter.
JSON representation |
---|
{ "adapterConfigMetadataId": string, "adapterConfigMetadataLabel": string, "isRequired": boolean } |
Fields | |
---|---|
adapterConfigMetadataId |
This is used to fill the key of the adUnitConfigurations. |
adapterConfigMetadataLabel |
Name of the adapter configuration metadata. |
isRequired |
Whether this metadata is required for configuring the AdUnitMappings. |