REST Resource: accounts.mediationGroups

Resource: MediationGroup

Describes an AdMob Mediation group.

JSON representation 
{
  "name": string,
  "mediationGroupId": string,
  "displayName": string,
  "targeting": {
    object (MediationGroupTargeting)
  },
  "state": enum (State),
  "mediationGroupLines": {
    string: {
      object (MediationGroupLine)
    },
    ...
  },
  "mediationAbExperimentState": enum (ExperimentState)
}
Fields
name

string

Resource name for this mediation group. Format is: accounts/{publisherId}/mediationGroups/{mediationGroupId} Example: accounts/pub-9876543210987654/mediationGroups/0123456789
mediationGroupId

string

The ID of the mediation group. Example: "0123456789". This is a read only property.
displayName

string

User provided name for the mediation group. The maximum length allowed is 120 characters.
targeting

object (MediationGroupTargeting)

Set of criteria targeted by this mediation group, such as ad units and geo locations.
state

enum (State)

The status of the mediation group. Only enabled mediation groups will be served.
mediationGroupLines

map (key: string, value: object (MediationGroupLine))

The mediation lines used for serving for this mediation group.

Key is the ID of the mediation group line. For creation, use distinct negative values as placeholder.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
mediationAbExperimentState

enum (ExperimentState)

Output only. The state of the mediation a/b experiment that belongs to this mediation group.

MediationGroupTargeting

Set of criteria targeted by this mediation group. For example, a mediation group can target specific ad unit IDs, platform, format and geo location.

JSON representation 
{
  "platform": string,
  "format": string,
  "adUnitIds": [
    string
  ],
  "targetedRegionCodes": [
    string
  ],
  "excludedRegionCodes": [
    string
  ],
  "idfaTargeting": enum (IdfaTargeting)
}
Fields
platform

string

Describes the platform of the app. Examples: "IOS", "Android".
format

string

Ad format targeted by this mediation group. Examples: "banner", "native".
adUnitIds[]

string

Ad units targeted by this mediation group. Example: "ca-app-pub-1234/8790".
targetedRegionCodes[]

string

The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group targets all available regions. For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag.
excludedRegionCodes[]

string

The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group does not exclude any region.
idfaTargeting

enum (IdfaTargeting)

The parameter can be used to target ad requests based on the availability of the IDFA. If set to ALL, the mediation group applies to all ad requests (with or without IDFA). If set to AVAILABLE, the mediation group applies to ad requests with IDFA. If set to NOT_AVAILABLE, the mediation group applies to ad requests without IDFA. Doesn't need to be specified for an ANDROID device.

IdfaTargeting

The availability of IDFA for iOS devices.

Enums
IDFA_TARGETING_UNSPECIFIED Default value. This value is unused.
ALL All the devices are targeted, regardless of IDFA availability.
AVAILABLE Only the devices with IDFA availability are targeted.
NOT_AVAILABLE Only the devices without IDFA availability are targeted.

State

Types of statuses available for a Mediation Group.

Enums
STATE_UNSPECIFIED Default value for an unset field. Do not use.
ENABLED The mediation group is active and used to serve ads or to collect stats.
DISABLED The mediation group has been disabled and is no longer serving ads or collecting stats. Disabled mediation groups can be re-enabled.

ExperimentState

The Mediation A/B experiment state for the Mediation Group.

Enums
EXPERIMENT_STATE_UNSPECIFIED Default value for an unset field. Do not use.
RUNNING The mediation group has an experiment in the RUNNING state.
NOT_RUNNING There is no experiment in the RUNNING state in the mediation group.

Methods

create

 Create a mediation group under the specific AdMob account.

list

 List mediation groups under the specified AdMob account.

patch

 Update the specified mediation group under the specified AdMob account.