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

Class ProposalLineItem

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class ProposalLineItem
extends Object
implements Serializable

A ProposalLineItem is an instance of sales Product. It belongs to a Proposal and is created according to a Product and RateCard. When the proposal is turned into an Order, this object is turned into a LineItem.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProposalLineItem()
ProposalLineItem(Long id, Long proposalId, Long rateCardId, String productId, String name, DateTime startDateTime, DateTime endDateTime, String notes, CostAdjustment costAdjustment, Boolean isArchived, Long unitsBought, Integer unitsBoughtBuffer, DeliveryRateType deliveryRateType, RoadblockingType roadblockingType, CompanionDeliveryOption companionDeliveryOption, CreativeRotationType creativeRotationType, FrequencyCap[] frequencyCaps, Long dfpLineItemId, LineItemType lineItemType, Integer lineItemPriority, RateType rateType, CreativePlaceholder[] creativePlaceholders, Targeting targeting, BaseCustomFieldValue[] customFieldValues, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, ProposalLineItemPremium[] premiums, Money baseRate, Money costPerUnit, Money cost, DeliveryIndicator deliveryIndicator, DeliveryData deliveryData, ComputedStatus computedStatus, BillingCap billingCap, BillingSchedule billingSchedule, BillingSource billingSource, DateTime lastModifiedDateTime, Boolean useThirdPartyAdServerFromProposal, Integer thirdPartyAdServerId, String customThirdPartyAdServerName)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
AppliedLabel[]	getAppliedLabels() Gets the appliedLabels value for this ProposalLineItem.
AppliedLabel	getAppliedLabels(int i)
Money	getBaseRate() Gets the baseRate value for this ProposalLineItem.
BillingCap	getBillingCap() Gets the billingCap value for this ProposalLineItem.
BillingSchedule	getBillingSchedule() Gets the billingSchedule value for this ProposalLineItem.
BillingSource	getBillingSource() Gets the billingSource value for this ProposalLineItem.
CompanionDeliveryOption	getCompanionDeliveryOption() Gets the companionDeliveryOption value for this ProposalLineItem.
ComputedStatus	getComputedStatus() Gets the computedStatus value for this ProposalLineItem.
Money	getCost() Gets the cost value for this ProposalLineItem.
CostAdjustment	getCostAdjustment() Gets the costAdjustment value for this ProposalLineItem.
Money	getCostPerUnit() Gets the costPerUnit value for this ProposalLineItem.
CreativePlaceholder[]	getCreativePlaceholders() Gets the creativePlaceholders value for this ProposalLineItem.
CreativePlaceholder	getCreativePlaceholders(int i)
CreativeRotationType	getCreativeRotationType() Gets the creativeRotationType value for this ProposalLineItem.
BaseCustomFieldValue[]	getCustomFieldValues() Gets the customFieldValues value for this ProposalLineItem.
BaseCustomFieldValue	getCustomFieldValues(int i)
String	getCustomThirdPartyAdServerName() Gets the customThirdPartyAdServerName value for this ProposalLineItem.
DeliveryData	getDeliveryData() Gets the deliveryData value for this ProposalLineItem.
DeliveryIndicator	getDeliveryIndicator() Gets the deliveryIndicator value for this ProposalLineItem.
DeliveryRateType	getDeliveryRateType() Gets the deliveryRateType value for this ProposalLineItem.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Long	getDfpLineItemId() Gets the dfpLineItemId value for this ProposalLineItem.
AppliedLabel[]	getEffectiveAppliedLabels() Gets the effectiveAppliedLabels value for this ProposalLineItem.
AppliedLabel	getEffectiveAppliedLabels(int i)
DateTime	getEndDateTime() Gets the endDateTime value for this ProposalLineItem.
FrequencyCap[]	getFrequencyCaps() Gets the frequencyCaps value for this ProposalLineItem.
FrequencyCap	getFrequencyCaps(int i)
Long	getId() Gets the id value for this ProposalLineItem.
Boolean	getIsArchived() Gets the isArchived value for this ProposalLineItem.
DateTime	getLastModifiedDateTime() Gets the lastModifiedDateTime value for this ProposalLineItem.
Integer	getLineItemPriority() Gets the lineItemPriority value for this ProposalLineItem.
LineItemType	getLineItemType() Gets the lineItemType value for this ProposalLineItem.
String	getName() Gets the name value for this ProposalLineItem.
String	getNotes() Gets the notes value for this ProposalLineItem.
ProposalLineItemPremium[]	getPremiums() Gets the premiums value for this ProposalLineItem.
ProposalLineItemPremium	getPremiums(int i)
String	getProductId() Gets the productId value for this ProposalLineItem.
Long	getProposalId() Gets the proposalId value for this ProposalLineItem.
Long	getRateCardId() Gets the rateCardId value for this ProposalLineItem.
RateType	getRateType() Gets the rateType value for this ProposalLineItem.
RoadblockingType	getRoadblockingType() Gets the roadblockingType value for this ProposalLineItem.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
DateTime	getStartDateTime() Gets the startDateTime value for this ProposalLineItem.
Targeting	getTargeting() Gets the targeting value for this ProposalLineItem.
Integer	getThirdPartyAdServerId() Gets the thirdPartyAdServerId value for this ProposalLineItem.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
Long	getUnitsBought() Gets the unitsBought value for this ProposalLineItem.
Integer	getUnitsBoughtBuffer() Gets the unitsBoughtBuffer value for this ProposalLineItem.
Boolean	getUseThirdPartyAdServerFromProposal() Gets the useThirdPartyAdServerFromProposal value for this ProposalLineItem.
int	hashCode()
void	setAppliedLabels(AppliedLabel[] appliedLabels) Sets the appliedLabels value for this ProposalLineItem.
void	setAppliedLabels(int i, AppliedLabel _value)
void	setBaseRate(Money baseRate) Sets the baseRate value for this ProposalLineItem.
void	setBillingCap(BillingCap billingCap) Sets the billingCap value for this ProposalLineItem.
void	setBillingSchedule(BillingSchedule billingSchedule) Sets the billingSchedule value for this ProposalLineItem.
void	setBillingSource(BillingSource billingSource) Sets the billingSource value for this ProposalLineItem.
void	setCompanionDeliveryOption(CompanionDeliveryOption companionDeliveryOption) Sets the companionDeliveryOption value for this ProposalLineItem.
void	setComputedStatus(ComputedStatus computedStatus) Sets the computedStatus value for this ProposalLineItem.
void	setCost(Money cost) Sets the cost value for this ProposalLineItem.
void	setCostAdjustment(CostAdjustment costAdjustment) Sets the costAdjustment value for this ProposalLineItem.
void	setCostPerUnit(Money costPerUnit) Sets the costPerUnit value for this ProposalLineItem.
void	setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders) Sets the creativePlaceholders value for this ProposalLineItem.
void	setCreativePlaceholders(int i, CreativePlaceholder _value)
void	setCreativeRotationType(CreativeRotationType creativeRotationType) Sets the creativeRotationType value for this ProposalLineItem.
void	setCustomFieldValues(BaseCustomFieldValue[] customFieldValues) Sets the customFieldValues value for this ProposalLineItem.
void	setCustomFieldValues(int i, BaseCustomFieldValue _value)
void	setCustomThirdPartyAdServerName(String customThirdPartyAdServerName) Sets the customThirdPartyAdServerName value for this ProposalLineItem.
void	setDeliveryData(DeliveryData deliveryData) Sets the deliveryData value for this ProposalLineItem.
void	setDeliveryIndicator(DeliveryIndicator deliveryIndicator) Sets the deliveryIndicator value for this ProposalLineItem.
void	setDeliveryRateType(DeliveryRateType deliveryRateType) Sets the deliveryRateType value for this ProposalLineItem.
void	setDfpLineItemId(Long dfpLineItemId) Sets the dfpLineItemId value for this ProposalLineItem.
void	setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels) Sets the effectiveAppliedLabels value for this ProposalLineItem.
void	setEffectiveAppliedLabels(int i, AppliedLabel _value)
void	setEndDateTime(DateTime endDateTime) Sets the endDateTime value for this ProposalLineItem.
void	setFrequencyCaps(FrequencyCap[] frequencyCaps) Sets the frequencyCaps value for this ProposalLineItem.
void	setFrequencyCaps(int i, FrequencyCap _value)
void	setId(Long id) Sets the id value for this ProposalLineItem.
void	setIsArchived(Boolean isArchived) Sets the isArchived value for this ProposalLineItem.
void	setLastModifiedDateTime(DateTime lastModifiedDateTime) Sets the lastModifiedDateTime value for this ProposalLineItem.
void	setLineItemPriority(Integer lineItemPriority) Sets the lineItemPriority value for this ProposalLineItem.
void	setLineItemType(LineItemType lineItemType) Sets the lineItemType value for this ProposalLineItem.
void	setName(String name) Sets the name value for this ProposalLineItem.
void	setNotes(String notes) Sets the notes value for this ProposalLineItem.
void	setPremiums(int i, ProposalLineItemPremium _value)
void	setPremiums(ProposalLineItemPremium[] premiums) Sets the premiums value for this ProposalLineItem.
void	setProductId(String productId) Sets the productId value for this ProposalLineItem.
void	setProposalId(Long proposalId) Sets the proposalId value for this ProposalLineItem.
void	setRateCardId(Long rateCardId) Sets the rateCardId value for this ProposalLineItem.
void	setRateType(RateType rateType) Sets the rateType value for this ProposalLineItem.
void	setRoadblockingType(RoadblockingType roadblockingType) Sets the roadblockingType value for this ProposalLineItem.
void	setStartDateTime(DateTime startDateTime) Sets the startDateTime value for this ProposalLineItem.
void	setTargeting(Targeting targeting) Sets the targeting value for this ProposalLineItem.
void	setThirdPartyAdServerId(Integer thirdPartyAdServerId) Sets the thirdPartyAdServerId value for this ProposalLineItem.
void	setUnitsBought(Long unitsBought) Sets the unitsBought value for this ProposalLineItem.
void	setUnitsBoughtBuffer(Integer unitsBoughtBuffer) Sets the unitsBoughtBuffer value for this ProposalLineItem.
void	setUseThirdPartyAdServerFromProposal(Boolean useThirdPartyAdServerFromProposal) Sets the useThirdPartyAdServerFromProposal value for this ProposalLineItem.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProposalLineItem

