REST Resource: accounts.adUnits
Stay organized with collections
Save and categorize content based on your preferences.
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 |
|
Creates an ad unit under the specified AdMob account. |
|
List the ad units under the specified AdMob account. |
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\u003eThe AdUnit resource describes an AdMob ad unit, containing properties like name, ID, format, and reward settings.\u003c/p\u003e\n"],["\u003cp\u003eAdUnits support various ad formats, including banner, interstitial, rewarded, and native, each with specific properties and functionalities.\u003c/p\u003e\n"],["\u003cp\u003eRewardSettings, applicable to rewarded ad units, define the reward amount and type for users upon viewing an ad.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage AdUnits using the AdMob API to create new units and list existing ones under your account.\u003c/p\u003e\n"]]],["The core content details AdUnit and RewardSettings resources, including their JSON representations and fields. AdUnit describes an AdMob ad unit with properties like name, ID, app association, display name, format (e.g., banner, interstitial, rewarded), and supported ad types (e.g., rich media, video). RewardSettings defines settings for rewarded ad units, specifying the reward amount and item. Key methods are to create and list ad units under a given AdMob account.\n"],null,["# REST Resource: accounts.adUnits\n\n- [Resource: AdUnit](#AdUnit)\n - [JSON representation](#AdUnit.SCHEMA_REPRESENTATION)\n- [RewardSettings](#RewardSettings)\n - [JSON representation](#RewardSettings.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: AdUnit\n----------------\n\nDescribes an AdMob ad unit.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"adUnitId\": string, \"appId\": string, \"displayName\": string, \"adFormat\": string, \"adTypes\": [ string ], \"rewardSettings\": { object (/admob/api/reference/rest/v1beta/accounts.adUnits#RewardSettings) } } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Resource name for this ad unit. Format is accounts/{publisherId}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789 |\n| `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 |\n| `appId` | `string` The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654\\~0123456789 |\n| `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. |\n| `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 \u003chttps://support.google.com/admob/answer/9884467\u003e. |\n| `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. |\n| `rewardSettings` | `object (`[RewardSettings](/admob/api/reference/rest/v1beta/accounts.adUnits#RewardSettings)`)` Optional. Settings for a rewarded ad unit. This can be set or unset only when the adFormat is \"REWARDED\". |\n\nRewardSettings\n--------------\n\nSettings for a rewarded ad unit.\n\n| JSON representation |\n|------------------------------------------------------|\n| ``` { \"unitAmount\": string, \"unitType\": string } ``` |\n\n| Fields ||\n|--------------|---------------------------------------------------------------------------------------------------------------------|\n| `unitAmount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Reward amount for this ad unit. |\n| `unitType` | `string` Reward item for this ad unit. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------|-------------------------------------------------------|\n| ### [create](/admob/api/reference/rest/v1beta/accounts.adUnits/create) | Creates an ad unit under the specified AdMob account. |\n| ### [list](/admob/api/reference/rest/v1beta/accounts.adUnits/list) | List the ad units under the specified AdMob account. |"]]