com.google.api.ads.dfp.axis.v201306

Class ProductTemplate

java.lang.Object

com.google.api.ads.dfp.axis.v201306.ProductTemplate

All Implemented Interfaces:

Serializable

public class ProductTemplate
extends Object
implements Serializable

ProductTemplate is used to generate products. All generated products will inherit all attributes from their ProductTemplate, except for segmentation, which will be included in the Product.targeting. The generated products in turn will be used to create proposal line items so that almost all attributes in the product template are properties of the proposal line item.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProductTemplate()
ProductTemplate(Long id, String name, DateTime creationDateTime, DateTime lastModifiedDateTime, String description, String nameMacro, ProductTemplateStatus status, ProductType productType, Long creatorId, RateType rateType, RoadblockingType roadblockingType, CreativePlaceholder[] creativePlaceholders, LineItemType lineItemType, Integer priority, FrequencyCap[] frequencyCaps, Boolean allowFrequencyCapsCustomization, ProductSegmentation productSegmentation, ProductTemplateTargeting targeting, BaseCustomFieldValue[] customFieldValues)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllowFrequencyCapsCustomization() Gets the allowFrequencyCapsCustomization value for this ProductTemplate.
DateTime	getCreationDateTime() Gets the creationDateTime value for this ProductTemplate.
CreativePlaceholder[]	getCreativePlaceholders() Gets the creativePlaceholders value for this ProductTemplate.
CreativePlaceholder	getCreativePlaceholders(int i)
Long	getCreatorId() Gets the creatorId value for this ProductTemplate.
BaseCustomFieldValue[]	getCustomFieldValues() Gets the customFieldValues value for this ProductTemplate.
BaseCustomFieldValue	getCustomFieldValues(int i)
String	getDescription() Gets the description value for this ProductTemplate.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
FrequencyCap[]	getFrequencyCaps() Gets the frequencyCaps value for this ProductTemplate.
FrequencyCap	getFrequencyCaps(int i)
Long	getId() Gets the id value for this ProductTemplate.
DateTime	getLastModifiedDateTime() Gets the lastModifiedDateTime value for this ProductTemplate.
LineItemType	getLineItemType() Gets the lineItemType value for this ProductTemplate.
String	getName() Gets the name value for this ProductTemplate.
String	getNameMacro() Gets the nameMacro value for this ProductTemplate.
Integer	getPriority() Gets the priority value for this ProductTemplate.
ProductSegmentation	getProductSegmentation() Gets the productSegmentation value for this ProductTemplate.
ProductType	getProductType() Gets the productType value for this ProductTemplate.
RateType	getRateType() Gets the rateType value for this ProductTemplate.
RoadblockingType	getRoadblockingType() Gets the roadblockingType value for this ProductTemplate.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
ProductTemplateStatus	getStatus() Gets the status value for this ProductTemplate.
ProductTemplateTargeting	getTargeting() Gets the targeting value for this ProductTemplate.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAllowFrequencyCapsCustomization(Boolean allowFrequencyCapsCustomization) Sets the allowFrequencyCapsCustomization value for this ProductTemplate.
void	setCreationDateTime(DateTime creationDateTime) Sets the creationDateTime value for this ProductTemplate.
void	setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders) Sets the creativePlaceholders value for this ProductTemplate.
void	setCreativePlaceholders(int i, CreativePlaceholder _value)
void	setCreatorId(Long creatorId) Sets the creatorId value for this ProductTemplate.
void	setCustomFieldValues(BaseCustomFieldValue[] customFieldValues) Sets the customFieldValues value for this ProductTemplate.
void	setCustomFieldValues(int i, BaseCustomFieldValue _value)
void	setDescription(String description) Sets the description value for this ProductTemplate.
void	setFrequencyCaps(FrequencyCap[] frequencyCaps) Sets the frequencyCaps value for this ProductTemplate.
void	setFrequencyCaps(int i, FrequencyCap _value)
void	setId(Long id) Sets the id value for this ProductTemplate.
void	setLastModifiedDateTime(DateTime lastModifiedDateTime) Sets the lastModifiedDateTime value for this ProductTemplate.
void	setLineItemType(LineItemType lineItemType) Sets the lineItemType value for this ProductTemplate.
void	setName(String name) Sets the name value for this ProductTemplate.
void	setNameMacro(String nameMacro) Sets the nameMacro value for this ProductTemplate.
void	setPriority(Integer priority) Sets the priority value for this ProductTemplate.
void	setProductSegmentation(ProductSegmentation productSegmentation) Sets the productSegmentation value for this ProductTemplate.
void	setProductType(ProductType productType) Sets the productType value for this ProductTemplate.
void	setRateType(RateType rateType) Sets the rateType value for this ProductTemplate.
void	setRoadblockingType(RoadblockingType roadblockingType) Sets the roadblockingType value for this ProductTemplate.
void	setStatus(ProductTemplateStatus status) Sets the status value for this ProductTemplate.
void	setTargeting(ProductTemplateTargeting targeting) Sets the targeting value for this ProductTemplate.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductTemplate

