com.google.api.ads.dfp.axis.v201403

Class Product

java.lang.Object

com.google.api.ads.dfp.axis.v201403.Product

All Implemented Interfaces:

Serializable

public class Product
extends Object
implements Serializable

Proposal line items are created from products, from which their properties are copied.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Product()
Product(String name, ProductStatus status, ProductType productType, Long productTemplateId, String id, String notes, String productTemplateDescription, DateTime lastModifiedDateTime, RateType rateType, RoadblockingType roadblockingType, CreativePlaceholder[] creativePlaceholders, LineItemType lineItemType, Integer priority, FrequencyCap[] frequencyCaps, Boolean allowFrequencyCapsCustomization, 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 Product.
CreativePlaceholder[]	getCreativePlaceholders() Gets the creativePlaceholders value for this Product.
CreativePlaceholder	getCreativePlaceholders(int i)
BaseCustomFieldValue[]	getCustomFieldValues() Gets the customFieldValues value for this Product.
BaseCustomFieldValue	getCustomFieldValues(int i)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
FrequencyCap[]	getFrequencyCaps() Gets the frequencyCaps value for this Product.
FrequencyCap	getFrequencyCaps(int i)
String	getId() Gets the id value for this Product.
DateTime	getLastModifiedDateTime() Gets the lastModifiedDateTime value for this Product.
LineItemType	getLineItemType() Gets the lineItemType value for this Product.
String	getName() Gets the name value for this Product.
String	getNotes() Gets the notes value for this Product.
Integer	getPriority() Gets the priority value for this Product.
String	getProductTemplateDescription() Gets the productTemplateDescription value for this Product.
Long	getProductTemplateId() Gets the productTemplateId value for this Product.
ProductType	getProductType() Gets the productType value for this Product.
RateType	getRateType() Gets the rateType value for this Product.
RoadblockingType	getRoadblockingType() Gets the roadblockingType value for this Product.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
ProductStatus	getStatus() Gets the status value for this Product.
ProductTemplateTargeting	getTargeting() Gets the targeting value for this Product.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAllowFrequencyCapsCustomization(Boolean allowFrequencyCapsCustomization) Sets the allowFrequencyCapsCustomization value for this Product.
void	setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders) Sets the creativePlaceholders value for this Product.
void	setCreativePlaceholders(int i, CreativePlaceholder _value)
void	setCustomFieldValues(BaseCustomFieldValue[] customFieldValues) Sets the customFieldValues value for this Product.
void	setCustomFieldValues(int i, BaseCustomFieldValue _value)
void	setFrequencyCaps(FrequencyCap[] frequencyCaps) Sets the frequencyCaps value for this Product.
void	setFrequencyCaps(int i, FrequencyCap _value)
void	setId(String id) Sets the id value for this Product.
void	setLastModifiedDateTime(DateTime lastModifiedDateTime) Sets the lastModifiedDateTime value for this Product.
void	setLineItemType(LineItemType lineItemType) Sets the lineItemType value for this Product.
void	setName(String name) Sets the name value for this Product.
void	setNotes(String notes) Sets the notes value for this Product.
void	setPriority(Integer priority) Sets the priority value for this Product.
void	setProductTemplateDescription(String productTemplateDescription) Sets the productTemplateDescription value for this Product.
void	setProductTemplateId(Long productTemplateId) Sets the productTemplateId value for this Product.
void	setProductType(ProductType productType) Sets the productType value for this Product.
void	setRateType(RateType rateType) Sets the rateType value for this Product.
void	setRoadblockingType(RoadblockingType roadblockingType) Sets the roadblockingType value for this Product.
void	setStatus(ProductStatus status) Sets the status value for this Product.
void	setTargeting(ProductTemplateTargeting targeting) Sets the targeting value for this Product.

Methods inherited from class java.lang.Object

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

Constructor Detail

Product

public Product()

Product

public Product(String name,
       ProductStatus status,
       ProductType productType,
       Long productTemplateId,
       String id,
       String notes,
       String productTemplateDescription,
       DateTime lastModifiedDateTime,
       RateType rateType,
       RoadblockingType roadblockingType,
       CreativePlaceholder[] creativePlaceholders,
       LineItemType lineItemType,
       Integer priority,
       FrequencyCap[] frequencyCaps,
       Boolean allowFrequencyCapsCustomization,
       ProductTemplateTargeting targeting,
       BaseCustomFieldValue[] customFieldValues)

Method Detail

getName

public String getName()

Gets the name value for this Product.

Returns:

name * The name of the Product. This attribute is populated by Google, but can be updated. It has maximum length of 255 characters if overridden via update. This attribute is required.

setName

public void setName(String name)

Sets the name value for this Product.

Parameters:

name - * The name of the Product. This attribute is populated by Google, but can be updated. It has maximum length of 255 characters if overridden via update. This attribute is required.

getStatus

public ProductStatus getStatus()

Gets the status value for this Product.

Returns:

status * The status of the Product. This attribute is read-only.

setStatus

public void setStatus(ProductStatus status)

Sets the status value for this Product.

Parameters:

status - * The status of the Product. This attribute is read-only.

getProductType

public ProductType getProductType()

Gets the productType value for this Product.

Returns:

productType * The type of Product. The attribute is read-only.

setProductType

public void setProductType(ProductType productType)

Sets the productType value for this Product.

Parameters:

productType - * The type of Product. The attribute is read-only.

getProductTemplateId

public Long getProductTemplateId()

Gets the productTemplateId value for this Product.

Returns:

productTemplateId * The ID of the ProductTemplate from which this product is generated. This attribute is read-only and is assigned by Google when a product is created.

setProductTemplateId

