com.google.api.ads.dfp.jaxws.v201805

Class CreativePlaceholder

java.lang.Object

com.google.api.ads.dfp.jaxws.v201805.CreativePlaceholder

public class CreativePlaceholder
extends Object

A CreativePlaceholder describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A CreativePlaceholder must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is EnvironmentType.VIDEO_PLAYER.

Java class for CreativePlaceholder complex type.

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

 <complexType name="CreativePlaceholder">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="size" type="{https://www.google.com/apis/ads/publisher/v201805}Size" minOccurs="0"/>
         <element name="creativeTemplateId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="companions" type="{https://www.google.com/apis/ads/publisher/v201805}CreativePlaceholder" maxOccurs="unbounded" minOccurs="0"/>
         <element name="appliedLabels" type="{https://www.google.com/apis/ads/publisher/v201805}AppliedLabel" maxOccurs="unbounded" minOccurs="0"/>
         <element name="effectiveAppliedLabels" type="{https://www.google.com/apis/ads/publisher/v201805}AppliedLabel" maxOccurs="unbounded" minOccurs="0"/>
         <element name="expectedCreativeCount" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="creativeSizeType" type="{https://www.google.com/apis/ads/publisher/v201805}CreativeSizeType" minOccurs="0"/>
         <element name="targetingName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AppliedLabel>	appliedLabels
protected List<CreativePlaceholder>	companions
protected CreativeSizeType	creativeSizeType
protected Long	creativeTemplateId
protected List<AppliedLabel>	effectiveAppliedLabels
protected Integer	expectedCreativeCount
protected Size	size
protected String	targetingName

Constructor Summary

Constructors

Constructor and Description
CreativePlaceholder()

Method Summary

Modifier and Type	Method and Description
List<AppliedLabel>	getAppliedLabels() Gets the value of the appliedLabels property.
List<CreativePlaceholder>	getCompanions() Gets the value of the companions property.
CreativeSizeType	getCreativeSizeType() Gets the value of the creativeSizeType property.
Long	getCreativeTemplateId() Gets the value of the creativeTemplateId property.
List<AppliedLabel>	getEffectiveAppliedLabels() Gets the value of the effectiveAppliedLabels property.
Integer	getExpectedCreativeCount() Gets the value of the expectedCreativeCount property.
Size	getSize() Gets the value of the size property.
String	getTargetingName() Gets the value of the targetingName property.
void	setCreativeSizeType(CreativeSizeType value) Sets the value of the creativeSizeType property.
void	setCreativeTemplateId(Long value) Sets the value of the creativeTemplateId property.
void	setExpectedCreativeCount(Integer value) Sets the value of the expectedCreativeCount property.
void	setSize(Size value) Sets the value of the size property.
void	setTargetingName(String value) Sets the value of the targetingName property.

Methods inherited from class java.lang.Object

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

Field Detail

size

protected Size size

creativeTemplateId

protected Long creativeTemplateId

companions

protected List<CreativePlaceholder> companions

appliedLabels

protected List<AppliedLabel> appliedLabels

effectiveAppliedLabels

protected List<AppliedLabel> effectiveAppliedLabels

expectedCreativeCount

protected Integer expectedCreativeCount

creativeSizeType

protected CreativeSizeType creativeSizeType

targetingName

protected String targetingName

Constructor Detail

CreativePlaceholder

public CreativePlaceholder()

Method Detail

getSize

public Size getSize()

Gets the value of the size property.

Returns:

possible object is Size

setSize

public void setSize(Size value)

Sets the value of the size property.

Parameters:

value - allowed object is Size

getCreativeTemplateId

public Long getCreativeTemplateId()

Gets the value of the creativeTemplateId property.

Returns:

possible object is Long

setCreativeTemplateId

public void setCreativeTemplateId(Long value)

Sets the value of the creativeTemplateId property.

Parameters:

value - allowed object is Long

getCompanions

public List<CreativePlaceholder> getCompanions()

Gets the value of the companions 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 companions property.

For example, to add a new item, do as follows:

    getCompanions().add(newItem);
 

Objects of the following type(s) are allowed in the list CreativePlaceholder

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

getExpectedCreativeCount

public Integer getExpectedCreativeCount()

Gets the value of the expectedCreativeCount property.

Returns:

possible object is Integer

setExpectedCreativeCount

public void setExpectedCreativeCount(Integer value)

Sets the value of the expectedCreativeCount property.

Parameters:

value - allowed object is Integer

getCreativeSizeType

public CreativeSizeType getCreativeSizeType()

Gets the value of the creativeSizeType property.

Returns:

possible object is CreativeSizeType

setCreativeSizeType

public void setCreativeSizeType(CreativeSizeType value)

Sets the value of the creativeSizeType property.

Parameters:

value - allowed object is CreativeSizeType

getTargetingName

public String getTargetingName()

Gets the value of the targetingName property.

Returns:

possible object is String

setTargetingName

public void setTargetingName(String value)

Sets the value of the targetingName property.

Parameters:

value - allowed object is String