public ProductTemplate()

ProductTemplate

public ProductTemplate(Long id,
               String name,
               DateTime creationDateTime,
               DateTime lastModifiedDateTime,
               String description,
               String nameMacro,
               ProductTemplateStatus status,
               ProductType productType,
               Long creatorId,
               RateType rateType,
               RoadblockingType roadblockingType,
               CreativePlaceholder[] creativePlaceholders,
               LineItemType lineItemType,
               Integer priority,
               FrequencyCap[] frequencyCaps,
               Boolean allowFrequencyCapsCustomization,
               ProductSegmentation productSegmentation,
               ProductTemplateTargeting targeting,
               BaseCustomFieldValue[] customFieldValues)

Method Detail

getId

public Long getId()

Gets the id value for this ProductTemplate.

Returns:

id * Uniquely identifies the ProductTemplate. This attribute is read-only and is assigned by Google when a ProductTemplate is created.

setId

public void setId(Long id)

Sets the id value for this ProductTemplate.

Parameters:

id - * Uniquely identifies the ProductTemplate. This attribute is read-only and is assigned by Google when a ProductTemplate is created.

getName

public String getName()

Gets the name value for this ProductTemplate.

Returns:

name * The name of the ProductTemplate. This attribute is required and has maximum length of 255 characters.

setName

public void setName(String name)

Sets the name value for this ProductTemplate.

Parameters:

name - * The name of the ProductTemplate. This attribute is required and has maximum length of 255 characters.

getCreationDateTime

public DateTime getCreationDateTime()

Gets the creationDateTime value for this ProductTemplate.

Returns:

creationDateTime * The creation time of the ProductTemplate. This attribute is read-only and is assigned by Google when a ProductTemplate is created.

setCreationDateTime

public void setCreationDateTime(DateTime creationDateTime)

Sets the creationDateTime value for this ProductTemplate.

Parameters:

creationDateTime - * The creation time of the ProductTemplate. This attribute is read-only and is assigned by Google when a ProductTemplate is created.

getLastModifiedDateTime

public DateTime getLastModifiedDateTime()

Gets the lastModifiedDateTime value for this ProductTemplate.

Returns:

lastModifiedDateTime * The date and time this ProductTemplate was last modified. This attribute is read-only and is assigned by Google when a ProductTemplate is updated.

setLastModifiedDateTime

public void setLastModifiedDateTime(DateTime lastModifiedDateTime)

Sets the lastModifiedDateTime value for this ProductTemplate.

Parameters:

lastModifiedDateTime - * The date and time this ProductTemplate was last modified. This attribute is read-only and is assigned by Google when a ProductTemplate is updated.

getDescription

public String getDescription()

Gets the description value for this ProductTemplate.

Returns:

description * The description of the ProductTemplate. This attribute has maximum length of 511 characters. This attribute is optional.

setDescription

public void setDescription(String description)

Sets the description value for this ProductTemplate.

Parameters:

description - * The description of the ProductTemplate. This attribute has maximum length of 511 characters. This attribute is optional.

getNameMacro

public String getNameMacro()

Gets the nameMacro value for this ProductTemplate.

