REST Resource: accounts.adUnits

  • An AdUnit resource describes an AdMob ad unit with properties like name, ID, associated app ID, display name, ad format, supported ad types, and optional reward settings.

  • The RewardSettings object, which can be set for "REWARDED" ad units, includes the reward amount (unitAmount) and reward item (unitType).

  • The available methods for AdUnits include create to make a new ad unit and list to retrieve existing ad units under a specified AdMob account.

Resource: AdUnit

Describes an AdMob ad unit.

JSON representation 
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ],
  "rewardSettings": {
    object (RewardSettings)
  }
}
Fields
name

string

Resource name for this ad unit. Format is accounts/{publisherId}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789
adUnitId

string

The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654/0123456789
appId

string

The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789
displayName

string

The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.
adFormat

string

AdFormat of the ad unit. Possible values are as follows:

"APP_OPEN" - App Open ad format. "BANNER" - Banner ad format. "BANNER_INTERSTITIAL" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. "INTERSTITIAL" - A full screen ad. Supported ad types are "RICH_MEDIA" and "VIDEO". "NATIVE" - Native ad format. "REWARDED" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are "RICH_MEDIA" (interactive) and video where video can not be excluded. "REWARDED_INTERSTITIAL" - Rewarded Interstitial ad format. Only supports video ad type. See https://support.google.com/admob/answer/9884467.
adTypes[]

string

Ad media type supported by this ad unit. Possible values as follows:

"RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media.
rewardSettings

object (RewardSettings)

Optional. Settings for a rewarded ad unit. This can be set or unset only when the adFormat is "REWARDED".

RewardSettings

Settings for a rewarded ad unit.

JSON representation 
{
  "unitAmount": string,
  "unitType": string
}
Fields
unitAmount

string (int64 format)

Reward amount for this ad unit.
unitType

string

Reward item for this ad unit.

Methods

create

 Creates an ad unit under the specified AdMob account.

list

 List the ad units under the specified AdMob account.