public void setProductTemplateId(Long productTemplateId)

Sets the productTemplateId value for this Product.

Parameters:

productTemplateId - * The ID of the ProductTemplate from which this product is generated. This attribute is read-only and is assigned by Google when a product is created.

getId

public String getId()

Gets the id value for this Product.

Returns:

id * Uniquely identifies the Product. This attribute is read-only, with a maximum length of 1023 characters, and is assigned by Google when a product is created.

setId

public void setId(String id)

Sets the id value for this Product.

Parameters:

id - * Uniquely identifies the Product. This attribute is read-only, with a maximum length of 1023 characters, and is assigned by Google when a product is created.

getNotes

public String getNotes()

Gets the notes value for this Product.

Returns:

notes * The notes of this product. This attribute is optional, with a maximum length of 511 characters.

setNotes

public void setNotes(String notes)

Sets the notes value for this Product.

Parameters:

notes - * The notes of this product. This attribute is optional, with a maximum length of 511 characters.

getProductTemplateDescription

public String getProductTemplateDescription()

Gets the productTemplateDescription value for this Product.

Returns:

productTemplateDescription * The description of the ProductTemplate from which this product is generated. This attribute is read-only and is assigned by Google when a product is created.

setProductTemplateDescription

public void setProductTemplateDescription(String productTemplateDescription)

Sets the productTemplateDescription value for this Product.

Parameters:

productTemplateDescription - * The description of the ProductTemplate from which this product is generated. This attribute is read-only and is assigned by Google when a product is created.

getLastModifiedDateTime

public DateTime getLastModifiedDateTime()

Gets the lastModifiedDateTime value for this Product.

Returns:

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

setLastModifiedDateTime

public void setLastModifiedDateTime(DateTime lastModifiedDateTime)

Sets the lastModifiedDateTime value for this Product.

Parameters:

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

getRateType

public RateType getRateType()

Gets the rateType value for this Product.

Returns:

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

setRateType

public void setRateType(RateType rateType)

Sets the rateType value for this Product.

Parameters:

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

getRoadblockingType

public RoadblockingType getRoadblockingType()

Gets the roadblockingType value for this Product.

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 read-only.

setRoadblockingType

public void setRoadblockingType(RoadblockingType roadblockingType)

Sets the roadblockingType value for this Product.

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 read-only.

getCreativePlaceholders

public CreativePlaceholder[] getCreativePlaceholders()

Gets the creativePlaceholders value for this Product.

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 read-only.

setCreativePlaceholders

public void setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders)

Sets the creativePlaceholders value for this Product.

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 read-only.

getCreativePlaceholders

public CreativePlaceholder getCreativePlaceholders(int i)

setCreativePlaceholders

public void setCreativePlaceholders(int i,
                           CreativePlaceholder _value)

getLineItemType

public LineItemType getLineItemType()

Gets the lineItemType value for this Product.

Returns:

lineItemType * Indicates the line item type for the created ProposalLineItem. This attribute is read-only.

setLineItemType

public void setLineItemType(LineItemType lineItemType)

Sets the lineItemType value for this Product.

Parameters:

lineItemType - * Indicates the line item type for the created ProposalLineItem. This attribute is read-only.

getPriority

public Integer getPriority()

Gets the priority value for this Product.

Returns:

priority * The priority for the created ProposalLineItem. The priority is a value between 1 and 16. This attribute is read-only.

setPriority

public void setPriority(Integer priority)

Sets the priority value for this Product.

Parameters:

priority - * The priority for the created ProposalLineItem. The priority is a value between 1 and 16. This attribute is read-only.

getFrequencyCaps

public FrequencyCap[] getFrequencyCaps()

Gets the frequencyCaps value for this Product.

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 read-only.

setFrequencyCaps

public void setFrequencyCaps(FrequencyCap[] frequencyCaps)

Sets the frequencyCaps value for this Product.

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 read-only.

getFrequencyCaps

public FrequencyCap getFrequencyCaps(int i)

setFrequencyCaps

public void setFrequencyCaps(int i,
                    FrequencyCap _value)

getAllowFrequencyCapsCustomization

public Boolean getAllowFrequencyCapsCustomization()

Gets the allowFrequencyCapsCustomization value for this Product.

Returns:

allowFrequencyCapsCustomization * Allows customization by salespeople of frequency caps when creating proposal line items. This attribute is required.

setAllowFrequencyCapsCustomization

public void setAllowFrequencyCapsCustomization(Boolean allowFrequencyCapsCustomization)

Sets the allowFrequencyCapsCustomization value for this Product.

Parameters:

allowFrequencyCapsCustomization - * Allows customization by salespeople of frequency caps when creating proposal line items. This attribute is required.

getTargeting

public ProductTemplateTargeting getTargeting()

Gets the targeting value for this Product.

Returns:

targeting * The targeting for the created ProposalLineItem. It's combination of ProductTemplate#productTemplateSegment and ProductTemplate#productTemplateTargeting. See detail in ProductTemplate. This attribute is read-only.

setTargeting

public void setTargeting(ProductTemplateTargeting targeting)

Sets the targeting value for this Product.

Parameters:

targeting - * The targeting for the created ProposalLineItem. It's combination of ProductTemplate#productTemplateSegment and ProductTemplate#productTemplateTargeting. See detail in ProductTemplate. This attribute is read-only.

getCustomFieldValues

public BaseCustomFieldValue[] getCustomFieldValues()

Gets the customFieldValues value for this Product.

Returns:

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

setCustomFieldValues

public void setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)

Sets the customFieldValues value for this Product.

Parameters:

customFieldValues - * The values of the custom fields associated with this Product. 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