REST Resource: accounts.adUnits.adUnitMappings

  • An AdUnitMapping defines settings to map an AdMob ad unit to a third-party ad unit.

  • The AdUnitMapping resource includes fields such as name, adapterId, state, adUnitConfigurations, and displayName.

  • The State of an ad unit mapping can be either STATE_UNSPECIFIED or ENABLED, indicating if it's active.

  • Available methods for AdUnitMapping include create to add a new mapping and list to view existing ones.

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

 Create an ad unit mapping under the specific AdMob account and ad unit.

list

 List ad unit mappings under the specified AdMob account and ad unit.