Returns:

nameMacro * The name macro of the ProductTemplate. The name macro is used to generate the Product.name. This attribute is required and has maximum length of 1023 characters. The name macro can contain plain text and several placeholders that will be replaced with values specified in the ProductTemplate when generating product names. Allowed placeholders are:

Placeholder	Segmentation
<ad-unit>	ProductSegmentation.adUnitSegments
<placement>	ProductSegmentation.placementSegment
<location>	ProductSegmentation.geoSegment
<user-domain>	ProductSegmentation.userDomainSegment
<bandwidth-group>	ProductSegmentation.bandwidthSegment
<browser>	ProductSegmentation.browserSegment
<browser-language>	ProductSegmentation.browserLanguageSegment
<operating-system>	ProductSegmentation.operatingSystemSegment
<frequency-cap>	frequencyCaps
<rate-type>	rateType
<creative-placeholder-size>	creativePlaceholders
<line-item-type>	lineItemType
<line-item-priority>	priority
<template-name>	name

Each placeholder should appear no more than once and all expanded features must have their corresponding placeholders in the name macro. This attribute is required.

setNameMacro

public void setNameMacro(String nameMacro)

Sets the nameMacro value for this ProductTemplate.

Parameters:

nameMacro - * The name macro of the ProductTemplate. The name macro is used to generate the Product.name. This attribute is required and has maximum length of 1023 characters. The name macro can contain plain text and several placeholders that will be replaced with values specified in the ProductTemplate when generating product names. Allowed placeholders are:

Placeholder	Segmentation
<ad-unit>	ProductSegmentation.adUnitSegments
<placement>	ProductSegmentation.placementSegment
<location>	ProductSegmentation.geoSegment
<user-domain>	ProductSegmentation.userDomainSegment
<bandwidth-group>	ProductSegmentation.bandwidthSegment
<browser>	ProductSegmentation.browserSegment
<browser-language>	ProductSegmentation.browserLanguageSegment
<operating-system>	ProductSegmentation.operatingSystemSegment
<frequency-cap>	frequencyCaps
<rate-type>	rateType
<creative-placeholder-size>	creativePlaceholders
<line-item-type>	lineItemType
<line-item-priority>	priority
<template-name>	name

Each placeholder should appear no more than once and all expanded features must have their corresponding placeholders in the name macro. This attribute is required.

getStatus

public ProductTemplateStatus getStatus()

Gets the status value for this ProductTemplate.

Returns:

status * The status of the ProductTemplate. This attribute is read-only and is assigned by Google.

setStatus

public void setStatus(ProductTemplateStatus status)

Sets the status value for this ProductTemplate.

Parameters:

status - * The status of the ProductTemplate. This attribute is read-only and is assigned by Google.

getProductType

public ProductType getProductType()

Gets the productType value for this ProductTemplate.

Returns:

productType * The type of generated Product. Note: if the type is ProductType.OFFLINE, then the following fields must be null or empty: roadblockingType, lineItemType, frequencyCaps, productSegmentation and targeting. This attribute is required.

setProductType

public void setProductType(ProductType productType)

Sets the productType value for this ProductTemplate.

Parameters:

productType - * The type of generated Product. Note: if the type is ProductType.OFFLINE, then the following fields must be null or empty: roadblockingType, lineItemType, frequencyCaps, productSegmentation and targeting. This attribute is required.

getCreatorId

public Long getCreatorId()

Gets the creatorId value for this ProductTemplate.

Returns:

creatorId * The id of the user who created the ProductTemplate. This attribute is read-only and is assigned by Google.

setCreatorId

public void setCreatorId(Long creatorId)

Sets the creatorId value for this ProductTemplate.

Parameters:

creatorId - * The id of the user who created the ProductTemplate. This attribute is read-only and is assigned by Google.

getRateType

public RateType getRateType()

Gets the rateType value for this ProductTemplate.

Returns:

rateType * The method used for billing the created ProposalLineItem. This attribute is required.

setRateType

public void setRateType(RateType rateType)

Sets the rateType value for this ProductTemplate.

Parameters:

rateType - * The method used for billing the created ProposalLineItem. This attribute is required.

getRoadblockingType

public RoadblockingType getRoadblockingType()

Gets the roadblockingType value for this ProductTemplate.

Returns:

roadblockingType * The strategy for serving roadblocked creatives (i.e. instances where multiple creatives must be served together on a single web page) for the created ProposalLineItem. Only RoadblockingType.ONE_OR_MORE and RoadblockingType.CREATIVE_SET are supported. RoadblockingType.CREATIVE_SET can be used to serve multiple creatives on a single web page. This attribute is optional and defaults to RoadblockingType.ONE_OR_MORE when productType is ProductType.DFP.

setRoadblockingType

public void setRoadblockingType(RoadblockingType roadblockingType)

Sets the roadblockingType value for this ProductTemplate.

Parameters:

roadblockingType - * The strategy for serving roadblocked creatives (i.e. instances where multiple creatives must be served together on a single web page) for the created ProposalLineItem. Only RoadblockingType.ONE_OR_MORE and RoadblockingType.CREATIVE_SET are supported. RoadblockingType.CREATIVE_SET can be used to serve multiple creatives on a single web page. This attribute is optional and defaults to RoadblockingType.ONE_OR_MORE when productType is ProductType.DFP.

getCreativePlaceholders

public CreativePlaceholder[] getCreativePlaceholders()

Gets the creativePlaceholders value for this ProductTemplate.

Returns:

creativePlaceholders * Details about the creatives that are expected to serve for the created ProposalLineItem.

For a roadblockingType of RoadblockingType.CREATIVE_SET, all creative placeholders must have a master and at least one companion size. This attribute is required when productType is ProductType.DFP.

setCreativePlaceholders

public void setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders)

Sets the creativePlaceholders value for this ProductTemplate.

Parameters:

creativePlaceholders - * Details about the creatives that are expected to serve for the created ProposalLineItem.

For a roadblockingType of RoadblockingType.CREATIVE_SET, all creative placeholders must have a master and at least one companion size. This attribute is required when productType is ProductType.DFP.

getCreativePlaceholders

public CreativePlaceholder getCreativePlaceholders(int i)

setCreativePlaceholders

public void setCreativePlaceholders(int i,
                           CreativePlaceholder _value)

getLineItemType

public LineItemType getLineItemType()

Gets the lineItemType value for this ProductTemplate.

Returns:

lineItemType * Indicates the line item type for the created ProposalLineItem. This attribute is required when productType is ProductType.DFP.

setLineItemType

public void setLineItemType(LineItemType lineItemType)

Sets the lineItemType value for this ProductTemplate.

Parameters:

lineItemType - * Indicates the line item type for the created ProposalLineItem. This attribute is required when productType is ProductType.DFP.

getPriority

public Integer getPriority()

Gets the priority value for this ProductTemplate.

Returns:

priority * Priority of ProposalLineItem. The priority is a value between 1 and 16. If not specified, the default priority of the LineItemType will be assigned. The following default, minimum and maximum priority values is allowed for each line item type:

LineItemType	Default Priority	Minimum Priority	Maximum priority
LineItemType.SPONSORSHIP	4	2	5
LineItemType.STANDARD	8	6	10
LineItemType.NETWORK	12	11	14
LineItemType.BULK	12	11	14
LineItemType.PRICE_PRIORITY	12	11	14
LineItemType.HOUSE	16	15	16

Note: it's ignored when productType is ProductType.OFFLINE.

setPriority

public void setPriority(Integer priority)

Sets the priority value for this ProductTemplate.

Parameters:

priority - * Priority of ProposalLineItem. The priority is a value between 1 and 16. If not specified, the default priority of the LineItemType will be assigned. The following default, minimum and maximum priority values is allowed for each line item type:

LineItemType	Default Priority	Minimum Priority	Maximum priority
LineItemType.SPONSORSHIP	4	2	5
LineItemType.STANDARD	8	6	10
LineItemType.NETWORK	12	11	14
LineItemType.BULK	12	11	14
LineItemType.PRICE_PRIORITY	12	11	14
LineItemType.HOUSE	16	15	16