public ProposalLineItem()

ProposalLineItem

public ProposalLineItem(Long id,
                Long proposalId,
                Long rateCardId,
                String productId,
                String name,
                DateTime startDateTime,
                DateTime endDateTime,
                String notes,
                CostAdjustment costAdjustment,
                Boolean isArchived,
                Long unitsBought,
                Integer unitsBoughtBuffer,
                DeliveryRateType deliveryRateType,
                RoadblockingType roadblockingType,
                CompanionDeliveryOption companionDeliveryOption,
                CreativeRotationType creativeRotationType,
                FrequencyCap[] frequencyCaps,
                Long dfpLineItemId,
                LineItemType lineItemType,
                Integer lineItemPriority,
                RateType rateType,
                CreativePlaceholder[] creativePlaceholders,
                Targeting targeting,
                BaseCustomFieldValue[] customFieldValues,
                AppliedLabel[] appliedLabels,
                AppliedLabel[] effectiveAppliedLabels,
                ProposalLineItemPremium[] premiums,
                Money baseRate,
                Money costPerUnit,
                Money cost,
                DeliveryIndicator deliveryIndicator,
                DeliveryData deliveryData,
                ComputedStatus computedStatus,
                BillingCap billingCap,
                BillingSchedule billingSchedule,
                BillingSource billingSource,
                DateTime lastModifiedDateTime,
                Boolean useThirdPartyAdServerFromProposal,
                Integer thirdPartyAdServerId,
                String customThirdPartyAdServerName)

