com.google.api.ads.dfp.axis.v201211

Class AdUnit

java.lang.Object

com.google.api.ads.dfp.axis.v201211.AdUnit

All Implemented Interfaces:

Serializable

public class AdUnit
extends Object
implements Serializable

An 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.

See Also:

Serialized Form

Constructor Summary

Constructors

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, TargetPlatform targetPlatform, MobilePlatform mobilePlatform, Boolean explicitlyTargeted, AdSenseSettingsInheritedProperty inheritedAdSenseSettings, LabelFrequencyCap[] appliedLabelFrequencyCaps, LabelFrequencyCap[] effectiveLabelFrequencyCaps, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, long[] effectiveTeamIds, long[] appliedTeamIds, DateTime lastModifiedDateTime)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAdUnitCode() Gets the adUnitCode value for this AdUnit.
AdUnitSize[]	getAdUnitSizes() Gets the adUnitSizes value for this AdUnit.
AdUnitSize	getAdUnitSizes(int i)
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.
Boolean	getHasChildren() Gets the hasChildren value for this AdUnit.
String	getId() Gets the id value for this AdUnit.
AdSenseSettingsInheritedProperty	getInheritedAdSenseSettings() Gets the inheritedAdSenseSettings value for this AdUnit.
DateTime	getLastModifiedDateTime() Gets the lastModifiedDateTime value for this AdUnit.
MobilePlatform	getMobilePlatform() Gets the mobilePlatform 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)
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
InventoryStatus	getStatus() Gets the status value for this AdUnit.
TargetPlatform	getTargetPlatform() Gets the targetPlatform 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	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	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	setHasChildren(Boolean hasChildren) Sets the hasChildren value for this AdUnit.
void	setId(String id) Sets the id value for this AdUnit.
void	setInheritedAdSenseSettings(AdSenseSettingsInheritedProperty inheritedAdSenseSettings) Sets the inheritedAdSenseSettings value for this AdUnit.
void	setLastModifiedDateTime(DateTime lastModifiedDateTime) Sets the lastModifiedDateTime value for this AdUnit.
void	setMobilePlatform(MobilePlatform mobilePlatform) Sets the mobilePlatform 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	setStatus(InventoryStatus status) Sets the status value for this AdUnit.
void	setTargetPlatform(TargetPlatform targetPlatform) Sets the targetPlatform value for this AdUnit.
void	setTargetWindow(AdUnitTargetWindow targetWindow) Sets the targetWindow value for this AdUnit.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdUnit

public AdUnit()

AdUnit

public AdUnit(String id,
      String parentId,
      Boolean hasChildren,
      AdUnitParent[] parentPath,
      String name,
      String description,
      AdUnitTargetWindow targetWindow,
      InventoryStatus status,
      String adUnitCode,
      AdUnitSize[] adUnitSizes,
      TargetPlatform targetPlatform,
      MobilePlatform mobilePlatform,
      Boolean explicitlyTargeted,
      AdSenseSettingsInheritedProperty inheritedAdSenseSettings,
      LabelFrequencyCap[] appliedLabelFrequencyCaps,
      LabelFrequencyCap[] effectiveLabelFrequencyCaps,
      AppliedLabel[] appliedLabels,
      AppliedLabel[] effectiveAppliedLabels,
      long[] effectiveTeamIds,
      long[] appliedTeamIds,
      DateTime lastModifiedDateTime)

Method Detail

getId

public String getId()

Gets the id value for this AdUnit.

Returns:

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.

setId

public void setId(String id)

Sets the id value for this AdUnit.

Parameters:

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.

getParentId

public String getParentId()

Gets the parentId value for this AdUnit.

Returns:

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.

setParentId

public void setParentId(String parentId)

Sets the parentId value for this AdUnit.

Parameters:

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.

getHasChildren

public Boolean getHasChildren()

Gets the hasChildren value for this AdUnit.

Returns:

hasChildren * This field is set to true if the ad unit has any children. This attribute is read-only and is populated by Google.

setHasChildren

public void setHasChildren(Boolean hasChildren)

Sets the hasChildren value for this AdUnit.

Parameters:

hasChildren - * This field is set to true if the ad unit has any children. This attribute is read-only and is populated by Google.

getParentPath

public AdUnitParent[] getParentPath()

Gets the parentPath value for this AdUnit.

Returns:

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.

setParentPath

public void setParentPath(AdUnitParent[] parentPath)

Sets the parentPath value for this AdUnit.

Parameters:

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.

getParentPath

