public class Product extends Object implements Serializable
Proposal line items are created from products,
from which their properties are copied.| 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,
ProductMarketplaceInfo productMarketplaceInfo,
Long videoMaxDuration) |
| 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.
|
ProductMarketplaceInfo |
getProductMarketplaceInfo()
Gets the productMarketplaceInfo 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 |
setProductMarketplaceInfo(ProductMarketplaceInfo productMarketplaceInfo)
Sets the productMarketplaceInfo 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.
|
String |
toString() |
public 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, ProductMarketplaceInfo productMarketplaceInfo, Long videoMaxDuration)
public String getName()
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.public void setName(String name)
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.public ValueSourceType getNameSource()
name value.
To revert an overridden value to its default, set
this field to ValueSourceType.PARENT.
This attribute
is applicable when:public void setNameSource(ValueSourceType nameSource)
nameSource - * Specifies the source of the name value.
To revert an overridden value to its default, set
this field to ValueSourceType.PARENT.
This attribute
is applicable when:public ProductStatus getStatus()
Product.
This attribute is read-only.public void setStatus(ProductStatus status)
status - * The status of the Product.
This attribute is read-only.public ProductType getProductType()
Product. This will always be ProductType.DFP
for programmatic
guaranteed products.
This attribute is
read-only when:public void setProductType(ProductType productType)
productType - * The type of Product. This will always be ProductType.DFP
for programmatic
guaranteed products.
This attribute is
read-only when:public Long getProductTemplateId()
ProductTemplate from which this product
is generated.
This attribute
is applicable when:public void setProductTemplateId(Long productTemplateId)
productTemplateId - * The ID of the ProductTemplate from which this product
is generated.
This attribute
is applicable when:public Long getId()
Product.
This attribute is read-only and is assigned by Google
when
a Product is created.public void setId(Long id)
id - * Unique identifier of the Product.
This attribute is read-only and is assigned by Google
when
a Product is created.public String getNotes()
public void setNotes(String notes)
notes - * The notes of this product.
This attribute is optional, with a maximum length
of 511 characters.public String getProductTemplateDescription()
ProductTemplate from which this
product is generated.
This attribute
is applicable when:public void setProductTemplateDescription(String productTemplateDescription)
productTemplateDescription - * The description of the ProductTemplate from which this
product is generated.
This attribute
is applicable when:public DateTime getLastModifiedDateTime()
public void setLastModifiedDateTime(DateTime lastModifiedDateTime)
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.public RateType getRateType()
ProposalLineItem.
This attribute is read-only when:public void setRateType(RateType rateType)
rateType - * The method used for billing the created ProposalLineItem.
This attribute is read-only when:public RoadblockingType getRoadblockingType()
public void setRoadblockingType(RoadblockingType roadblockingType)
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 applicable when:public DeliveryRateType getDeliveryRateType()
public void setDeliveryRateType(DeliveryRateType deliveryRateType)
deliveryRateType - * The strategy for delivering ads over the course of the line
item's duration.
This attribute
is applicable when:public CreativeRotationType getCreativeRotationType()
Creative
objects that are
associated with the created ProposalLineItem.
This attribute is applicable when:public void setCreativeRotationType(CreativeRotationType creativeRotationType)
creativeRotationType - * The strategy used for displaying multiple Creative
objects that are
associated with the created ProposalLineItem.
This attribute is applicable when:public CompanionDeliveryOption getCompanionDeliveryOption()
public void setCompanionDeliveryOption(CompanionDeliveryOption companionDeliveryOption)
companionDeliveryOption - * The delivery option for companions.
This attribute
is applicable when:public CreativePlaceholder[] getCreativePlaceholders()
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 when:
public void setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders)
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 when:
public CreativePlaceholder getCreativePlaceholders(int i)
public void setCreativePlaceholders(int i,
CreativePlaceholder _value)
public LineItemType getLineItemType()
ProposalLineItem.
This attribute is read-only when:public void setLineItemType(LineItemType lineItemType)
lineItemType - * Indicates the line item type for the created ProposalLineItem.
This attribute is read-only when:public Integer getPriority()
ProposalLineItem. The
priority is a value
between 1 and 16.
This attribute is
read-only when:public void setPriority(Integer priority)
priority - * The priority for the created ProposalLineItem. The
priority is a value
between 1 and 16.
This attribute is
read-only when:public FrequencyCap[] getFrequencyCaps()
ProposalLineItem.
Each frequency cap in the list must have unique TimeUnit.
This attribute
is applicable when:public void setFrequencyCaps(FrequencyCap[] frequencyCaps)
frequencyCaps - * The set of frequency capping units for the created ProposalLineItem.
Each frequency cap in the list must have unique TimeUnit.
This attribute
is applicable when:public FrequencyCap getFrequencyCaps(int i)
public void setFrequencyCaps(int i,
FrequencyCap _value)
public Targeting getBuiltInTargeting()
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 when:public void setBuiltInTargeting(Targeting builtInTargeting)
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 when:public CustomizableAttributes getCustomizableAttributes()
ProposalLineItem
are customizable.
This attribute
is applicable when:public void setCustomizableAttributes(CustomizableAttributes customizableAttributes)
customizableAttributes - * Specifies what targeting or attributes for the created ProposalLineItem
are customizable.
This attribute
is applicable when:public BaseCustomFieldValue[] getCustomFieldValues()
Product.
This attribute is optional.
This attribute
is applicable when:public void setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)
customFieldValues - * The values of the custom fields associated with this Product.
This attribute is optional.
This attribute
is applicable when:public BaseCustomFieldValue getCustomFieldValues(int i)
public void setCustomFieldValues(int i,
BaseCustomFieldValue _value)
public EnvironmentType getEnvironmentType()
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 when:public void setEnvironmentType(EnvironmentType environmentType)
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 when:public ProductMarketplaceInfo getProductMarketplaceInfo()
Product.
This attribute
is applicable when:public void setProductMarketplaceInfo(ProductMarketplaceInfo productMarketplaceInfo)
productMarketplaceInfo - * Marketplace information of this Product.
This attribute
is applicable when:public Long getVideoMaxDuration()
Product in milliseconds.
This value is only meaningful if this is a video product.
This attribute is applicable when:public void setVideoMaxDuration(Long videoMaxDuration)
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 applicable when:public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(String mechType, Class _javaType, QName _xmlType)
Copyright © 2018. All Rights Reserved.