AdUnit (DFP AppEngine components 3.14.2 API)

java.lang.Object
- com.google.api.ads.dfp.jaxws.v201711.AdUnit

public class AdUnit
extends Object

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.

Java class for AdUnit complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="AdUnit">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="id" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="parentId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="hasChildren" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="parentPath" type="{https://www.google.com/apis/ads/publisher/v201711}AdUnitParent" maxOccurs="unbounded" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="targetWindow" type="{https://www.google.com/apis/ads/publisher/v201711}AdUnit.TargetWindow" minOccurs="0"/>
         <element name="status" type="{https://www.google.com/apis/ads/publisher/v201711}InventoryStatus" minOccurs="0"/>
         <element name="adUnitCode" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="adUnitSizes" type="{https://www.google.com/apis/ads/publisher/v201711}AdUnitSize" maxOccurs="unbounded" minOccurs="0"/>
         <element name="isFluid" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="explicitlyTargeted" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="adSenseSettings" type="{https://www.google.com/apis/ads/publisher/v201711}AdSenseSettings" minOccurs="0"/>
         <element name="adSenseSettingsSource" type="{https://www.google.com/apis/ads/publisher/v201711}ValueSourceType" minOccurs="0"/>
         <element name="appliedLabelFrequencyCaps" type="{https://www.google.com/apis/ads/publisher/v201711}LabelFrequencyCap" maxOccurs="unbounded" minOccurs="0"/>
         <element name="effectiveLabelFrequencyCaps" type="{https://www.google.com/apis/ads/publisher/v201711}LabelFrequencyCap" maxOccurs="unbounded" minOccurs="0"/>
         <element name="appliedLabels" type="{https://www.google.com/apis/ads/publisher/v201711}AppliedLabel" maxOccurs="unbounded" minOccurs="0"/>
         <element name="effectiveAppliedLabels" type="{https://www.google.com/apis/ads/publisher/v201711}AppliedLabel" maxOccurs="unbounded" minOccurs="0"/>
         <element name="effectiveTeamIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
         <element name="appliedTeamIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
         <element name="lastModifiedDateTime" type="{https://www.google.com/apis/ads/publisher/v201711}DateTime" minOccurs="0"/>
         <element name="smartSizeMode" type="{https://www.google.com/apis/ads/publisher/v201711}SmartSizeMode" minOccurs="0"/>
         <element name="refreshRate" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="externalSetTopBoxChannelId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="isSetTopBoxEnabled" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AdSenseSettings`	`adSenseSettings`
`protected ValueSourceType`	`adSenseSettingsSource`
`protected String`	`adUnitCode`
`protected List<AdUnitSize>`	`adUnitSizes`
`protected List<LabelFrequencyCap>`	`appliedLabelFrequencyCaps`
`protected List<AppliedLabel>`	`appliedLabels`
`protected List<Long>`	`appliedTeamIds`
`protected String`	`description`
`protected List<AppliedLabel>`	`effectiveAppliedLabels`
`protected List<LabelFrequencyCap>`	`effectiveLabelFrequencyCaps`
`protected List<Long>`	`effectiveTeamIds`
`protected Boolean`	`explicitlyTargeted`
`protected String`	`externalSetTopBoxChannelId`
`protected Boolean`	`hasChildren`
`protected String`	`id`
`protected Boolean`	`isFluid`
`protected Boolean`	`isSetTopBoxEnabled`
`protected DateTime`	`lastModifiedDateTime`
`protected String`	`name`
`protected String`	`parentId`
`protected List<AdUnitParent>`	`parentPath`
`protected Integer`	`refreshRate`
`protected SmartSizeMode`	`smartSizeMode`
`protected InventoryStatus`	`status`
`protected AdUnitTargetWindow`	`targetWindow`

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
`AdSenseSettings`	`getAdSenseSettings()` Gets the value of the adSenseSettings property.
`ValueSourceType`	`getAdSenseSettingsSource()` Gets the value of the adSenseSettingsSource property.
`String`	`getAdUnitCode()` Gets the value of the adUnitCode property.
`List<AdUnitSize>`	`getAdUnitSizes()` Gets the value of the adUnitSizes property.
`List<LabelFrequencyCap>`	`getAppliedLabelFrequencyCaps()` Gets the value of the appliedLabelFrequencyCaps property.
`List<AppliedLabel>`	`getAppliedLabels()` Gets the value of the appliedLabels property.
`List<Long>`	`getAppliedTeamIds()` Gets the value of the appliedTeamIds property.
`String`	`getDescription()` Gets the value of the description property.
`List<AppliedLabel>`	`getEffectiveAppliedLabels()` Gets the value of the effectiveAppliedLabels property.
`List<LabelFrequencyCap>`	`getEffectiveLabelFrequencyCaps()` Gets the value of the effectiveLabelFrequencyCaps property.
`List<Long>`	`getEffectiveTeamIds()` Gets the value of the effectiveTeamIds property.
`String`	`getExternalSetTopBoxChannelId()` Gets the value of the externalSetTopBoxChannelId property.
`String`	`getId()` Gets the value of the id property.
`DateTime`	`getLastModifiedDateTime()` Gets the value of the lastModifiedDateTime property.
`String`	`getName()` Gets the value of the name property.
`String`	`getParentId()` Gets the value of the parentId property.
`List<AdUnitParent>`	`getParentPath()` Gets the value of the parentPath property.
`Integer`	`getRefreshRate()` Gets the value of the refreshRate property.
`SmartSizeMode`	`getSmartSizeMode()` Gets the value of the smartSizeMode property.
`InventoryStatus`	`getStatus()` Gets the value of the status property.
`AdUnitTargetWindow`	`getTargetWindow()` Gets the value of the targetWindow property.
`Boolean`	`isExplicitlyTargeted()` Gets the value of the explicitlyTargeted property.
`Boolean`	`isHasChildren()` Gets the value of the hasChildren property.
`Boolean`	`isIsFluid()` Gets the value of the isFluid property.
`Boolean`	`isIsSetTopBoxEnabled()` Gets the value of the isSetTopBoxEnabled property.
`void`	`setAdSenseSettings(AdSenseSettings value)` Sets the value of the adSenseSettings property.
`void`	`setAdSenseSettingsSource(ValueSourceType value)` Sets the value of the adSenseSettingsSource property.
`void`	`setAdUnitCode(String value)` Sets the value of the adUnitCode property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setExplicitlyTargeted(Boolean value)` Sets the value of the explicitlyTargeted property.
`void`	`setExternalSetTopBoxChannelId(String value)` Sets the value of the externalSetTopBoxChannelId property.
`void`	`setHasChildren(Boolean value)` Sets the value of the hasChildren property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setIsFluid(Boolean value)` Sets the value of the isFluid property.
`void`	`setIsSetTopBoxEnabled(Boolean value)` Sets the value of the isSetTopBoxEnabled property.
`void`	`setLastModifiedDateTime(DateTime value)` Sets the value of the lastModifiedDateTime property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setParentId(String value)` Sets the value of the parentId property.
`void`	`setRefreshRate(Integer value)` Sets the value of the refreshRate property.
`void`	`setSmartSizeMode(SmartSizeMode value)` Sets the value of the smartSizeMode property.
`void`	`setStatus(InventoryStatus value)` Sets the value of the status property.
`void`	`setTargetWindow(AdUnitTargetWindow value)` Sets the value of the targetWindow property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected String id
```
  - parentId
```
protected String parentId
```
  - hasChildren
```
protected Boolean hasChildren
```
  - parentPath
```
protected List<AdUnitParent> parentPath
```
  - name
```
protected String name
```
  - description
```
protected String description
```
  - targetWindow
```
protected AdUnitTargetWindow targetWindow
```
  - status
```
protected InventoryStatus status
```
  - adUnitCode
```
protected String adUnitCode
```
  - adUnitSizes
```
protected List<AdUnitSize> adUnitSizes
```
  - isFluid
```
protected Boolean isFluid
```
  - explicitlyTargeted
```
protected Boolean explicitlyTargeted
```
  - adSenseSettings
```
protected AdSenseSettings adSenseSettings
```
  - adSenseSettingsSource
```
protected ValueSourceType adSenseSettingsSource
```
  - appliedLabelFrequencyCaps
```
protected List<LabelFrequencyCap> appliedLabelFrequencyCaps
```
  - effectiveLabelFrequencyCaps
```
protected List<LabelFrequencyCap> effectiveLabelFrequencyCaps
```
  - appliedLabels
```
protected List<AppliedLabel> appliedLabels
```
  - effectiveAppliedLabels
```
protected List<AppliedLabel> effectiveAppliedLabels
```
  - effectiveTeamIds
```
protected List<Long> effectiveTeamIds
```
  - appliedTeamIds
```
protected List<Long> appliedTeamIds
```
  - lastModifiedDateTime
```
protected DateTime lastModifiedDateTime
```
  - smartSizeMode
```
protected SmartSizeMode smartSizeMode
```
  - refreshRate
```
protected Integer refreshRate
```
  - externalSetTopBoxChannelId
```
protected String externalSetTopBoxChannelId
```
  - isSetTopBoxEnabled
```
protected Boolean isSetTopBoxEnabled
```
- Constructor Detail
  - AdUnit
```
public AdUnit()
```
- Method Detail
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is String
  - getParentId
```
public String getParentId()
```
    Gets the value of the parentId property.
    
    Returns:
    
    possible object is String
  - setParentId
```
public void setParentId(String value)
```
    Sets the value of the parentId property.
    
    Parameters:
    
    value - allowed object is String
  - isHasChildren
```
public Boolean isHasChildren()
```
    Gets the value of the hasChildren property.
    
    Returns:
    
    possible object is Boolean
  - setHasChildren
```
public void setHasChildren(Boolean value)
```
    Sets the value of the hasChildren property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getParentPath
```
public List<AdUnitParent> getParentPath()
```
    Gets the value of the parentPath property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the parentPath property.
    For example, to add a new item, do as follows:
```
    getParentPath().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AdUnitParent
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getTargetWindow
```
public AdUnitTargetWindow getTargetWindow()
```
    Gets the value of the targetWindow property.
    
    Returns:
    
    possible object is AdUnitTargetWindow
  - setTargetWindow
```
public void setTargetWindow(AdUnitTargetWindow value)
```
    Sets the value of the targetWindow property.
    
    Parameters:
    
    value - allowed object is AdUnitTargetWindow
  - getStatus
```
public InventoryStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is InventoryStatus
  - setStatus
```
public void setStatus(InventoryStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is InventoryStatus
  - getAdUnitCode
```
public String getAdUnitCode()
```
    Gets the value of the adUnitCode property.
    
    Returns:
    
    possible object is String
  - setAdUnitCode
```
public void setAdUnitCode(String value)
```
    Sets the value of the adUnitCode property.
    
    Parameters:
    
    value - allowed object is String
  - getAdUnitSizes
```
public List<AdUnitSize> getAdUnitSizes()
```
    Gets the value of the adUnitSizes property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the adUnitSizes property.
    For example, to add a new item, do as follows:
```
    getAdUnitSizes().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AdUnitSize
  - isIsFluid
```
public Boolean isIsFluid()
```
    Gets the value of the isFluid property.
    
    Returns:
    
    possible object is Boolean
  - setIsFluid
```
public void setIsFluid(Boolean value)
```
    Sets the value of the isFluid property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isExplicitlyTargeted
```
public Boolean isExplicitlyTargeted()
```
    Gets the value of the explicitlyTargeted property.
    
    Returns:
    
    possible object is Boolean
  - setExplicitlyTargeted
```
public void setExplicitlyTargeted(Boolean value)
```
    Sets the value of the explicitlyTargeted property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getAdSenseSettings
```
public AdSenseSettings getAdSenseSettings()
```
    Gets the value of the adSenseSettings property.
    
    Returns:
    
    possible object is AdSenseSettings
  - setAdSenseSettings
```
public void setAdSenseSettings(AdSenseSettings value)
```
    Sets the value of the adSenseSettings property.
    
    Parameters:
    
    value - allowed object is AdSenseSettings
  - getAdSenseSettingsSource
```
public ValueSourceType getAdSenseSettingsSource()
```
    Gets the value of the adSenseSettingsSource property.
    
    Returns:
    
    possible object is ValueSourceType
  - setAdSenseSettingsSource
```
public void setAdSenseSettingsSource(ValueSourceType value)
```
    Sets the value of the adSenseSettingsSource property.
    
    Parameters:
    
    value - allowed object is ValueSourceType
  - getAppliedLabelFrequencyCaps
```
public List<LabelFrequencyCap> getAppliedLabelFrequencyCaps()
```
    Gets the value of the appliedLabelFrequencyCaps property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the appliedLabelFrequencyCaps property.
    For example, to add a new item, do as follows:
```
    getAppliedLabelFrequencyCaps().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list LabelFrequencyCap
  - getEffectiveLabelFrequencyCaps
```
public List<LabelFrequencyCap> getEffectiveLabelFrequencyCaps()
```
    Gets the value of the effectiveLabelFrequencyCaps property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the effectiveLabelFrequencyCaps property.
    For example, to add a new item, do as follows:
```
    getEffectiveLabelFrequencyCaps().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list LabelFrequencyCap
  - getAppliedLabels
```
public List<AppliedLabel> getAppliedLabels()
```
    Gets the value of the appliedLabels property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the appliedLabels property.
    For example, to add a new item, do as follows:
```
    getAppliedLabels().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AppliedLabel
  - getEffectiveAppliedLabels
```
public List<AppliedLabel> getEffectiveAppliedLabels()
```
    Gets the value of the effectiveAppliedLabels property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the effectiveAppliedLabels property.
    For example, to add a new item, do as follows:
```
    getEffectiveAppliedLabels().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AppliedLabel
  - getEffectiveTeamIds
```
public List<Long> getEffectiveTeamIds()
```
    Gets the value of the effectiveTeamIds property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the effectiveTeamIds property.
    For example, to add a new item, do as follows:
```
    getEffectiveTeamIds().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Long
  - getAppliedTeamIds
```
public List<Long> getAppliedTeamIds()
```
    Gets the value of the appliedTeamIds property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the appliedTeamIds property.
    For example, to add a new item, do as follows:
```
    getAppliedTeamIds().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Long
  - getLastModifiedDateTime
```
public DateTime getLastModifiedDateTime()
```
    Gets the value of the lastModifiedDateTime property.
    
    Returns:
    
    possible object is DateTime
  - setLastModifiedDateTime
```
public void setLastModifiedDateTime(DateTime value)
```
    Sets the value of the lastModifiedDateTime property.
    
    Parameters:
    
    value - allowed object is DateTime
  - getSmartSizeMode
```
public SmartSizeMode getSmartSizeMode()
```
    Gets the value of the smartSizeMode property.
    
    Returns:
    
    possible object is SmartSizeMode
  - setSmartSizeMode
```
public void setSmartSizeMode(SmartSizeMode value)
```
    Sets the value of the smartSizeMode property.
    
    Parameters:
    
    value - allowed object is SmartSizeMode
  - getRefreshRate
```
public Integer getRefreshRate()
```
    Gets the value of the refreshRate property.
    
    Returns:
    
    possible object is Integer
  - setRefreshRate
```
public void setRefreshRate(Integer value)
```
    Sets the value of the refreshRate property.
    
    Parameters:
    
    value - allowed object is Integer
  - getExternalSetTopBoxChannelId
```
public String getExternalSetTopBoxChannelId()
```
    Gets the value of the externalSetTopBoxChannelId property.
    
    Returns:
    
    possible object is String
  - setExternalSetTopBoxChannelId
```
public void setExternalSetTopBoxChannelId(String value)
```
    Sets the value of the externalSetTopBoxChannelId property.
    
    Parameters:
    
    value - allowed object is String
  - isIsSetTopBoxEnabled
```
public Boolean isIsSetTopBoxEnabled()
```
    Gets the value of the isSetTopBoxEnabled property.
    
    Returns:
    
    possible object is Boolean
  - setIsSetTopBoxEnabled
```
public void setIsSetTopBoxEnabled(Boolean value)
```
    Sets the value of the isSetTopBoxEnabled property.
    
    Parameters:
    
    value - allowed object is Boolean

Class AdUnit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

parentId

hasChildren

parentPath

name

description

targetWindow

status

adUnitCode

adUnitSizes

isFluid

explicitlyTargeted

adSenseSettings

adSenseSettingsSource

appliedLabelFrequencyCaps

effectiveLabelFrequencyCaps

appliedLabels

effectiveAppliedLabels

effectiveTeamIds

appliedTeamIds

lastModifiedDateTime

smartSizeMode

refreshRate

externalSetTopBoxChannelId

isSetTopBoxEnabled

Constructor Detail

AdUnit

Method Detail

getId

setId

getParentId

setParentId

isHasChildren

setHasChildren

getParentPath

getName

setName

getDescription

setDescription

getTargetWindow

setTargetWindow

getStatus

setStatus

getAdUnitCode

setAdUnitCode

getAdUnitSizes

isIsFluid

setIsFluid

isExplicitlyTargeted

setExplicitlyTargeted

getAdSenseSettings

setAdSenseSettings

getAdSenseSettingsSource

setAdSenseSettingsSource

getAppliedLabelFrequencyCaps

getEffectiveLabelFrequencyCaps

getAppliedLabels

getEffectiveAppliedLabels

getEffectiveTeamIds

getAppliedTeamIds

getLastModifiedDateTime

setLastModifiedDateTime

getSmartSizeMode

setSmartSizeMode

getRefreshRate

setRefreshRate

getExternalSetTopBoxChannelId

setExternalSetTopBoxChannelId

isIsSetTopBoxEnabled

setIsSetTopBoxEnabled