com.google.api.ads.admanager.axis.v202308

Class CreativePlaceholder

java.lang.Object

com.google.api.ads.admanager.axis.v202308.CreativePlaceholder

All Implemented Interfaces:

Serializable

public class CreativePlaceholder
extends Object
implements Serializable

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreativePlaceholder()
CreativePlaceholder(Size size, Long creativeTemplateId, CreativePlaceholder[] companions, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, Integer expectedCreativeCount, CreativeSizeType creativeSizeType, String targetingName, Boolean isAmpOnly)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AppliedLabel[]	getAppliedLabels() Gets the appliedLabels value for this CreativePlaceholder.
AppliedLabel	getAppliedLabels(int i)
CreativePlaceholder[]	getCompanions() Gets the companions value for this CreativePlaceholder.
CreativePlaceholder	getCompanions(int i)
CreativeSizeType	getCreativeSizeType() Gets the creativeSizeType value for this CreativePlaceholder.
Long	getCreativeTemplateId() Gets the creativeTemplateId value for this CreativePlaceholder.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
AppliedLabel[]	getEffectiveAppliedLabels() Gets the effectiveAppliedLabels value for this CreativePlaceholder.
AppliedLabel	getEffectiveAppliedLabels(int i)
Integer	getExpectedCreativeCount() Gets the expectedCreativeCount value for this CreativePlaceholder.
Boolean	getIsAmpOnly() Gets the isAmpOnly value for this CreativePlaceholder.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
Size	getSize() Gets the size value for this CreativePlaceholder.
String	getTargetingName() Gets the targetingName value for this CreativePlaceholder.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAppliedLabels(AppliedLabel[] appliedLabels) Sets the appliedLabels value for this CreativePlaceholder.
void	setAppliedLabels(int i, AppliedLabel _value)
void	setCompanions(CreativePlaceholder[] companions) Sets the companions value for this CreativePlaceholder.
void	setCompanions(int i, CreativePlaceholder _value)
void	setCreativeSizeType(CreativeSizeType creativeSizeType) Sets the creativeSizeType value for this CreativePlaceholder.
void	setCreativeTemplateId(Long creativeTemplateId) Sets the creativeTemplateId value for this CreativePlaceholder.
void	setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels) Sets the effectiveAppliedLabels value for this CreativePlaceholder.
void	setEffectiveAppliedLabels(int i, AppliedLabel _value)
void	setExpectedCreativeCount(Integer expectedCreativeCount) Sets the expectedCreativeCount value for this CreativePlaceholder.
void	setIsAmpOnly(Boolean isAmpOnly) Sets the isAmpOnly value for this CreativePlaceholder.
void	setSize(Size size) Sets the size value for this CreativePlaceholder.
void	setTargetingName(String targetingName) Sets the targetingName value for this CreativePlaceholder.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreativePlaceholder

public CreativePlaceholder()

CreativePlaceholder

public CreativePlaceholder(Size size,
                           Long creativeTemplateId,
                           CreativePlaceholder[] companions,
                           AppliedLabel[] appliedLabels,
                           AppliedLabel[] effectiveAppliedLabels,
                           Integer expectedCreativeCount,
                           CreativeSizeType creativeSizeType,
                           String targetingName,
                           Boolean isAmpOnly)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getSize

public Size getSize()

Gets the size value for this CreativePlaceholder.

Returns:

size * The dimensions that the creative is expected to have. This attribute is required.

setSize

public void setSize(Size size)

Sets the size value for this CreativePlaceholder.

Parameters:

size - * The dimensions that the creative is expected to have. This attribute is required.

getCreativeTemplateId

public Long getCreativeTemplateId()

Gets the creativeTemplateId value for this CreativePlaceholder.

Returns:

creativeTemplateId * The native creative template ID.

This value is only required if creativeSizeType is CreativeSizeType.NATIVE.

setCreativeTemplateId

public void setCreativeTemplateId(Long creativeTemplateId)

Sets the creativeTemplateId value for this CreativePlaceholder.

Parameters:

creativeTemplateId - * The native creative template ID.

This value is only required if creativeSizeType is CreativeSizeType.NATIVE.

getCompanions