Method Detail

getId

public Long getId()

Gets the id value for this ProposalLineItem.

Returns:

id * The unique ID of the ProposalLineItem. This attribute is readonly and is assigned by Google.

setId

public void setId(Long id)

Sets the id value for this ProposalLineItem.

Parameters:

id - * The unique ID of the ProposalLineItem. This attribute is readonly and is assigned by Google.

getProposalId

public Long getProposalId()

Gets the proposalId value for this ProposalLineItem.

Returns:

proposalId * The unique ID of the Proposal, to which the ProposalLineItem belongs. This attribute is required for creation and then is readonly.

setProposalId

public void setProposalId(Long proposalId)

Sets the proposalId value for this ProposalLineItem.

Parameters:

proposalId - * The unique ID of the Proposal, to which the ProposalLineItem belongs. This attribute is required for creation and then is readonly.

getRateCardId

public Long getRateCardId()

Gets the rateCardId value for this ProposalLineItem.

Returns:

rateCardId * The unique ID of the RateCard, based on which the ProposalLineItem is priced. The rate card must be associated with a rate belonging to the product. This attribute is required for creation and then is readonly.

setRateCardId

public void setRateCardId(Long rateCardId)

Sets the rateCardId value for this ProposalLineItem.

Parameters:

rateCardId - * The unique ID of the RateCard, based on which the ProposalLineItem is priced. The rate card must be associated with a rate belonging to the product. This attribute is required for creation and then is readonly.

getProductId

public String getProductId()

Gets the productId value for this ProposalLineItem.

Returns:

productId * The unique ID of the Product, which the ProposalLineItem is created from. This attribute is required for creation and then is readonly.

setProductId

public void setProductId(String productId)

Sets the productId value for this ProposalLineItem.

Parameters:

productId - * The unique ID of the Product, which the ProposalLineItem is created from. This attribute is required for creation and then is readonly.

getName

public String getName()

Gets the name value for this ProposalLineItem.

Returns:

name * The name of the ProposalLineItem which should be unique under the same Proposal. This attribute is required and has a maximum length of 255 characters.

