com.google.api.ads.dfp.axis.v201605

Class Product

java.lang.Object

com.google.api.ads.dfp.axis.v201605.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, ValueSourceType nameSource, ProductStatus status, ProductType productType, Long productTemplateId, Long id, String notes, String productTemplateDescription, DateTime lastModifiedDateTime, RateType rateType, RoadblockingType roadblockingType, DeliveryRateType deliveryRateType, CreativeRotationType creativeRotationType, CompanionDeliveryOption companionDeliveryOption, CreativePlaceholder[] creativePlaceholders, LineItemType lineItemType, Integer priority, FrequencyCap[] frequencyCaps, Targeting builtInTargeting, CustomizableAttributes customizableAttributes, BaseCustomFieldValue[] customFieldValues, EnvironmentType environmentType, Long videoMaxDuration)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Targeting	getBuiltInTargeting() Gets the builtInTargeting value for this Product.
CompanionDeliveryOption	getCompanionDeliveryOption() Gets the companionDeliveryOption value for this Product.
CreativePlaceholder[]	getCreativePlaceholders() Gets the creativePlaceholders value for this Product.
CreativePlaceholder	getCreativePlaceholders(int i)
CreativeRotationType	getCreativeRotationType() Gets the creativeRotationType value for this Product.
BaseCustomFieldValue[]	getCustomFieldValues() Gets the customFieldValues value for this Product.
BaseCustomFieldValue	getCustomFieldValues(int i)
CustomizableAttributes	getCustomizableAttributes() Gets the customizableAttributes value for this Product.
DeliveryRateType	getDeliveryRateType() Gets the deliveryRateType value for this Product.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
EnvironmentType	getEnvironmentType() Gets the environmentType value for this Product.
FrequencyCap[]	getFrequencyCaps() Gets the frequencyCaps value for this Product.
FrequencyCap	getFrequencyCaps(int i)
Long	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.
ValueSourceType	getNameSource() Gets the nameSource 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.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
Long	getVideoMaxDuration() Gets the videoMaxDuration value for this Product.
int	hashCode()
void	setBuiltInTargeting(Targeting builtInTargeting) Sets the builtInTargeting value for this Product.
void	setCompanionDeliveryOption(CompanionDeliveryOption companionDeliveryOption) Sets the companionDeliveryOption value for this Product.
void	setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders) Sets the creativePlaceholders value for this Product.
void	setCreativePlaceholders(int i, CreativePlaceholder _value)
void	setCreativeRotationType(CreativeRotationType creativeRotationType) Sets the creativeRotationType value for this Product.
void	setCustomFieldValues(BaseCustomFieldValue[] customFieldValues) Sets the customFieldValues value for this Product.
void	setCustomFieldValues(int i, BaseCustomFieldValue _value)
void	setCustomizableAttributes(CustomizableAttributes customizableAttributes) Sets the customizableAttributes value for this Product.
void	setDeliveryRateType(DeliveryRateType deliveryRateType) Sets the deliveryRateType value for this Product.
void	setEnvironmentType(EnvironmentType environmentType) Sets the environmentType value for this Product.
void	setFrequencyCaps(FrequencyCap[] frequencyCaps) Sets the frequencyCaps value for this Product.
void	setFrequencyCaps(int i, FrequencyCap _value)
void	setId(Long 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	setNameSource(ValueSourceType nameSource) Sets the nameSource 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	setVideoMaxDuration(Long videoMaxDuration) Sets the videoMaxDuration 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,
               ValueSourceType nameSource,
               ProductStatus status,
               ProductType productType,
               Long productTemplateId,
               Long id,
               String notes,
               String productTemplateDescription,
               DateTime lastModifiedDateTime,
               RateType rateType,
               RoadblockingType roadblockingType,
               DeliveryRateType deliveryRateType,
               CreativeRotationType creativeRotationType,
               CompanionDeliveryOption companionDeliveryOption,
               CreativePlaceholder[] creativePlaceholders,
               LineItemType lineItemType,
               Integer priority,
               FrequencyCap[] frequencyCaps,
               Targeting builtInTargeting,
               CustomizableAttributes customizableAttributes,
               BaseCustomFieldValue[] customFieldValues,
               EnvironmentType environmentType,
               Long videoMaxDuration)

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. To overwrite this, set the nameSource to ValueSourceType.DIRECTLY_SPECIFIED when setting the value of this field. 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. To overwrite this, set the nameSource to ValueSourceType.DIRECTLY_SPECIFIED when setting the value of this field. It has maximum length of 255 characters if overridden via update. This attribute is required.

getNameSource

public ValueSourceType getNameSource()

Gets the nameSource value for this Product.

Returns:

nameSource * Specifies the source of the name value. To revert an overridden value to its default, set this field to ValueSourceType.PARENT.

setNameSource

public void setNameSource(ValueSourceType nameSource)

Sets the nameSource value for this Product.