Note: it's ignored when productType is ProductType.OFFLINE.

getFrequencyCaps

public FrequencyCap[] getFrequencyCaps()

Gets the frequencyCaps value for this ProductTemplate.

Returns:

frequencyCaps * The set of frequency capping units for the created ProposalLineItem. Each frequency cap in the list must have unique TimeUnit. This attribute is optional.

setFrequencyCaps

public void setFrequencyCaps(FrequencyCap[] frequencyCaps)

Sets the frequencyCaps value for this ProductTemplate.

Parameters:

frequencyCaps - * The set of frequency capping units for the created ProposalLineItem. Each frequency cap in the list must have unique TimeUnit. This attribute is optional.

getFrequencyCaps

public FrequencyCap getFrequencyCaps(int i)

setFrequencyCaps

public void setFrequencyCaps(int i,
                    FrequencyCap _value)

getAllowFrequencyCapsCustomization

public Boolean getAllowFrequencyCapsCustomization()

Gets the allowFrequencyCapsCustomization value for this ProductTemplate.

Returns:

allowFrequencyCapsCustomization * Allows customization by salespeople of frequency caps when creating proposal line items. This attribute is optional and defaults to false when productType is ProductType.DFP.

setAllowFrequencyCapsCustomization

public void setAllowFrequencyCapsCustomization(Boolean allowFrequencyCapsCustomization)

Sets the allowFrequencyCapsCustomization value for this ProductTemplate.

Parameters:

allowFrequencyCapsCustomization - * Allows customization by salespeople of frequency caps when creating proposal line items. This attribute is optional and defaults to false when productType is ProductType.DFP.

getProductSegmentation

public ProductSegmentation getProductSegmentation()

Gets the productSegmentation value for this ProductTemplate.

Returns:

productSegmentation * The product segmentation. The combination from the segments and the targeting will produce the targeting on the resulting ProposalLineItem. Any type of segmentation cannot also be used for targeting. This attribute is optional. Note: if you specify ProducSegmentation#geoSegment, then ProductTemplateTargeting.geoTargeting must be null or empty, vice versa. This also applies to other targeting and segmentation.

setProductSegmentation

public void setProductSegmentation(ProductSegmentation productSegmentation)

Sets the productSegmentation value for this ProductTemplate.

Parameters:

productSegmentation - * The product segmentation. The combination from the segments and the targeting will produce the targeting on the resulting ProposalLineItem. Any type of segmentation cannot also be used for targeting. This attribute is optional. Note: if you specify ProducSegmentation#geoSegment, then ProductTemplateTargeting.geoTargeting must be null or empty, vice versa. This also applies to other targeting and segmentation.

getTargeting

public ProductTemplateTargeting getTargeting()

Gets the targeting value for this ProductTemplate.

Returns:

targeting * Targeting to be included in the created ProposalLineItem. Any type targeted cannot also be used for segmentation. If this attribute is not specified, then all targeting is not customizable. This attribute is optional. Note: if productType is ProductType.DFP and productSegmentation is not specified, this attribute is required.

setTargeting

public void setTargeting(ProductTemplateTargeting targeting)

Sets the targeting value for this ProductTemplate.

Parameters:

targeting - * Targeting to be included in the created ProposalLineItem. Any type targeted cannot also be used for segmentation. If this attribute is not specified, then all targeting is not customizable. This attribute is optional. Note: if productType is ProductType.DFP and productSegmentation is not specified, this attribute is required.

getCustomFieldValues

public BaseCustomFieldValue[] getCustomFieldValues()

Gets the customFieldValues value for this ProductTemplate.

Returns:

customFieldValues * The values of the custom fields associated with this ProductTemplate. This attribute is optional.

setCustomFieldValues

public void setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)

Sets the customFieldValues value for this ProductTemplate.

Parameters:

customFieldValues - * The values of the custom fields associated with this ProductTemplate. This attribute is optional.

getCustomFieldValues

public BaseCustomFieldValue getCustomFieldValues(int i)

setCustomFieldValues

public void setCustomFieldValues(int i,
                        BaseCustomFieldValue _value)

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