setName

public void setName(String name)

Sets the name value for this ProposalLineItem.

Parameters:

name - * The name of the ProposalLineItem which should be unique under the same Proposal. This attribute is required and has a maximum length of 255 characters.

getStartDateTime

public DateTime getStartDateTime()

Gets the startDateTime value for this ProposalLineItem.

Returns:

startDateTime * The date and time at which the line item associated with the ProposalLineItem is enabled to begin serving. This attribute is required and must be in the future when it turns into a line item. This attribute becomes readonly once the ProposalLineItem has started delivering.

setStartDateTime

public void setStartDateTime(DateTime startDateTime)

Sets the startDateTime value for this ProposalLineItem.

Parameters:

startDateTime - * The date and time at which the line item associated with the ProposalLineItem is enabled to begin serving. This attribute is required and must be in the future when it turns into a line item. This attribute becomes readonly once the ProposalLineItem has started delivering.

getEndDateTime

public DateTime getEndDateTime()

Gets the endDateTime value for this ProposalLineItem.

Returns:

endDateTime * The date and time at which the line item associated with the ProposalLineItem stops beening served. This attribute is required and must be after the startDateTime.

setEndDateTime

public void setEndDateTime(DateTime endDateTime)

Sets the endDateTime value for this ProposalLineItem.

Parameters:

endDateTime - * The date and time at which the line item associated with the ProposalLineItem stops beening served. This attribute is required and must be after the startDateTime.

getNotes

public String getNotes()

Gets the notes value for this ProposalLineItem.

Returns:

notes * Provides any additional notes that may annotate the ProposalLineItem. This attribute is optional and has a maximum length of 65,535 characters.

setNotes

public void setNotes(String notes)

Sets the notes value for this ProposalLineItem.

Parameters:

notes - * Provides any additional notes that may annotate the ProposalLineItem. This attribute is optional and has a maximum length of 65,535 characters.

getCostAdjustment

public CostAdjustment getCostAdjustment()

Gets the costAdjustment value for this ProposalLineItem.

Returns:

costAdjustment * The cost adjustment applied to the ProposalLineItem. This attribute is optional and default value is CostAdjustment.NONE.

setCostAdjustment

public void setCostAdjustment(CostAdjustment costAdjustment)

Sets the costAdjustment value for this ProposalLineItem.

Parameters:

costAdjustment - * The cost adjustment applied to the ProposalLineItem. This attribute is optional and default value is CostAdjustment.NONE.

getIsArchived

public Boolean getIsArchived()

Gets the isArchived value for this ProposalLineItem.

Returns:

isArchived * The archival status of the ProposalLineItem. This attribute is readonly.

setIsArchived

public void setIsArchived(Boolean isArchived)

Sets the isArchived value for this ProposalLineItem.

Parameters:

isArchived - * The archival status of the ProposalLineItem. This attribute is readonly.

getUnitsBought

public Long getUnitsBought()

Gets the unitsBought value for this ProposalLineItem.

Returns:

unitsBought * The number of impressions or clicks or percentage of available impressions for the ProposalLineItem, it depends on lineItemType and Product.rateType. This attribute is required and must be greater than 0 when the proposal line item turns into a line item.

setUnitsBought

public void setUnitsBought(Long unitsBought)

Sets the unitsBought value for this ProposalLineItem.

Parameters:

unitsBought - * The number of impressions or clicks or percentage of available impressions for the ProposalLineItem, it depends on lineItemType and Product.rateType. This attribute is required and must be greater than 0 when the proposal line item turns into a line item.

getUnitsBoughtBuffer

public Integer getUnitsBoughtBuffer()

Gets the unitsBoughtBuffer value for this ProposalLineItem.

Returns:

unitsBoughtBuffer * A percentage number to a STANDARD line item with CPM or CPC as the rate type, so that the scheduled delivery goal could be relaxed. This number is milli-percent based, i.e. 10% would be 10000.

setUnitsBoughtBuffer

public void setUnitsBoughtBuffer(Integer unitsBoughtBuffer)

Sets the unitsBoughtBuffer value for this ProposalLineItem.

Parameters:

unitsBoughtBuffer - * A percentage number to a STANDARD line item with CPM or CPC as the rate type, so that the scheduled delivery goal could be relaxed. This number is milli-percent based, i.e. 10% would be 10000.

getDeliveryRateType

public DeliveryRateType getDeliveryRateType()

Gets the deliveryRateType value for this ProposalLineItem.

Returns:

deliveryRateType * The strategy for delivering ads over the course of the ProposalLineItem's duration. This attribute is optional and default value is DeliveryRateType.EVENLY.

setDeliveryRateType