public AdUnitParent getParentPath(int i)

setParentPath

public void setParentPath(int i,
                 AdUnitParent _value)

getName

public String getName()

Gets the name value for this AdUnit.

Returns:

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. Once an ad unit is created, its name cannot be changed.

setName

public void setName(String name)

Sets the name value for this AdUnit.

Parameters:

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. Once an ad unit is created, its name cannot be changed.

getDescription

public String getDescription()

Gets the description value for this AdUnit.

Returns:

description * A description of the ad unit. This value is optional and its maximum length is 65,535 characters.

setDescription

public void setDescription(String description)

Sets the description value for this AdUnit.

Parameters:

description - * A description of the ad unit. This value is optional and its maximum length is 65,535 characters.

getTargetWindow

public AdUnitTargetWindow getTargetWindow()

Gets the targetWindow value for this AdUnit.

Returns:

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.

setTargetWindow

public void setTargetWindow(AdUnitTargetWindow targetWindow)

Sets the targetWindow value for this AdUnit.

Parameters:

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.

getStatus

public InventoryStatus getStatus()

Gets the status value for this AdUnit.

Returns:

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.

setStatus

public void setStatus(InventoryStatus status)

Sets the status value for this AdUnit.

Parameters:

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.

getAdUnitCode

public String getAdUnitCode()

Gets the adUnitCode value for this AdUnit.

Returns:

adUnitCode * A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created. Once an ad unit is created, its adUnitCode cannot be changed.

setAdUnitCode

public void setAdUnitCode(String adUnitCode)

Sets the adUnitCode value for this AdUnit.

Parameters:

adUnitCode - * A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created. Once an ad unit is created, its adUnitCode cannot be changed.

getAdUnitSizes

public AdUnitSize[] getAdUnitSizes()

Gets the adUnitSizes value for this AdUnit.

Returns:

adUnitSizes * The permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the sizes attribute.

setAdUnitSizes

public void setAdUnitSizes(AdUnitSize[] adUnitSizes)

Sets the adUnitSizes value for this AdUnit.

Parameters:

adUnitSizes - * The permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the sizes attribute.

getAdUnitSizes

public AdUnitSize getAdUnitSizes(int i)

setAdUnitSizes

public void setAdUnitSizes(int i,
                  AdUnitSize _value)

getTargetPlatform

public TargetPlatform getTargetPlatform()

Gets the targetPlatform value for this AdUnit.

Returns:

targetPlatform * The platform that the AdUnit is serving, the default value is TargetPlatform.WEB. Line items will only serve to ad units that have the same LineItemSummary.targetPlatform.

setTargetPlatform

public void setTargetPlatform(TargetPlatform targetPlatform)

Sets the targetPlatform value for this AdUnit.

Parameters:

targetPlatform - * The platform that the AdUnit is serving, the default value is TargetPlatform.WEB. Line items will only serve to ad units that have the same LineItemSummary.targetPlatform.

getMobilePlatform

public MobilePlatform getMobilePlatform()

Gets the mobilePlatform value for this AdUnit.

Returns:

mobilePlatform * The platform associated with a mobile AdUnit, i.e. whether this ad unit appears in a mobile application or in a mobile web site. This attribute can only be used with TargetPlatform.MOBILE ad units. This attribute is optional and defaults to MobilePlatform.SITE.

setMobilePlatform

public void setMobilePlatform(MobilePlatform mobilePlatform)

Sets the mobilePlatform value for this AdUnit.

Parameters:

mobilePlatform - * The platform associated with a mobile AdUnit, i.e. whether this ad unit appears in a mobile application or in a mobile web site. This attribute can only be used with TargetPlatform.MOBILE ad units. This attribute is optional and defaults to MobilePlatform.SITE.

getExplicitlyTargeted

public Boolean getExplicitlyTargeted()

Gets the explicitlyTargeted value for this AdUnit.

Returns:

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 DFP Premium accounts.

setExplicitlyTargeted

public void setExplicitlyTargeted(Boolean explicitlyTargeted)

Sets the explicitlyTargeted value for this AdUnit.

Parameters:

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 DFP Premium accounts.

getInheritedAdSenseSettings

public AdSenseSettingsInheritedProperty getInheritedAdSenseSettings()

Gets the inheritedAdSenseSettings value for this AdUnit.

Returns:

inheritedAdSenseSettings * AdSense specific settings. This value is optional and if left blank will be inherited from the parent ad unit.

setInheritedAdSenseSettings