public CreativePlaceholder[] getCompanions()

Gets the companions value for this CreativePlaceholder.

Returns:

companions * The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a LineItemSummary.environmentType of EnvironmentType.VIDEO_PLAYER or LineItemSummary.roadblockingType of RoadblockingType.CREATIVE_SET.

setCompanions

public void setCompanions(CreativePlaceholder[] companions)

Sets the companions value for this CreativePlaceholder.

Parameters:

companions - * The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a LineItemSummary.environmentType of EnvironmentType.VIDEO_PLAYER or LineItemSummary.roadblockingType of RoadblockingType.CREATIVE_SET.

getCompanions

public CreativePlaceholder getCompanions(int i)

setCompanions

public void setCompanions(int i,
                          CreativePlaceholder _value)

getAppliedLabels

public AppliedLabel[] getAppliedLabels()

Gets the appliedLabels value for this CreativePlaceholder.

Returns:

appliedLabels * The set of label frequency caps applied directly to this creative placeholder.

setAppliedLabels

public void setAppliedLabels(AppliedLabel[] appliedLabels)

Sets the appliedLabels value for this CreativePlaceholder.

Parameters:

appliedLabels - * The set of label frequency caps applied directly to this creative placeholder.

getAppliedLabels

public AppliedLabel getAppliedLabels(int i)

setAppliedLabels

public void setAppliedLabels(int i,
                             AppliedLabel _value)

getEffectiveAppliedLabels

public AppliedLabel[] getEffectiveAppliedLabels()

Gets the effectiveAppliedLabels value for this CreativePlaceholder.

Returns:

effectiveAppliedLabels * Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google.

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)

Sets the effectiveAppliedLabels value for this CreativePlaceholder.

Parameters:

effectiveAppliedLabels - * Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google.

getEffectiveAppliedLabels

public AppliedLabel getEffectiveAppliedLabels(int i)

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(int i,
                                      AppliedLabel _value)

getExpectedCreativeCount

public Integer getExpectedCreativeCount()

Gets the expectedCreativeCount value for this CreativePlaceholder.

Returns:

expectedCreativeCount * Expected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.

setExpectedCreativeCount

public void setExpectedCreativeCount(Integer expectedCreativeCount)

Sets the expectedCreativeCount value for this CreativePlaceholder.

Parameters:

expectedCreativeCount - * Expected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.

getCreativeSizeType

public CreativeSizeType getCreativeSizeType()

Gets the creativeSizeType value for this CreativePlaceholder.

Returns:

creativeSizeType * Describes the types of sizes a creative can be. By default, the creative's size is CreativeSizeType.PIXEL, which is a dimension based size (width-height pair).

setCreativeSizeType

public void setCreativeSizeType(CreativeSizeType creativeSizeType)

Sets the creativeSizeType value for this CreativePlaceholder.

Parameters:

creativeSizeType - * Describes the types of sizes a creative can be. By default, the creative's size is CreativeSizeType.PIXEL, which is a dimension based size (width-height pair).

getTargetingName

public String getTargetingName()

Gets the targetingName value for this CreativePlaceholder.

Returns:

targetingName * The name of the CreativeTargeting for creatives this placeholder represents.

This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a LineItemCreativeAssociation when associating a Creative with the LineItem.

setTargetingName

public void setTargetingName(String targetingName)

Sets the targetingName value for this CreativePlaceholder.

Parameters:

targetingName - * The name of the CreativeTargeting for creatives this placeholder represents.

This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a LineItemCreativeAssociation when associating a Creative with the LineItem.

getIsAmpOnly

public Boolean getIsAmpOnly()

Gets the isAmpOnly value for this CreativePlaceholder.

Returns:

isAmpOnly * Indicate if the expected creative of this placeholder has an AMP only variant.

This attribute is optional. It is for forecasting purposes only and has no effect on serving.

setIsAmpOnly

public void setIsAmpOnly(Boolean isAmpOnly)

Sets the isAmpOnly value for this CreativePlaceholder.

Parameters:

isAmpOnly - * Indicate if the expected creative of this placeholder has an AMP only variant.

This attribute is optional. It is for forecasting purposes only and has no effect on serving.

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