public void setDeliveryRateType(DeliveryRateType deliveryRateType)

Sets the deliveryRateType value for this ProposalLineItem.

Parameters:

deliveryRateType - * The strategy for delivering ads over the course of the ProposalLineItem's duration. This attribute is optional and default value is DeliveryRateType.EVENLY.

getRoadblockingType

public RoadblockingType getRoadblockingType()

Gets the roadblockingType value for this ProposalLineItem.

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 optional during creation and defaults to the product's roadblocking type, or RoadblockingType.ONLY_ONE if the product does not have one.

setRoadblockingType

public void setRoadblockingType(RoadblockingType roadblockingType)

Sets the roadblockingType value for this ProposalLineItem.

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 optional during creation and defaults to the product's roadblocking type, or RoadblockingType.ONLY_ONE if the product does not have one.

getCompanionDeliveryOption

public CompanionDeliveryOption getCompanionDeliveryOption()

Gets the companionDeliveryOption value for this ProposalLineItem.

Returns:

companionDeliveryOption * The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType.CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error.

setCompanionDeliveryOption

public void setCompanionDeliveryOption(CompanionDeliveryOption companionDeliveryOption)

Sets the companionDeliveryOption value for this ProposalLineItem.

Parameters:

companionDeliveryOption - * The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType.CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error.

getCreativeRotationType

public CreativeRotationType getCreativeRotationType()

Gets the creativeRotationType value for this ProposalLineItem.

Returns:

creativeRotationType * The strategy used for displaying multiple Creative objects that are associated with the ProposalLineItem. This attribute is optional and default value is CreativeRotationType.OPTIMIZED.

setCreativeRotationType

public void setCreativeRotationType(CreativeRotationType creativeRotationType)

Sets the creativeRotationType value for this ProposalLineItem.

Parameters:

creativeRotationType - * The strategy used for displaying multiple Creative objects that are associated with the ProposalLineItem. This attribute is optional and default value is CreativeRotationType.OPTIMIZED.

getFrequencyCaps

public FrequencyCap[] getFrequencyCaps()

Gets the frequencyCaps value for this ProposalLineItem.

Returns:

frequencyCaps * The set of frequency capping units for this ProposalLineItem. This attribute is optional during creation and defaults to the product's frequency caps if Product.allowFrequencyCapsCustomization is false.

setFrequencyCaps

public void setFrequencyCaps(FrequencyCap[] frequencyCaps)

Sets the frequencyCaps value for this ProposalLineItem.

Parameters:

frequencyCaps - * The set of frequency capping units for this ProposalLineItem. This attribute is optional during creation and defaults to the product's frequency caps if Product.allowFrequencyCapsCustomization is false.

getFrequencyCaps

public FrequencyCap getFrequencyCaps(int i)

setFrequencyCaps

public void setFrequencyCaps(int i,
                    FrequencyCap _value)

getDfpLineItemId

public Long getDfpLineItemId()

Gets the dfpLineItemId value for this ProposalLineItem.

Returns:

dfpLineItemId * The unique ID of corresponding LineItem. This attribute is readonly. This will be null if the Proposal has not been pushed to DFP.

setDfpLineItemId

public void setDfpLineItemId(Long dfpLineItemId)

Sets the dfpLineItemId value for this ProposalLineItem.

Parameters:

dfpLineItemId - * The unique ID of corresponding LineItem. This attribute is readonly. This will be null if the Proposal has not been pushed to DFP.

getLineItemType

public LineItemType getLineItemType()

Gets the lineItemType value for this ProposalLineItem.

Returns:

lineItemType * The corresponding LineItemType of the ProposalLineItem. This attribute is required and must be one of:

• LineItemType.SPONSORSHIP
• LineItemType.STANDARD
• LineItemType.NETWORK
• LineItemType.BULK
• LineItemType.PRICE_PRIORITY
• LineItemType.HOUSE

setLineItemType

public void setLineItemType(LineItemType lineItemType)

Sets the lineItemType value for this ProposalLineItem.

Parameters:

lineItemType - * The corresponding LineItemType of the ProposalLineItem. This attribute is required and must be one of:

• LineItemType.SPONSORSHIP
• LineItemType.STANDARD
• LineItemType.NETWORK
• LineItemType.BULK
• LineItemType.PRICE_PRIORITY
• LineItemType.HOUSE

getLineItemPriority

public Integer getLineItemPriority()

Gets the lineItemPriority value for this ProposalLineItem.

Returns:

lineItemPriority * The priority for the corresponding LineItem of the ProposalLineItem. The priority is a value between 1 and 16. 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

This attribute is optional during creation and defaults to the product's priority, or the default value listed above if the product's priority cannot be used.

setLineItemPriority