Parameters:

nameSource - * Specifies the source of the name value. To revert an overridden value to its default, set this field to ValueSourceType.PARENT.

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. This will always be ProductType.DFP for programmatic guaranteed products. This attribute is read-only.

setProductType

public void setProductType(ProductType productType)

Sets the productType value for this Product.

Parameters:

productType - * The type of Product. This will always be ProductType.DFP for programmatic guaranteed products. This 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.

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.

getId

public Long getId()

Gets the id value for this Product.

Returns:

id * Unique identifier of the Product. This attribute is read-only and is assigned by Google when a Product is created.

setId

public void setId(Long id)

Sets the id value for this Product.

Parameters:

id - * Unique identifier of the Product. This attribute is read-only 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.

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.

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. 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. This attribute is read-only.

getDeliveryRateType

public DeliveryRateType getDeliveryRateType()

Gets the deliveryRateType value for this Product.

Returns:

deliveryRateType * The strategy for delivering ads over the course of the line item's duration. This attribute is read-only.

setDeliveryRateType

public void setDeliveryRateType(DeliveryRateType deliveryRateType)

Sets the deliveryRateType value for this Product.

Parameters:

deliveryRateType - * The strategy for delivering ads over the course of the line item's duration. This attribute is read-only.

getCreativeRotationType

public CreativeRotationType getCreativeRotationType()

Gets the creativeRotationType value for this Product.

Returns:

creativeRotationType * The strategy used for displaying multiple Creative objects that are associated with the created ProposalLineItem. This attribute is read-only.

setCreativeRotationType

public void setCreativeRotationType(CreativeRotationType creativeRotationType)

Sets the creativeRotationType value for this Product.

Parameters:

creativeRotationType - * The strategy used for displaying multiple Creative objects that are associated with the created ProposalLineItem. This attribute is read-only.

getCompanionDeliveryOption

public CompanionDeliveryOption getCompanionDeliveryOption()

Gets the companionDeliveryOption value for this Product.

Returns:

companionDeliveryOption * The delivery option for companions. This attribute is read-only.

setCompanionDeliveryOption

public void setCompanionDeliveryOption(CompanionDeliveryOption companionDeliveryOption)

Sets the companionDeliveryOption value for this Product.

Parameters:

companionDeliveryOption - * The delivery option for companions. 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)

getBuiltInTargeting

public Targeting getBuiltInTargeting()

Gets the builtInTargeting value for this Product.

Returns:

builtInTargeting * The targeting for the created ProposalLineItem. For those scenarios using sales management, it's a combination of ProductTemplate.productSegmentation and ProductTemplate.builtInTargeting. See details in ProductTemplate. This attribute is read-only.

setBuiltInTargeting

public void setBuiltInTargeting(Targeting builtInTargeting)

Sets the builtInTargeting value for this Product.

Parameters:

builtInTargeting - * The targeting for the created ProposalLineItem. For those scenarios using sales management, it's a combination of ProductTemplate.productSegmentation and ProductTemplate.builtInTargeting. See details in ProductTemplate. This attribute is read-only.

getCustomizableAttributes

public CustomizableAttributes getCustomizableAttributes()

Gets the customizableAttributes value for this Product.

Returns:

customizableAttributes * Specifies what targeting or attributes for the created ProposalLineItem are customizable. This attribute is read-only.

setCustomizableAttributes

public void setCustomizableAttributes(CustomizableAttributes customizableAttributes)

Sets the customizableAttributes value for this Product.

Parameters:

customizableAttributes - * Specifies what targeting or attributes for the created ProposalLineItem are customizable. 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)

getEnvironmentType

public EnvironmentType getEnvironmentType()

Gets the environmentType value for this Product.

Returns:

environmentType * The environment that the created ProposalLineItem will target. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then the ProposalLineItem can only target ad units that have sizes whose AdUnitSize.environmentType is also EnvironmentType.VIDEO_PLAYER. This attribute is read-only.

setEnvironmentType

public void setEnvironmentType(EnvironmentType environmentType)

Sets the environmentType value for this Product.

Parameters:

environmentType - * The environment that the created ProposalLineItem will target. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then the ProposalLineItem can only target ad units that have sizes whose AdUnitSize.environmentType is also EnvironmentType.VIDEO_PLAYER. This attribute is read-only.

getVideoMaxDuration

public Long getVideoMaxDuration()

Gets the videoMaxDuration value for this Product.

Returns:

videoMaxDuration * The max duration of a video creative associated with this Product in milliseconds. This value is only meaningful if this is a video product. This attribute is read-only.

setVideoMaxDuration

public void setVideoMaxDuration(Long videoMaxDuration)

Sets the videoMaxDuration value for this Product.

Parameters:

videoMaxDuration - * The max duration of a video creative associated with this Product in milliseconds. This value is only meaningful if this is a video product. This attribute is read-only.

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