public class AdUnit extends Object implements Serializable
AdUnit represents a chunk of identified inventory for
the publisher. It contains all
the settings that need to be associated with inventory
in order to serve ads to it. An AdUnit can also be the parent of other ad units in the
inventory hierarchy.| Constructor and Description |
|---|
AdUnit() |
AdUnit(String id,
String parentId,
Boolean hasChildren,
AdUnitParent[] parentPath,
String name,
String description,
AdUnitTargetWindow targetWindow,
InventoryStatus status,
String adUnitCode,
AdUnitSize[] adUnitSizes,
Boolean isInterstitial,
Boolean isNative,
Boolean isFluid,
Boolean explicitlyTargeted,
AdSenseSettings adSenseSettings,
ValueSourceType adSenseSettingsSource,
LabelFrequencyCap[] appliedLabelFrequencyCaps,
LabelFrequencyCap[] effectiveLabelFrequencyCaps,
AppliedLabel[] appliedLabels,
AppliedLabel[] effectiveAppliedLabels,
long[] effectiveTeamIds,
long[] appliedTeamIds,
DateTime lastModifiedDateTime,
SmartSizeMode smartSizeMode,
Integer refreshRate,
String externalSetTopBoxChannelId,
Boolean isSetTopBoxEnabled,
Long applicationId) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
AdSenseSettings |
getAdSenseSettings()
Gets the adSenseSettings value for this AdUnit.
|
ValueSourceType |
getAdSenseSettingsSource()
Gets the adSenseSettingsSource value for this AdUnit.
|
String |
getAdUnitCode()
Gets the adUnitCode value for this AdUnit.
|
AdUnitSize[] |
getAdUnitSizes()
Gets the adUnitSizes value for this AdUnit.
|
AdUnitSize |
getAdUnitSizes(int i) |
Long |
getApplicationId()
Gets the applicationId value for this AdUnit.
|
LabelFrequencyCap[] |
getAppliedLabelFrequencyCaps()
Gets the appliedLabelFrequencyCaps value for this AdUnit.
|
LabelFrequencyCap |
getAppliedLabelFrequencyCaps(int i) |
AppliedLabel[] |
getAppliedLabels()
Gets the appliedLabels value for this AdUnit.
|
AppliedLabel |
getAppliedLabels(int i) |
long[] |
getAppliedTeamIds()
Gets the appliedTeamIds value for this AdUnit.
|
long |
getAppliedTeamIds(int i) |
String |
getDescription()
Gets the description value for this AdUnit.
|
static org.apache.axis.encoding.Deserializer |
getDeserializer(String mechType,
Class _javaType,
QName _xmlType)
Get Custom Deserializer
|
AppliedLabel[] |
getEffectiveAppliedLabels()
Gets the effectiveAppliedLabels value for this AdUnit.
|
AppliedLabel |
getEffectiveAppliedLabels(int i) |
LabelFrequencyCap[] |
getEffectiveLabelFrequencyCaps()
Gets the effectiveLabelFrequencyCaps value for this AdUnit.
|
LabelFrequencyCap |
getEffectiveLabelFrequencyCaps(int i) |
long[] |
getEffectiveTeamIds()
Gets the effectiveTeamIds value for this AdUnit.
|
long |
getEffectiveTeamIds(int i) |
Boolean |
getExplicitlyTargeted()
Gets the explicitlyTargeted value for this AdUnit.
|
String |
getExternalSetTopBoxChannelId()
Gets the externalSetTopBoxChannelId value for this AdUnit.
|
Boolean |
getHasChildren()
Gets the hasChildren value for this AdUnit.
|
String |
getId()
Gets the id value for this AdUnit.
|
Boolean |
getIsFluid()
Gets the isFluid value for this AdUnit.
|
Boolean |
getIsInterstitial()
Gets the isInterstitial value for this AdUnit.
|
Boolean |
getIsNative()
Gets the isNative value for this AdUnit.
|
Boolean |
getIsSetTopBoxEnabled()
Gets the isSetTopBoxEnabled value for this AdUnit.
|
DateTime |
getLastModifiedDateTime()
Gets the lastModifiedDateTime value for this AdUnit.
|
String |
getName()
Gets the name value for this AdUnit.
|
String |
getParentId()
Gets the parentId value for this AdUnit.
|
AdUnitParent[] |
getParentPath()
Gets the parentPath value for this AdUnit.
|
AdUnitParent |
getParentPath(int i) |
Integer |
getRefreshRate()
Gets the refreshRate value for this AdUnit.
|
static org.apache.axis.encoding.Serializer |
getSerializer(String mechType,
Class _javaType,
QName _xmlType)
Get Custom Serializer
|
SmartSizeMode |
getSmartSizeMode()
Gets the smartSizeMode value for this AdUnit.
|
InventoryStatus |
getStatus()
Gets the status value for this AdUnit.
|
AdUnitTargetWindow |
getTargetWindow()
Gets the targetWindow value for this AdUnit.
|
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Return type metadata object
|
int |
hashCode() |
void |
setAdSenseSettings(AdSenseSettings adSenseSettings)
Sets the adSenseSettings value for this AdUnit.
|
void |
setAdSenseSettingsSource(ValueSourceType adSenseSettingsSource)
Sets the adSenseSettingsSource value for this AdUnit.
|
void |
setAdUnitCode(String adUnitCode)
Sets the adUnitCode value for this AdUnit.
|
void |
setAdUnitSizes(AdUnitSize[] adUnitSizes)
Sets the adUnitSizes value for this AdUnit.
|
void |
setAdUnitSizes(int i,
AdUnitSize _value) |
void |
setApplicationId(Long applicationId)
Sets the applicationId value for this AdUnit.
|
void |
setAppliedLabelFrequencyCaps(int i,
LabelFrequencyCap _value) |
void |
setAppliedLabelFrequencyCaps(LabelFrequencyCap[] appliedLabelFrequencyCaps)
Sets the appliedLabelFrequencyCaps value for this AdUnit.
|
void |
setAppliedLabels(AppliedLabel[] appliedLabels)
Sets the appliedLabels value for this AdUnit.
|
void |
setAppliedLabels(int i,
AppliedLabel _value) |
void |
setAppliedTeamIds(int i,
long _value) |
void |
setAppliedTeamIds(long[] appliedTeamIds)
Sets the appliedTeamIds value for this AdUnit.
|
void |
setDescription(String description)
Sets the description value for this AdUnit.
|
void |
setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)
Sets the effectiveAppliedLabels value for this AdUnit.
|
void |
setEffectiveAppliedLabels(int i,
AppliedLabel _value) |
void |
setEffectiveLabelFrequencyCaps(int i,
LabelFrequencyCap _value) |
void |
setEffectiveLabelFrequencyCaps(LabelFrequencyCap[] effectiveLabelFrequencyCaps)
Sets the effectiveLabelFrequencyCaps value for this AdUnit.
|
void |
setEffectiveTeamIds(int i,
long _value) |
void |
setEffectiveTeamIds(long[] effectiveTeamIds)
Sets the effectiveTeamIds value for this AdUnit.
|
void |
setExplicitlyTargeted(Boolean explicitlyTargeted)
Sets the explicitlyTargeted value for this AdUnit.
|
void |
setExternalSetTopBoxChannelId(String externalSetTopBoxChannelId)
Sets the externalSetTopBoxChannelId value for this AdUnit.
|
void |
setHasChildren(Boolean hasChildren)
Sets the hasChildren value for this AdUnit.
|
void |
setId(String id)
Sets the id value for this AdUnit.
|
void |
setIsFluid(Boolean isFluid)
Sets the isFluid value for this AdUnit.
|
void |
setIsInterstitial(Boolean isInterstitial)
Sets the isInterstitial value for this AdUnit.
|
void |
setIsNative(Boolean isNative)
Sets the isNative value for this AdUnit.
|
void |
setIsSetTopBoxEnabled(Boolean isSetTopBoxEnabled)
Sets the isSetTopBoxEnabled value for this AdUnit.
|
void |
setLastModifiedDateTime(DateTime lastModifiedDateTime)
Sets the lastModifiedDateTime value for this AdUnit.
|
void |
setName(String name)
Sets the name value for this AdUnit.
|
void |
setParentId(String parentId)
Sets the parentId value for this AdUnit.
|
void |
setParentPath(AdUnitParent[] parentPath)
Sets the parentPath value for this AdUnit.
|
void |
setParentPath(int i,
AdUnitParent _value) |
void |
setRefreshRate(Integer refreshRate)
Sets the refreshRate value for this AdUnit.
|
void |
setSmartSizeMode(SmartSizeMode smartSizeMode)
Sets the smartSizeMode value for this AdUnit.
|
void |
setStatus(InventoryStatus status)
Sets the status value for this AdUnit.
|
void |
setTargetWindow(AdUnitTargetWindow targetWindow)
Sets the targetWindow value for this AdUnit.
|
String |
toString() |
public AdUnit()
public AdUnit(String id, String parentId, Boolean hasChildren, AdUnitParent[] parentPath, String name, String description, AdUnitTargetWindow targetWindow, InventoryStatus status, String adUnitCode, AdUnitSize[] adUnitSizes, Boolean isInterstitial, Boolean isNative, Boolean isFluid, Boolean explicitlyTargeted, AdSenseSettings adSenseSettings, ValueSourceType adSenseSettingsSource, LabelFrequencyCap[] appliedLabelFrequencyCaps, LabelFrequencyCap[] effectiveLabelFrequencyCaps, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, long[] effectiveTeamIds, long[] appliedTeamIds, DateTime lastModifiedDateTime, SmartSizeMode smartSizeMode, Integer refreshRate, String externalSetTopBoxChannelId, Boolean isSetTopBoxEnabled, Long applicationId)
public String getId()
AdUnit. This value is read-only
and is assigned by Google when
an ad unit is created. This attribute is required
for updates.public void setId(String id)
id - * Uniquely identifies the AdUnit. This value is read-only
and is assigned by Google when
an ad unit is created. This attribute is required
for updates.public String getParentId()
public void setParentId(String parentId)
parentId - * The ID of the ad unit's parent. Every ad unit has a parent
except for the root ad unit, which
is created by Google. This attribute is required when
creating the ad unit. Once the ad unit is
created this value will be read-only.public Boolean getHasChildren()
true if the ad unit has any children.
This attribute is read-only
and is populated by Google.public void setHasChildren(Boolean hasChildren)
hasChildren - * This field is set to true if the ad unit has any children.
This attribute is read-only
and is populated by Google.public AdUnitParent[] getParentPath()
public void setParentPath(AdUnitParent[] parentPath)
parentPath - * The path to this ad unit in the ad unit hierarchy represented
as a list from the root to this
ad unit's parent. For root ad units, this list is
empty. This attribute is read-only and is
populated by Google.public AdUnitParent getParentPath(int i)
public void setParentPath(int i,
AdUnitParent _value)
public String getName()
public void setName(String name)
name - * The name of the ad unit. This attribute is required and its
maximum length is 255 characters.
This attribute must also be case-insensitive unique.public String getDescription()
public void setDescription(String description)
description - * A description of the ad unit. This value is optional and its
maximum length is 65,535
characters.public AdUnitTargetWindow getTargetWindow()
target attribute.
This value is optional and will
be interpreted as TargetWindow#TOP if left
blank.public void setTargetWindow(AdUnitTargetWindow targetWindow)
targetWindow - * The value to use for the HTML link's target attribute.
This value is optional and will
be interpreted as TargetWindow#TOP if left
blank.public InventoryStatus getStatus()
InventoryStatus.ACTIVE.
This value cannot be
updated directly using InventoryService#updateAdUnit.
It can only be modified by
performing actions via InventoryService#performAdUnitAction.public void setStatus(InventoryStatus status)
status - * The status of this ad unit. It defaults to InventoryStatus.ACTIVE.
This value cannot be
updated directly using InventoryService#updateAdUnit.
It can only be modified by
performing actions via InventoryService#performAdUnitAction.public String getAdUnitCode()
adUnitCode cannot be changed.public void setAdUnitCode(String adUnitCode)
adUnitCode - * A string used to uniquely identify the ad unit for the purposes
of serving the ad. This
attribute is optional and can be set during ad unit
creation. If it is not provided, it will be
assigned by Google based off of the inventory unit
ID. Once an ad unit is created, its adUnitCode cannot be changed.public AdUnitSize[] getAdUnitSizes()
sizes
attribute.public void setAdUnitSizes(AdUnitSize[] adUnitSizes)
adUnitSizes - * The permissible creative sizes that can be served inside this
ad unit. This attribute is
optional. This attribute replaces the sizes
attribute.public AdUnitSize getAdUnitSizes(int i)
public void setAdUnitSizes(int i,
AdUnitSize _value)
public Boolean getIsInterstitial()
public void setIsInterstitial(Boolean isInterstitial)
isInterstitial - * Whether this is an interstitial ad unit.public Boolean getIsNative()
public void setIsNative(Boolean isNative)
isNative - * Whether this is a native ad unit.public Boolean getIsFluid()
public void setIsFluid(Boolean isFluid)
isFluid - * Whether this is a fluid ad unit.public Boolean getExplicitlyTargeted()
true, then the AdUnit
will not be implicitly targeted
when its parent is. Traffickers must explicitly target
such an ad unit or else no line items
will serve to it. This feature is only available for
Ad Manager 360 accounts.public void setExplicitlyTargeted(Boolean explicitlyTargeted)
explicitlyTargeted - * If this field is set to true, then the AdUnit
will not be implicitly targeted
when its parent is. Traffickers must explicitly target
such an ad unit or else no line items
will serve to it. This feature is only available for
Ad Manager 360 accounts.public AdSenseSettings getAdSenseSettings()
adSenseSettingsSource to PropertySourceType#DIRECTLY_SPECIFIED when setting
the value of this field.public void setAdSenseSettings(AdSenseSettings adSenseSettings)
adSenseSettings - * AdSense specific settings. To overwrite this, set the adSenseSettingsSource to PropertySourceType#DIRECTLY_SPECIFIED when setting
the value of this field.public ValueSourceType getAdSenseSettingsSource()
adSenseSettings value. To
revert an overridden value to its
default, set this field to PropertySourceType#PARENT.public void setAdSenseSettingsSource(ValueSourceType adSenseSettingsSource)
adSenseSettingsSource - * Specifies the source of adSenseSettings value. To
revert an overridden value to its
default, set this field to PropertySourceType#PARENT.public LabelFrequencyCap[] getAppliedLabelFrequencyCaps()
public void setAppliedLabelFrequencyCaps(LabelFrequencyCap[] appliedLabelFrequencyCaps)
appliedLabelFrequencyCaps - * The set of label frequency caps applied directly to this ad
unit. There is a limit of 10 label
frequency caps per ad unit.public LabelFrequencyCap getAppliedLabelFrequencyCaps(int i)
public void setAppliedLabelFrequencyCaps(int i,
LabelFrequencyCap _value)
public LabelFrequencyCap[] getEffectiveLabelFrequencyCaps()
public void setEffectiveLabelFrequencyCaps(LabelFrequencyCap[] effectiveLabelFrequencyCaps)
effectiveLabelFrequencyCaps - * Contains the set of labels applied directly to the ad unit
as well as those inherited from
parent ad units. This field is readonly and is assigned
by Google.public LabelFrequencyCap getEffectiveLabelFrequencyCaps(int i)
public void setEffectiveLabelFrequencyCaps(int i,
LabelFrequencyCap _value)
public AppliedLabel[] getAppliedLabels()
public void setAppliedLabels(AppliedLabel[] appliedLabels)
appliedLabels - * The set of labels applied directly to this ad unit.public AppliedLabel getAppliedLabels(int i)
public void setAppliedLabels(int i,
AppliedLabel _value)
public AppliedLabel[] getEffectiveAppliedLabels()
public void setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)
effectiveAppliedLabels - * Contains the set of labels applied directly to the ad unit
as well as those inherited from the
parent ad units. If a label has been negated, only
the negated label is returned. This field is
readonly and is assigned by Google.public AppliedLabel getEffectiveAppliedLabels(int i)
public void setEffectiveAppliedLabels(int i,
AppliedLabel _value)
public long[] getEffectiveTeamIds()
public void setEffectiveTeamIds(long[] effectiveTeamIds)
effectiveTeamIds - * The IDs of all teams that this ad unit is on as well as those
inherited from parent ad units.
This value is read-only and is set by Google.public long getEffectiveTeamIds(int i)
public void setEffectiveTeamIds(int i,
long _value)
public long[] getAppliedTeamIds()
public void setAppliedTeamIds(long[] appliedTeamIds)
appliedTeamIds - * The IDs of all teams that this ad unit is on directly.public long getAppliedTeamIds(int i)
public void setAppliedTeamIds(int i,
long _value)
public DateTime getLastModifiedDateTime()
public void setLastModifiedDateTime(DateTime lastModifiedDateTime)
lastModifiedDateTime - * The date and time this ad unit was last modified.public SmartSizeMode getSmartSizeMode()
SmartSizeMode.NONE for fixed sizes.public void setSmartSizeMode(SmartSizeMode smartSizeMode)
smartSizeMode - * The smart size mode for this ad unit. This attribute is optional
and defaults to SmartSizeMode.NONE for fixed sizes.public Integer getRefreshRate()
public void setRefreshRate(Integer refreshRate)
refreshRate - * The interval in seconds which ad units in mobile apps automatically
refresh. Valid values are
between 30 and 120 seconds. This attribute is optional
and only applies to ad units in mobile
apps. If this value is not set, then the mobile app
ad will not refresh.public String getExternalSetTopBoxChannelId()
isSetTopBoxEnabled
is true. This attribute is
read-only.public void setExternalSetTopBoxChannelId(String externalSetTopBoxChannelId)
externalSetTopBoxChannelId - * Specifies an ID for a channel in an external set-top box campaign
management system. This
attribute is only meaningful if isSetTopBoxEnabled
is true. This attribute is
read-only.public Boolean getIsSetTopBoxEnabled()
public void setIsSetTopBoxEnabled(Boolean isSetTopBoxEnabled)
isSetTopBoxEnabled - * Flag that specifies whether this ad unit represents an external
set-top box channel. This
attribute is read-only.public Long getApplicationId()
MobileApplication.applicationId for the CTV application
that this ad unit is
within. This attribute is optional.public void setApplicationId(Long applicationId)
applicationId - * The MobileApplication.applicationId for the CTV application
that this ad unit is
within. This attribute is optional.public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(String mechType, Class _javaType, QName _xmlType)
Copyright © 2023. All rights reserved.