public void setLineItemPriority(Integer lineItemPriority)

Sets the lineItemPriority value for this ProposalLineItem.

Parameters:

lineItemPriority - * The priority for the corresponding LineItem of the ProposalLineItem. The priority is a value between 1 and 16. 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

This attribute is optional during creation and defaults to the product's priority, or the default value listed above if the product's priority cannot be used.

getRateType

public RateType getRateType()

Gets the rateType value for this ProposalLineItem.

Returns:

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

setRateType

public void setRateType(RateType rateType)

Sets the rateType value for this ProposalLineItem.

Parameters:

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

getCreativePlaceholders

public CreativePlaceholder[] getCreativePlaceholders()

Gets the creativePlaceholders value for this ProposalLineItem.

Returns:

creativePlaceholders * Details about the creatives that are expected to serve through the ProposalLineItem. This attribute is optional during creation and defaults to the product's creative placeholders.

setCreativePlaceholders

public void setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders)

Sets the creativePlaceholders value for this ProposalLineItem.

Parameters:

creativePlaceholders - * Details about the creatives that are expected to serve through the ProposalLineItem. This attribute is optional during creation and defaults to the product's creative placeholders.

getCreativePlaceholders

public CreativePlaceholder getCreativePlaceholders(int i)

setCreativePlaceholders

public void setCreativePlaceholders(int i,
                           CreativePlaceholder _value)

getTargeting

public Targeting getTargeting()

Gets the targeting value for this ProposalLineItem.

Returns:

targeting * Contains the targeting criteria for the ProposalLineItem. This attribute is optional during creation and defaults to the product's targeting.

setTargeting

public void setTargeting(Targeting targeting)

Sets the targeting value for this ProposalLineItem.

Parameters:

targeting - * Contains the targeting criteria for the ProposalLineItem. This attribute is optional during creation and defaults to the product's targeting.

getCustomFieldValues

public BaseCustomFieldValue[] getCustomFieldValues()

Gets the customFieldValues value for this ProposalLineItem.

Returns:

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

setCustomFieldValues

public void setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)

Sets the customFieldValues value for this ProposalLineItem.

Parameters:

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

getCustomFieldValues

public BaseCustomFieldValue getCustomFieldValues(int i)

setCustomFieldValues

public void setCustomFieldValues(int i,
                        BaseCustomFieldValue _value)

getAppliedLabels

public AppliedLabel[] getAppliedLabels()

Gets the appliedLabels value for this ProposalLineItem.

Returns:

appliedLabels * The set of labels applied directly to the ProposalLineItem. This attribute is optional.

setAppliedLabels

public void setAppliedLabels(AppliedLabel[] appliedLabels)

Sets the appliedLabels value for this ProposalLineItem.

Parameters:

appliedLabels - * The set of labels applied directly to the ProposalLineItem. This attribute is optional.

getAppliedLabels

public AppliedLabel getAppliedLabels(int i)

setAppliedLabels

public void setAppliedLabels(int i,
                    AppliedLabel _value)

getEffectiveAppliedLabels

public AppliedLabel[] getEffectiveAppliedLabels()

Gets the effectiveAppliedLabels value for this ProposalLineItem.

Returns:

effectiveAppliedLabels * Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)

Sets the effectiveAppliedLabels value for this ProposalLineItem.

Parameters:

effectiveAppliedLabels - * Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

getEffectiveAppliedLabels

public AppliedLabel getEffectiveAppliedLabels(int i)

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(int i,
                             AppliedLabel _value)

getPremiums

public ProposalLineItemPremium[] getPremiums()

Gets the premiums value for this ProposalLineItem.

Returns:

premiums * The premiums triggered by this ProposalLineItem and their statuses. For those tiggered premiums whose statues are not specified, the default status is ProposalLineItemPremiumStatus.INCLUDED.

setPremiums

public void setPremiums(ProposalLineItemPremium[] premiums)

Sets the premiums value for this ProposalLineItem.

Parameters:

premiums - * The premiums triggered by this ProposalLineItem and their statuses. For those tiggered premiums whose statues are not specified, the default status is ProposalLineItemPremiumStatus.INCLUDED.

getPremiums

public ProposalLineItemPremium getPremiums(int i)

setPremiums

public void setPremiums(int i,
               ProposalLineItemPremium _value)

getBaseRate

public Money getBaseRate()

Gets the baseRate value for this ProposalLineItem.

Returns:

baseRate * The base rate of the ProposalLineItem in proposal currency. This attribute is readonly.

setBaseRate

public void setBaseRate(Money baseRate)

Sets the baseRate value for this ProposalLineItem.

Parameters:

baseRate - * The base rate of the ProposalLineItem in proposal currency. This attribute is readonly.