public void setInheritedAdSenseSettings(AdSenseSettingsInheritedProperty inheritedAdSenseSettings)

Sets the inheritedAdSenseSettings value for this AdUnit.

Parameters:

inheritedAdSenseSettings - * AdSense specific settings. This value is optional and if left blank will be inherited from the parent ad unit.

getAppliedLabelFrequencyCaps

public LabelFrequencyCap[] getAppliedLabelFrequencyCaps()

Gets the appliedLabelFrequencyCaps value for this AdUnit.

Returns:

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.

setAppliedLabelFrequencyCaps

public void setAppliedLabelFrequencyCaps(LabelFrequencyCap[] appliedLabelFrequencyCaps)

Sets the appliedLabelFrequencyCaps value for this AdUnit.

Parameters:

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.

getAppliedLabelFrequencyCaps

public LabelFrequencyCap getAppliedLabelFrequencyCaps(int i)

setAppliedLabelFrequencyCaps

public void setAppliedLabelFrequencyCaps(int i,
                                LabelFrequencyCap _value)

getEffectiveLabelFrequencyCaps

public LabelFrequencyCap[] getEffectiveLabelFrequencyCaps()

Gets the effectiveLabelFrequencyCaps value for this AdUnit.

Returns:

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.

setEffectiveLabelFrequencyCaps

public void setEffectiveLabelFrequencyCaps(LabelFrequencyCap[] effectiveLabelFrequencyCaps)

Sets the effectiveLabelFrequencyCaps value for this AdUnit.

Parameters:

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.

getEffectiveLabelFrequencyCaps

public LabelFrequencyCap getEffectiveLabelFrequencyCaps(int i)

setEffectiveLabelFrequencyCaps

public void setEffectiveLabelFrequencyCaps(int i,
                                  LabelFrequencyCap _value)

getAppliedLabels

public AppliedLabel[] getAppliedLabels()

Gets the appliedLabels value for this AdUnit.

Returns:

appliedLabels * The set of labels applied directly to this ad unit.

setAppliedLabels

public void setAppliedLabels(AppliedLabel[] appliedLabels)

Sets the appliedLabels value for this AdUnit.

Parameters:

appliedLabels - * The set of labels applied directly to this ad unit.

getAppliedLabels

public AppliedLabel getAppliedLabels(int i)

setAppliedLabels

public void setAppliedLabels(int i,
                    AppliedLabel _value)

getEffectiveAppliedLabels

public AppliedLabel[] getEffectiveAppliedLabels()

Gets the effectiveAppliedLabels value for this AdUnit.

Returns:

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.

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)

Sets the effectiveAppliedLabels value for this AdUnit.

Parameters:

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.

getEffectiveAppliedLabels

public AppliedLabel getEffectiveAppliedLabels(int i)

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(int i,
                             AppliedLabel _value)

getEffectiveTeamIds

public long[] getEffectiveTeamIds()

Gets the effectiveTeamIds value for this AdUnit.

Returns:

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.

setEffectiveTeamIds

public void setEffectiveTeamIds(long[] effectiveTeamIds)

Sets the effectiveTeamIds value for this AdUnit.

Parameters:

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.

getEffectiveTeamIds

public long getEffectiveTeamIds(int i)

setEffectiveTeamIds

public void setEffectiveTeamIds(int i,
                       long _value)

getAppliedTeamIds

public long[] getAppliedTeamIds()

Gets the appliedTeamIds value for this AdUnit.

Returns:

appliedTeamIds * The IDs of all teams that this ad unit is on directly.

setAppliedTeamIds

public void setAppliedTeamIds(long[] appliedTeamIds)

Sets the appliedTeamIds value for this AdUnit.

Parameters:

appliedTeamIds - * The IDs of all teams that this ad unit is on directly.

getAppliedTeamIds

public long getAppliedTeamIds(int i)

setAppliedTeamIds

public void setAppliedTeamIds(int i,
                     long _value)

getLastModifiedDateTime

public DateTime getLastModifiedDateTime()

Gets the lastModifiedDateTime value for this AdUnit.

Returns:

lastModifiedDateTime * The date and time this ad unit was last modified.

setLastModifiedDateTime

public void setLastModifiedDateTime(DateTime lastModifiedDateTime)

Sets the lastModifiedDateTime value for this AdUnit.

Parameters:

lastModifiedDateTime - * The date and time this ad unit was last modified.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                Class _javaType,
                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                    Class _javaType,
                                                    QName _xmlType)

Get Custom Deserializer