REST Resource: accounts.adUnits.adUnitMappings
Stay organized with collections
Save and categorize content based on your preferences.
Resource: AdUnitMapping
Settings to map an AdMob ad unit to a 3rd party ad unit.
| JSON representation |
{
"name": string,
"adapterId": string,
"state": enum (State),
"adUnitConfigurations": {
string: string,
...
},
"displayName": string
} |
| Fields |
name |
string
Resource name of this ad unit mapping. Format is: accounts/{publisherId}/adUnits/{ad_unit_id_fragment}/adUnitMappings/{adUnitMappingId} Example: accounts/pub-1234567890123456/adUnits/0123456789/adUnitMappings/987654321
|
adapterId |
string (int64 format)
The ID of mediation ad source adapter used by this ad unit mapping. The adapter determines the information needed in the ad_network_settings.
|
state |
enum (State)
Output only. The status of this ad unit mapping.
|
adUnitConfigurations |
map (key: string (int64 format), value: string)
Settings for the specified ad unit to make an ad request to 3rd party ad network. Key-value pairs with values set by the user for the keys requested by the ad network. Please see https://support.google.com/admob/answer/3245073 for details on how to configure the network settings. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
|
displayName |
string
Optional. The display name of this ad unit mapping instance.
|
State
Status of the ad unit mapping. Newly created ad unit mapping is set to ENABLED.
Output only.
| Enums |
STATE_UNSPECIFIED |
The default value. |
ENABLED |
The ad unit mapping is active and used to serve ads or collecting stats. |
Methods |
|
|
Create an ad unit mapping under the specific AdMob account and ad unit. |
|
|
List ad unit mappings under the specified AdMob account and ad unit. |
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.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eAdUnitMapping settings allow you to link an AdMob ad unit to a third-party ad unit for mediation.\u003c/p\u003e\n"],["\u003cp\u003eThe mapping includes configurations like adapter ID, state (enabled/disabled), and custom network settings.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage these mappings through methods to create and list them for specific AdMob accounts and ad units.\u003c/p\u003e\n"],["\u003cp\u003eAd unit mappings start in an enabled state and can be used to serve ads or gather statistics.\u003c/p\u003e\n"]]],["AdUnitMapping resources connect AdMob ad units to third-party ad units. Key actions involve creating and listing these mappings. Each mapping includes a name, adapter ID, state (like ENABLED), and ad unit configurations—settings for the third-party ad network. The `displayName` is an optional name for the mapping. The `State` field indicates the mapping's status. `adUnitConfigurations` contains key-value pairs for the third party settings.\n"],null,["# REST Resource: accounts.adUnits.adUnitMappings\n\n- [Resource: AdUnitMapping](#AdUnitMapping)\n - [JSON representation](#AdUnitMapping.SCHEMA_REPRESENTATION)\n- [State](#State)\n- [Methods](#METHODS_SUMMARY)\n\nResource: AdUnitMapping\n-----------------------\n\nSettings to map an AdMob ad unit to a 3rd party ad unit.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"adapterId\": string, \"state\": enum (/admob/api/reference/rest/v1beta/accounts.adUnits.adUnitMappings#State), \"adUnitConfigurations\": { string: string, ... }, \"displayName\": string } ``` |\n\n| Fields ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Resource name of this ad unit mapping. Format is: accounts/{publisherId}/adUnits/{ad_unit_id_fragment}/adUnitMappings/{adUnitMappingId} Example: accounts/pub-1234567890123456/adUnits/0123456789/adUnitMappings/987654321 |\n| `adapterId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of mediation ad source adapter used by this ad unit mapping. The adapter determines the information needed in the ad_network_settings. |\n| `state` | `enum (`[State](/admob/api/reference/rest/v1beta/accounts.adUnits.adUnitMappings#State)`)` Output only. The status of this ad unit mapping. |\n| `adUnitConfigurations` | `map (key: string (`[int64](https://developers.google.com/discovery/v1/type-format)` format), value: string)` Settings for the specified ad unit to make an ad request to 3rd party ad network. Key-value pairs with values set by the user for the keys requested by the ad network. Please see \u003chttps://support.google.com/admob/answer/3245073\u003e for details on how to configure the network settings. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `displayName` | `string` Optional. The display name of this ad unit mapping instance. |\n\nState\n-----\n\nStatus of the ad unit mapping. Newly created ad unit mapping is set to ENABLED.\n\nOutput only.\n\n| Enums ||\n|---------------------|--------------------------------------------------------------------------|\n| `STATE_UNSPECIFIED` | The default value. |\n| `ENABLED` | The ad unit mapping is active and used to serve ads or collecting stats. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------|\n| ### [create](/admob/api/reference/rest/v1beta/accounts.adUnits.adUnitMappings/create) | Create an ad unit mapping under the specific AdMob account and ad unit. |\n| ### [list](/admob/api/reference/rest/v1beta/accounts.adUnits.adUnitMappings/list) | List ad unit mappings under the specified AdMob account and ad unit. |"]]