getCostPerUnit

public Money getCostPerUnit()

Gets the costPerUnit value for this ProposalLineItem.

Returns:

costPerUnit * The amount of money to spend per impression or click in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.microAmount must be multiples of 10000. This attribute is required.

setCostPerUnit

public void setCostPerUnit(Money costPerUnit)

Sets the costPerUnit value for this ProposalLineItem.

Parameters:

costPerUnit - * The amount of money to spend per impression or click in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.microAmount must be multiples of 10000. This attribute is required.

getCost

public Money getCost()

Gets the cost value for this ProposalLineItem.

Returns:

cost * The cost of the ProposalLineItem in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.microAmount must be multiples of 10000. This attribute is required.

setCost

public void setCost(Money cost)

Sets the cost value for this ProposalLineItem.

Parameters:

cost - * The cost of the ProposalLineItem in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.microAmount must be multiples of 10000. This attribute is required.

getDeliveryIndicator

public DeliveryIndicator getDeliveryIndicator()

Gets the deliveryIndicator value for this ProposalLineItem.

Returns:

deliveryIndicator * Indicates how well the line item generated from this proposal line item has been performing. This attribute is readonly and is populated by Google. This will be null if the delivery indicator information is not available due to one of the following reasons:

1. The proposal line item has not pushed to DFP.
2. The line item is not delivering.
3. The line item has an unlimited goal or cap.
4. The line item has a percentage based goal or cap.

setDeliveryIndicator

public void setDeliveryIndicator(DeliveryIndicator deliveryIndicator)

Sets the deliveryIndicator value for this ProposalLineItem.

Parameters:

deliveryIndicator - * Indicates how well the line item generated from this proposal line item has been performing. This attribute is readonly and is populated by Google. This will be null if the delivery indicator information is not available due to one of the following reasons:

1. The proposal line item has not pushed to DFP.
2. The line item is not delivering.
3. The line item has an unlimited goal or cap.
4. The line item has a percentage based goal or cap.

getDeliveryData

public DeliveryData getDeliveryData()

Gets the deliveryData value for this ProposalLineItem.

Returns:

deliveryData * Delivery data provides the number of clicks or impressions delivered for the LineItem generated from this proposal line item in the last 7 days. This attribute is readonly and is populated by Google. This will be null if the delivery data cannot be computed due to one of the following reasons:

1. The proposal line item has not pushed to DFP.
2. The line item is not deliverable.
3. The line item has completed delivering more than 7 days ago.
4. The line item has an absolute-based goal. deliveryIndicator should be used to track its progress in this case.

setDeliveryData

public void setDeliveryData(DeliveryData deliveryData)

Sets the deliveryData value for this ProposalLineItem.

Parameters:

deliveryData - * Delivery data provides the number of clicks or impressions delivered for the LineItem generated from this proposal line item in the last 7 days. This attribute is readonly and is populated by Google. This will be null if the delivery data cannot be computed due to one of the following reasons:

1. The proposal line item has not pushed to DFP.
2. The line item is not deliverable.
3. The line item has completed delivering more than 7 days ago.
4. The line item has an absolute-based goal. deliveryIndicator should be used to track its progress in this case.

getComputedStatus

public ComputedStatus getComputedStatus()

Gets the computedStatus value for this ProposalLineItem.

Returns:

computedStatus * The status of the LineItem generated from this proposal line item. This attribute is readonly. This will be null if the proposal line item has not pushed to DFP.

setComputedStatus

public void setComputedStatus(ComputedStatus computedStatus)

Sets the computedStatus value for this ProposalLineItem.

Parameters:

computedStatus - * The status of the LineItem generated from this proposal line item. This attribute is readonly. This will be null if the proposal line item has not pushed to DFP.

getBillingCap

public BillingCap getBillingCap()

Gets the billingCap value for this ProposalLineItem.

Returns:

billingCap * Overrides the billing cap of this ProposalLineItem. This attribute is optional. If none of billingCap, billingSchedule and billingSource is set, this ProposalLineItem will use its Proposal's billing settings. Otherwise, Either this attribute or billingSchedule will be used, according to the billingSource.

setBillingCap

public void setBillingCap(BillingCap billingCap)

Sets the billingCap value for this ProposalLineItem.

Parameters:

billingCap - * Overrides the billing cap of this ProposalLineItem. This attribute is optional. If none of billingCap, billingSchedule and billingSource is set, this ProposalLineItem will use its Proposal's billing settings. Otherwise, Either this attribute or billingSchedule will be used, according to the billingSource.

getBillingSchedule

public BillingSchedule getBillingSchedule()

Gets the billingSchedule value for this ProposalLineItem.

Returns:

billingSchedule * Overrides the billing schedule of this ProposalLineItem. This attribute is optional. If none of billingCap, billingSchedule and billingSource is set, this ProposalLineItem will use its Proposal's billing settings. Otherwise, Either this attribute or billingCap will be used, according to the billingSource.

setBillingSchedule

public void setBillingSchedule(BillingSchedule billingSchedule)

Sets the billingSchedule value for this ProposalLineItem.

Parameters:

billingSchedule - * Overrides the billing schedule of this ProposalLineItem. This attribute is optional. If none of billingCap, billingSchedule and billingSource is set, this ProposalLineItem will use its Proposal's billing settings. Otherwise, Either this attribute or billingCap will be used, according to the billingSource.

getBillingSource

public BillingSource getBillingSource()

Gets the billingSource value for this ProposalLineItem.

Returns:

billingSource * Overrides the billing source of this ProposalLineItem. This attribute is optional. If none of billingCap, billingSchedule and billingSource is set, this ProposalLineItem will use its Proposal's billing settings. Otherwise, If the value is BillingSource.CONTRACTED, the billingSchedule will be used for billing, otherwise the billingCap will be used.

setBillingSource

public void setBillingSource(BillingSource billingSource)

Sets the billingSource value for this ProposalLineItem.

Parameters:

billingSource - * Overrides the billing source of this ProposalLineItem. This attribute is optional. If none of billingCap, billingSchedule and billingSource is set, this ProposalLineItem will use its Proposal's billing settings. Otherwise, If the value is BillingSource.CONTRACTED, the billingSchedule will be used for billing, otherwise the billingCap will be used.

getLastModifiedDateTime

public DateTime getLastModifiedDateTime()

Gets the lastModifiedDateTime value for this ProposalLineItem.

Returns:

lastModifiedDateTime * The date and time this ProposalLineItem was last modified. This attribute is readonly and is assigned by Google when a ProposalLineItem is updated.

setLastModifiedDateTime

public void setLastModifiedDateTime(DateTime lastModifiedDateTime)

Sets the lastModifiedDateTime value for this ProposalLineItem.

Parameters:

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

getUseThirdPartyAdServerFromProposal

public Boolean getUseThirdPartyAdServerFromProposal()

Gets the useThirdPartyAdServerFromProposal value for this ProposalLineItem.

Returns:

useThirdPartyAdServerFromProposal * Whether to use the corresponding proposal's third party ad server. If this field is true, thirdPartyAdServerId and customThirdPartyAdServerName will be ignored.

setUseThirdPartyAdServerFromProposal

public void setUseThirdPartyAdServerFromProposal(Boolean useThirdPartyAdServerFromProposal)

Sets the useThirdPartyAdServerFromProposal value for this ProposalLineItem.

Parameters:

useThirdPartyAdServerFromProposal - * Whether to use the corresponding proposal's third party ad server. If this field is true, thirdPartyAdServerId and customThirdPartyAdServerName will be ignored.

getThirdPartyAdServerId

public Integer getThirdPartyAdServerId()

Gets the thirdPartyAdServerId value for this ProposalLineItem.

Returns:

thirdPartyAdServerId * A predefined third party ad server, which will be used to fill in reconciliation. All predefined third party ad servers can be found in the Third_Party_Company PQL table. If actual third party ad server is not in the predefined list, this field is set to 0, and actual third party ad server name is set in customThirdPartyAdServerName.

setThirdPartyAdServerId

public void setThirdPartyAdServerId(Integer thirdPartyAdServerId)

Sets the thirdPartyAdServerId value for this ProposalLineItem.

Parameters:

thirdPartyAdServerId - * A predefined third party ad server, which will be used to fill in reconciliation. All predefined third party ad servers can be found in the Third_Party_Company PQL table. If actual third party ad server is not in the predefined list, this field is set to 0, and actual third party ad server name is set in customThirdPartyAdServerName.

getCustomThirdPartyAdServerName

public String getCustomThirdPartyAdServerName()

Gets the customThirdPartyAdServerName value for this ProposalLineItem.

Returns:

customThirdPartyAdServerName * When actual third party ad server is not in the predefined list, thirdPartyAdServerId is set to 0, and actual third party ad server name is set here. When thirdPartyAdServerId is not 0, this field is ignored.

setCustomThirdPartyAdServerName

public void setCustomThirdPartyAdServerName(String customThirdPartyAdServerName)

Sets the customThirdPartyAdServerName value for this ProposalLineItem.

Parameters:

customThirdPartyAdServerName - * When actual third party ad server is not in the predefined list, thirdPartyAdServerId is set to 0, and actual third party ad server name is set here. When thirdPartyAdServerId is not 0, this field is ignored.

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