AdUnit (AdMob API v1beta-rev20240201-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.admob.v1beta.model.AdUnit

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class AdUnit
extends com.google.api.client.json.GenericJson
```
Describes an AdMob ad unit.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the AdMob API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

AdUnit()

Constructors
Constructor and Description
`AdUnit()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdUnit`	`clone()`
`String`	`getAdFormat()` AdFormat of the ad unit.
`List<String>`	`getAdTypes()` Ad media type supported by this ad unit.
`String`	`getAdUnitId()` The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK.
`String`	`getAppId()` The externally visible ID of the app this ad unit is associated with.
`String`	`getDisplayName()` The display name of the ad unit as shown in the AdMob UI, which is provided by the user.
`String`	`getName()` Resource name for this ad unit.
`AdUnitRewardSettings`	`getRewardSettings()` Optional.
`AdUnit`	`set(String fieldName, Object value)`
`AdUnit`	`setAdFormat(String adFormat)` AdFormat of the ad unit.
`AdUnit`	`setAdTypes(List<String> adTypes)` Ad media type supported by this ad unit.
`AdUnit`	`setAdUnitId(String adUnitId)` The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK.
`AdUnit`	`setAppId(String appId)` The externally visible ID of the app this ad unit is associated with.
`AdUnit`	`setDisplayName(String displayName)` The display name of the ad unit as shown in the AdMob UI, which is provided by the user.
`AdUnit`	`setName(String name)` Resource name for this ad unit.
`AdUnit`	`setRewardSettings(AdUnitRewardSettings rewardSettings)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - AdUnit
```
public AdUnit()
```
- Method Detail
  - getAdFormat
```
public String getAdFormat()
```
    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.
    
    Returns:
    
    value or null for none
  - setAdFormat
```
public AdUnit setAdFormat(String adFormat)
```
    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.
    
    Parameters:
    
    adFormat - adFormat or null for none
  - getAdTypes
```
public List<String> getAdTypes()
```
    Ad media type supported by this ad unit. Possible values as follows: "RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media.
    
    Returns:
    
    value or null for none
  - setAdTypes
```
public AdUnit setAdTypes(List<String> adTypes)
```
    Ad media type supported by this ad unit. Possible values as follows: "RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media.
    
    Parameters:
    
    adTypes - adTypes or null for none
  - getAdUnitId
```
public String getAdUnitId()
```
    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
    
    Returns:
    
    value or null for none
  - setAdUnitId
```
public AdUnit setAdUnitId(String adUnitId)
```
    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
    
    Parameters:
    
    adUnitId - adUnitId or null for none
  - getAppId
```
public String getAppId()
```
    The externally visible ID of the app this ad unit is associated with. Example: ca-app- pub-9876543210987654~0123456789
    
    Returns:
    
    value or null for none
  - setAppId
```
public AdUnit setAppId(String appId)
```
    The externally visible ID of the app this ad unit is associated with. Example: ca-app- pub-9876543210987654~0123456789
    
    Parameters:
    
    appId - appId or null for none
  - getDisplayName
```
public String getDisplayName()
```
    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.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public AdUnit setDisplayName(String displayName)
```
    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.
    
    Parameters:
    
    displayName - displayName or null for none
  - getName
```
public String getName()
```
    Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789
    
    Returns:
    
    value or null for none
  - setName
```
public AdUnit setName(String name)
```
    Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789
    
    Parameters:
    
    name - name or null for none
  - getRewardSettings
```
public AdUnitRewardSettings getRewardSettings()
```
    Optional. Settings for a rewarded ad unit. This can be set or unset only when the ad_format is "REWARDED".
    
    Returns:
    
    value or null for none
  - setRewardSettings
```
public AdUnit setRewardSettings(AdUnitRewardSettings rewardSettings)
```
    Optional. Settings for a rewarded ad unit. This can be set or unset only when the ad_format is "REWARDED".
    
    Parameters:
    
    rewardSettings - rewardSettings or null for none
  - set
```
public AdUnit set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public AdUnit clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class AdUnit

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AdUnit

Method Detail

getAdFormat

setAdFormat

getAdTypes

setAdTypes

getAdUnitId

setAdUnitId

getAppId

setAppId

getDisplayName

setDisplayName

getName

setName

getRewardSettings

setRewardSettings

set

clone