public class ProposalLineItem extends Object implements Serializable
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.| Constructor and Description |
|---|
ProposalLineItem() |
ProposalLineItem(Long id,
Long proposalId,
Long packageId,
Long rateCardId,
Long productId,
String name,
DateTime startDateTime,
DateTime endDateTime,
String timeZoneId,
String notes,
CostAdjustment costAdjustment,
Boolean isArchived,
Goal goal,
Integer contractedQuantityBuffer,
Long scheduledQuantity,
Long contractedUnitsBought,
DeliveryRateType deliveryRateType,
RoadblockingType roadblockingType,
CompanionDeliveryOption companionDeliveryOption,
CreativeRotationType creativeRotationType,
Long videoMaxDuration,
FrequencyCap[] frequencyCaps,
Long dfpLineItemId,
LineItemType lineItemType,
Integer lineItemPriority,
RateType rateType,
CreativePlaceholder[] creativePlaceholders,
Targeting targeting,
BaseCustomFieldValue[] customFieldValues,
AppliedLabel[] appliedLabels,
AppliedLabel[] effectiveAppliedLabels,
Boolean disableSameAdvertiserCompetitiveExclusion,
ProposalLineItemConstraints productConstraints,
ProposalLineItemPremium[] premiums,
Boolean isSold,
Money baseRate,
Money costPerUnit,
Money cost,
DeliveryIndicator deliveryIndicator,
DeliveryData deliveryData,
ComputedStatus computedStatus,
BillingCap billingCap,
BillingSchedule billingSchedule,
BillingSource billingSource,
BillingBase billingBase,
DateTime lastModifiedDateTime,
ReservationStatus reservationStatus,
Boolean useThirdPartyAdServerFromProposal,
Integer thirdPartyAdServerId,
String customThirdPartyAdServerName,
EnvironmentType environmentType,
LinkStatus linkStatus) |
| 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.
|
BillingBase |
getBillingBase()
Gets the billingBase 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.
|
Integer |
getContractedQuantityBuffer()
Gets the contractedQuantityBuffer value for this ProposalLineItem.
|
Long |
getContractedUnitsBought()
Gets the contractedUnitsBought 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.
|
Boolean |
getDisableSameAdvertiserCompetitiveExclusion()
Gets the disableSameAdvertiserCompetitiveExclusion 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.
|
EnvironmentType |
getEnvironmentType()
Gets the environmentType value for this ProposalLineItem.
|
FrequencyCap[] |
getFrequencyCaps()
Gets the frequencyCaps value for this ProposalLineItem.
|
FrequencyCap |
getFrequencyCaps(int i) |
Goal |
getGoal()
Gets the goal value for this ProposalLineItem.
|
Long |
getId()
Gets the id value for this ProposalLineItem.
|
Boolean |
getIsArchived()
Gets the isArchived value for this ProposalLineItem.
|
Boolean |
getIsSold()
Gets the isSold 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.
|
LinkStatus |
getLinkStatus()
Gets the linkStatus value for this ProposalLineItem.
|
String |
getName()
Gets the name value for this ProposalLineItem.
|
String |
getNotes()
Gets the notes value for this ProposalLineItem.
|
Long |
getPackageId()
Gets the packageId value for this ProposalLineItem.
|
ProposalLineItemPremium[] |
getPremiums()
Gets the premiums value for this ProposalLineItem.
|
ProposalLineItemPremium |
getPremiums(int i) |
ProposalLineItemConstraints |
getProductConstraints()
Gets the productConstraints value for this ProposalLineItem.
|
Long |
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.
|
ReservationStatus |
getReservationStatus()
Gets the reservationStatus value for this ProposalLineItem.
|
RoadblockingType |
getRoadblockingType()
Gets the roadblockingType value for this ProposalLineItem.
|
Long |
getScheduledQuantity()
Gets the scheduledQuantity 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.
|
String |
getTimeZoneId()
Gets the timeZoneId value for this ProposalLineItem.
|
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Return type metadata object
|
Boolean |
getUseThirdPartyAdServerFromProposal()
Gets the useThirdPartyAdServerFromProposal value for this ProposalLineItem.
|
Long |
getVideoMaxDuration()
Gets the videoMaxDuration 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 |
setBillingBase(BillingBase billingBase)
Sets the billingBase 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 |
setContractedQuantityBuffer(Integer contractedQuantityBuffer)
Sets the contractedQuantityBuffer value for this ProposalLineItem.
|
void |
setContractedUnitsBought(Long contractedUnitsBought)
Sets the contractedUnitsBought 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 |
setDisableSameAdvertiserCompetitiveExclusion(Boolean disableSameAdvertiserCompetitiveExclusion)
Sets the disableSameAdvertiserCompetitiveExclusion 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 |
setEnvironmentType(EnvironmentType environmentType)
Sets the environmentType value for this ProposalLineItem.
|
void |
setFrequencyCaps(FrequencyCap[] frequencyCaps)
Sets the frequencyCaps value for this ProposalLineItem.
|
void |
setFrequencyCaps(int i,
FrequencyCap _value) |
void |
setGoal(Goal goal)
Sets the goal value for this ProposalLineItem.
|
void |
setId(Long id)
Sets the id value for this ProposalLineItem.
|
void |
setIsArchived(Boolean isArchived)
Sets the isArchived value for this ProposalLineItem.
|
void |
setIsSold(Boolean isSold)
Sets the isSold 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 |
setLinkStatus(LinkStatus linkStatus)
Sets the linkStatus 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 |
setPackageId(Long packageId)
Sets the packageId value for this ProposalLineItem.
|
void |
setPremiums(int i,
ProposalLineItemPremium _value) |
void |
setPremiums(ProposalLineItemPremium[] premiums)
Sets the premiums value for this ProposalLineItem.
|
void |
setProductConstraints(ProposalLineItemConstraints productConstraints)
Sets the productConstraints value for this ProposalLineItem.
|
void |
setProductId(Long 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 |
setReservationStatus(ReservationStatus reservationStatus)
Sets the reservationStatus value for this ProposalLineItem.
|
void |
setRoadblockingType(RoadblockingType roadblockingType)
Sets the roadblockingType value for this ProposalLineItem.
|
void |
setScheduledQuantity(Long scheduledQuantity)
Sets the scheduledQuantity 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 |
setTimeZoneId(String timeZoneId)
Sets the timeZoneId value for this ProposalLineItem.
|
void |
setUseThirdPartyAdServerFromProposal(Boolean useThirdPartyAdServerFromProposal)
Sets the useThirdPartyAdServerFromProposal value for this ProposalLineItem.
|
void |
setVideoMaxDuration(Long videoMaxDuration)
Sets the videoMaxDuration value for this ProposalLineItem.
|
public ProposalLineItem()
public ProposalLineItem(Long id, Long proposalId, Long packageId, Long rateCardId, Long productId, String name, DateTime startDateTime, DateTime endDateTime, String timeZoneId, String notes, CostAdjustment costAdjustment, Boolean isArchived, Goal goal, Integer contractedQuantityBuffer, Long scheduledQuantity, Long contractedUnitsBought, DeliveryRateType deliveryRateType, RoadblockingType roadblockingType, CompanionDeliveryOption companionDeliveryOption, CreativeRotationType creativeRotationType, Long videoMaxDuration, FrequencyCap[] frequencyCaps, Long dfpLineItemId, LineItemType lineItemType, Integer lineItemPriority, RateType rateType, CreativePlaceholder[] creativePlaceholders, Targeting targeting, BaseCustomFieldValue[] customFieldValues, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, Boolean disableSameAdvertiserCompetitiveExclusion, ProposalLineItemConstraints productConstraints, ProposalLineItemPremium[] premiums, Boolean isSold, Money baseRate, Money costPerUnit, Money cost, DeliveryIndicator deliveryIndicator, DeliveryData deliveryData, ComputedStatus computedStatus, BillingCap billingCap, BillingSchedule billingSchedule, BillingSource billingSource, BillingBase billingBase, DateTime lastModifiedDateTime, ReservationStatus reservationStatus, Boolean useThirdPartyAdServerFromProposal, Integer thirdPartyAdServerId, String customThirdPartyAdServerName, EnvironmentType environmentType, LinkStatus linkStatus)
public Long getId()
ProposalLineItem.
This attribute is read-only.public void setId(Long id)
id - * The unique ID of the ProposalLineItem.
This attribute is read-only.public Long getProposalId()
Proposal, to which the ProposalLineItem
belongs. This attribute is required for creation and
then is readonly.
This attribute is required.public void setProposalId(Long proposalId)
proposalId - * The unique ID of the Proposal, to which the ProposalLineItem
belongs. This attribute is required for creation and
then is readonly.
This attribute is required.public Long getPackageId()
Package, to which the ProposalLineItem
belongs.
This attribute is assigned by Google when creating
the ProposalLineItem by performing
the package action CreateProposalLineItemsFromPackages.
This attribute is applicable when:public void setPackageId(Long packageId)
packageId - * The unique ID of the Package, to which the ProposalLineItem
belongs.
This attribute is assigned by Google when creating
the ProposalLineItem by performing
the package action CreateProposalLineItemsFromPackages.
This attribute is applicable when:public Long getRateCardId()
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.
This attribute
is applicable when:public void setRateCardId(Long rateCardId)
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.
This attribute
is applicable when:public Long getProductId()
Product, which the ProposalLineItem
is created from. This attribute is readonly after creation.
This attribute is
read-only when:public void setProductId(Long productId)
productId - * The unique ID of the Product, which the ProposalLineItem
is created from. This attribute is readonly after creation.
This attribute is
read-only when:public String getName()
ProposalLineItem which should be unique
under the same
Proposal. This attribute has a maximum length
of 255 characters.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute is required.public void setName(String name)
name - * The name of the ProposalLineItem which should be unique
under the same
Proposal. This attribute has a maximum length
of 255 characters.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute is required.public DateTime getStartDateTime()
ProposalLineItem is enabled to begin serving. This attribute
is optional
during creation, but required and must be in the future
when it turns into a line item.
The DateTime.timeZoneID is required if start
date time is not null.
This attribute becomes readonly once the ProposalLineItem
has started delivering.public void setStartDateTime(DateTime startDateTime)
startDateTime - * The date and time at which the line item associated with the
ProposalLineItem is enabled to begin serving. This attribute
is optional
during creation, but required and must be in the future
when it turns into a line item.
The DateTime.timeZoneID is required if start
date time is not null.
This attribute becomes readonly once the ProposalLineItem
has started delivering.public DateTime getEndDateTime()
ProposalLineItem stops beening served. This attribute is optional
during creation,
but required and must be after the startDateTime.
The DateTime.timeZoneID is
required if end date time is not null.public void setEndDateTime(DateTime endDateTime)
endDateTime - * The date and time at which the line item associated with the
ProposalLineItem stops beening served. This attribute is optional
during creation,
but required and must be after the startDateTime.
The DateTime.timeZoneID is
required if end date time is not null.public String getTimeZoneId()
ProposalLineItem. The number of serving days
is calculated in this time zone.
So if rateType is RateType.CPD, it
will affect the cost calculation.
The startDateTime and endDateTime
will be returned in this time zone.
This attribute is optional and defaults to the network's
time zone.
This attribute is
read-only when:public void setTimeZoneId(String timeZoneId)
timeZoneId - * The time zone ID in tz database format (e.g. "America/Los_Angeles")
for this
ProposalLineItem. The number of serving days
is calculated in this time zone.
So if rateType is RateType.CPD, it
will affect the cost calculation.
The startDateTime and endDateTime
will be returned in this time zone.
This attribute is optional and defaults to the network's
time zone.
This attribute is
read-only when:public String getNotes()
ProposalLineItem. This
attribute is optional and has a maximum length of
65,535 characters.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.public void setNotes(String notes)
notes - * Provides any additional notes that may annotate the ProposalLineItem. This
attribute is optional and has a maximum length of
65,535 characters.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.public CostAdjustment getCostAdjustment()
ProposalLineItem.
This attribute is
optional and default value is CostAdjustment.NONE.
This attribute is applicable when:public void setCostAdjustment(CostAdjustment costAdjustment)
costAdjustment - * The cost adjustment applied to the ProposalLineItem.
This attribute is
optional and default value is CostAdjustment.NONE.
This attribute is applicable when:public Boolean getIsArchived()
ProposalLineItem.
This attribute is read-only.public void setIsArchived(Boolean isArchived)
isArchived - * The archival status of the ProposalLineItem.
This attribute is read-only.public Goal getGoal()
ProposalLineItem
is associated with, which is used in its pacing and
budgeting.
Goal.units must be greater than 0 when the
proposal line item turns into a line item,
Goal.goalType and Goal.unitType are
readonly.
This attribute is required.public void setGoal(Goal goal)
goal - * The goal(i.e. contracted quantity, quantity or limit) that
this ProposalLineItem
is associated with, which is used in its pacing and
budgeting.
Goal.units must be greater than 0 when the
proposal line item turns into a line item,
Goal.goalType and Goal.unitType are
readonly.
This attribute is required.public Integer getContractedQuantityBuffer()
public void setContractedQuantityBuffer(Integer contractedQuantityBuffer)
contractedQuantityBuffer - * 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.
This attribute
is applicable when:public Long getScheduledQuantity()
Goal.units and contractedQuantityBuffer.
This attribute is applicable when:public void setScheduledQuantity(Long scheduledQuantity)
scheduledQuantity - * The scheduled number of impressions or clicks of a STANDARD
line item with CPM or CPC as the
rate type, so that the scheduled delivery goal could
be relaxed. This attribute is calculated
from Goal.units and contractedQuantityBuffer.
This attribute is applicable when:public Long getContractedUnitsBought()
LineItemType.SPONSORSHIP ProposalLineItem, has
RateType.CPD as a rate type, and #isProgrammatic
is false,
then this represents the lifetime minimum impression.
If this is a LineItemType.SPONSORSHIP ProposalLineItem,
has
RateType.CPD as a rate type, and #isProgrammatic
is true,
then this represents the daily minimum impression.
This attribute is required for percentage-based-goal
proposal line items. It
does not impact ad-serving and is for
reporting purposes only.
public void setContractedUnitsBought(Long contractedUnitsBought)
contractedUnitsBought - * The contracted number of impressions or clicks.
If this is a LineItemType.SPONSORSHIP ProposalLineItem, has
RateType.CPD as a rate type, and #isProgrammatic
is false,
then this represents the lifetime minimum impression.
If this is a LineItemType.SPONSORSHIP ProposalLineItem,
has
RateType.CPD as a rate type, and #isProgrammatic
is true,
then this represents the daily minimum impression.
This attribute is required for percentage-based-goal
proposal line items. It
does not impact ad-serving and is for
reporting purposes only.
public DeliveryRateType getDeliveryRateType()
ProposalLineItem's
duration. This attribute is optional and default value
is
DeliveryRateType.EVENLY.public void setDeliveryRateType(DeliveryRateType deliveryRateType)
deliveryRateType - * The strategy for delivering ads over the course of the ProposalLineItem's
duration. This attribute is optional and default value
is
DeliveryRateType.EVENLY.public RoadblockingType getRoadblockingType()
product's roadblocking
type,
or RoadblockingType.ONE_OR_MORE if not specified
by the product.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 optional during creation and defaults to the
product's roadblocking
type,
or RoadblockingType.ONE_OR_MORE if not specified
by the product.public CompanionDeliveryOption getCompanionDeliveryOption()
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.public void setCompanionDeliveryOption(CompanionDeliveryOption companionDeliveryOption)
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.public CreativeRotationType getCreativeRotationType()
Creative
objects that are
associated with the ProposalLineItem. This
attribute is optional and
default value is CreativeRotationType.OPTIMIZED.
This attribute is applicable when:public void setCreativeRotationType(CreativeRotationType creativeRotationType)
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.
This attribute is applicable when:public Long getVideoMaxDuration()
ProposalLineItem
in milliseconds. This attribute is optional, defaults
to the Product.videoMaxDuration
on the Product it was created with, and only
meaningful if this is a
video proposal line item.public void setVideoMaxDuration(Long videoMaxDuration)
videoMaxDuration - * The max duration of a video creative associated with this ProposalLineItem
in milliseconds. This attribute is optional, defaults
to the Product.videoMaxDuration
on the Product it was created with, and only
meaningful if this is a
video proposal line item.public FrequencyCap[] getFrequencyCaps()
ProposalLineItem.
This
attribute is optional during creation and defaults
to the
product's frequency caps
if
Product#allowFrequencyCapsCustomization is
false.public void setFrequencyCaps(FrequencyCap[] frequencyCaps)
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.public FrequencyCap getFrequencyCaps(int i)
public void setFrequencyCaps(int i,
FrequencyCap _value)
public Long getDfpLineItemId()
public void setDfpLineItemId(Long dfpLineItemId)
public LineItemType getLineItemType()
LineItemType of the ProposalLineItem.
For a programmatic ProposalLineItem, the value can only be
one of:
This attribute is required.public void setLineItemType(LineItemType lineItemType)
lineItemType - * The corresponding LineItemType of the ProposalLineItem.
For a programmatic ProposalLineItem, the value can only be
one of:
This attribute is required.public Integer getLineItemPriority()
LineItem of the
ProposalLineItem.
This attribute is optional during creation and defaults
to the
product's priority, or a
default value assigned by Google.
See LineItemSummary.priority for more information.public void setLineItemPriority(Integer lineItemPriority)
lineItemPriority - * The priority for the corresponding LineItem of the
ProposalLineItem.
This attribute is optional during creation and defaults
to the
product's priority, or a
default value assigned by Google.
See LineItemSummary.priority for more information.public RateType getRateType()
ProposalLineItem.
This attribute is
read-only when:public void setRateType(RateType rateType)
rateType - * The method used for billing the ProposalLineItem.
This attribute is
read-only when:public CreativePlaceholder[] getCreativePlaceholders()
ProposalLineItem. This attribute is optional
during creation and defaults to the
product's creative
placeholders.
This attribute is
required when:public void setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders)
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.
This attribute is
required when:public CreativePlaceholder getCreativePlaceholders(int i)
public void setCreativePlaceholders(int i,
CreativePlaceholder _value)
public Targeting getTargeting()
ProposalLineItem.
This attribute is
optional during creation and defaults to the product's targeting.public void setTargeting(Targeting targeting)
targeting - * Contains the targeting criteria for the ProposalLineItem.
This attribute is
optional during creation and defaults to the product's targeting.public BaseCustomFieldValue[] getCustomFieldValues()
ProposalLineItem.
This attribute is optional.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.public void setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)
customFieldValues - * The values of the custom fields associated with the ProposalLineItem.
This attribute is optional.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.public BaseCustomFieldValue getCustomFieldValues(int i)
public void setCustomFieldValues(int i,
BaseCustomFieldValue _value)
public AppliedLabel[] getAppliedLabels()
ProposalLineItem.
This attribute is optional.public void setAppliedLabels(AppliedLabel[] appliedLabels)
appliedLabels - * The set of labels applied directly to the ProposalLineItem.
This attribute is optional.public AppliedLabel getAppliedLabels(int i)
public void setAppliedLabels(int i,
AppliedLabel _value)
public AppliedLabel[] getEffectiveAppliedLabels()
public void setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)
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 attribute is read-only.public AppliedLabel getEffectiveAppliedLabels(int i)
public void setEffectiveAppliedLabels(int i,
AppliedLabel _value)
public Boolean getDisableSameAdvertiserCompetitiveExclusion()
true will allow line items
from the same advertiser to serve regardless of the
other competitive exclusion labels being
applied.
This attribute is optional and defaults to false.
public void setDisableSameAdvertiserCompetitiveExclusion(Boolean disableSameAdvertiserCompetitiveExclusion)
disableSameAdvertiserCompetitiveExclusion - * If a line item has a series of competitive exclusions on it,
it could be blocked from serving
with line items from the same advertiser. Setting
this to true will allow line items
from the same advertiser to serve regardless of the
other competitive exclusion labels being
applied.
This attribute is optional and defaults to false.
public ProposalLineItemConstraints getProductConstraints()
ProposalLineItem.
This attribute is applicable when:public void setProductConstraints(ProposalLineItemConstraints productConstraints)
productConstraints - * All the product constraints set for this ProposalLineItem.
This attribute is applicable when:public ProposalLineItemPremium[] getPremiums()
ProposalLineItem and
their statuses.
For those triggered premiums whose statues are not
specified, the default status
is ProposalLineItemPremiumStatus.INCLUDED.
This attribute is applicable when:public void setPremiums(ProposalLineItemPremium[] premiums)
premiums - * The premiums triggered by this ProposalLineItem and
their statuses.
For those triggered premiums whose statues are not
specified, the default status
is ProposalLineItemPremiumStatus.INCLUDED.
This attribute is applicable when:public ProposalLineItemPremium getPremiums(int i)
public void setPremiums(int i,
ProposalLineItemPremium _value)
public Boolean getIsSold()
ProposalLineItem has been sold.
This attribute is read-only.public void setIsSold(Boolean isSold)
isSold - * Indicates whether this ProposalLineItem has been sold.
This attribute is read-only.public Money getBaseRate()
ProposalLineItem in proposal currency.
This attribute is applicable when:public void setBaseRate(Money baseRate)
baseRate - * The base rate of the ProposalLineItem in proposal currency.
This attribute is applicable when:public Money getCostPerUnit()
Money.microAmount must be multiples
of 100.
This attribute is required.public void setCostPerUnit(Money costPerUnit)
costPerUnit - * The amount of money to spend per impression or click in proposal
currency.
It supports precision of 4 decimal places in terms
of the fundamental currency
unit, so the Money.microAmount must be multiples
of 100.
This attribute is required.public Money getCost()
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.public void setCost(Money cost)
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.public DeliveryIndicator getDeliveryIndicator()
null if the delivery indicator
information is not available due to one
of the following reasons:
public void setDeliveryIndicator(DeliveryIndicator deliveryIndicator)
deliveryIndicator - * Indicates how well the line item generated from this proposal
line item has been performing.
This will be null if the delivery indicator
information is not available due to one
of the following reasons:
public DeliveryData getDeliveryData()
LineItem
generated from this proposal line item in the last
7 days. This will be null if the
delivery data cannot be computed due to one of the
following reasons:
deliveryIndicator should
be used to track its progress in this case.public void setDeliveryData(DeliveryData deliveryData)
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 will be null if the
delivery data cannot be computed due to one of the
following reasons:
deliveryIndicator should
be used to track its progress in this case.public ComputedStatus getComputedStatus()
LineItem generated from this proposal
line item.
This will be null if the proposal line item
has not pushed to DFP.
This attribute is read-only.public void setComputedStatus(ComputedStatus computedStatus)
computedStatus - * The status of the LineItem generated from this proposal
line item.
This will be null if the proposal line item
has not pushed to DFP.
This attribute is read-only.public BillingCap getBillingCap()
ProposalLineItem.
This attribute is optional.
If this field is overridden, then other required billing
fields
(billingSource, or billingBase)
also need to be overridden
depending on the billingSource. That is,
none of the billing fields will inherit from
their Proposal object anymore.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute
is applicable when:public void setBillingCap(BillingCap billingCap)
billingCap - * Overrides the billing cap of this ProposalLineItem.
This attribute is optional.
If this field is overridden, then other required billing
fields
(billingSource, or billingBase)
also need to be overridden
depending on the billingSource. That is,
none of the billing fields will inherit from
their Proposal object anymore.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute
is applicable when:public BillingSchedule getBillingSchedule()
ProposalLineItem.
This attribute is optional.
If this field is overridden, then other required billing
fields
(billingSource, or billingBase)
also need to be overridden
depending on the billingSource. That is,
none of the billing fields will inherit from
their Proposal object anymore.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute
is applicable when:public void setBillingSchedule(BillingSchedule billingSchedule)
billingSchedule - * Overrides the billing schedule of this ProposalLineItem.
This attribute is optional.
If this field is overridden, then other required billing
fields
(billingSource, or billingBase)
also need to be overridden
depending on the billingSource. That is,
none of the billing fields will inherit from
their Proposal object anymore.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute
is applicable when:public BillingSource getBillingSource()
ProposalLineItem.
This attribute is optional.
If this field is overridden, then other required billing
fields (billingCap,
billingSchedule, or billingBase)
also need to be overridden
depending on this field. That is, none of the billing
fields will inherit from
their Proposal object anymore.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute
is applicable when:public void setBillingSource(BillingSource billingSource)
billingSource - * Overrides the billing source of this ProposalLineItem.
This attribute is optional.
If this field is overridden, then other required billing
fields (billingCap,
billingSchedule, or billingBase)
also need to be overridden
depending on this field. That is, none of the billing
fields will inherit from
their Proposal object anymore.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute
is applicable when:public BillingBase getBillingBase()
ProposalLineItem.
This attribute is optional.
If this field is overridden, then other required billing
fields (billingCap,
billingSchedule, or billingSource)
also need to be overridden
depending on the billingSource. That is,
none of the billing fields will inherit from
their Proposal object anymore.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute
is applicable when:public void setBillingBase(BillingBase billingBase)
billingBase - * Overrides the billing base of this ProposalLineItem.
This attribute is optional.
If this field is overridden, then other required billing
fields (billingCap,
billingSchedule, or billingSource)
also need to be overridden
depending on the billingSource. That is,
none of the billing fields will inherit from
their Proposal object anymore.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.
This attribute
is applicable when:public DateTime getLastModifiedDateTime()
ProposalLineItem was last modified.
This attribute is assigned by Google when a ProposalLineItem is updated.
This attribute is read-only.public void setLastModifiedDateTime(DateTime lastModifiedDateTime)
lastModifiedDateTime - * The date and time this ProposalLineItem was last modified.
This attribute is assigned by Google when a ProposalLineItem is updated.
This attribute is read-only.public ReservationStatus getReservationStatus()
ProposalLineItem.
This attribute is read-only.public void setReservationStatus(ReservationStatus reservationStatus)
reservationStatus - * The reservation status of the ProposalLineItem.
This attribute is read-only.public Boolean getUseThirdPartyAdServerFromProposal()
thirdPartyAdServerId
and customThirdPartyAdServerName
will be ignored.
This attribute
is applicable when:public void setUseThirdPartyAdServerFromProposal(Boolean useThirdPartyAdServerFromProposal)
useThirdPartyAdServerFromProposal - * Whether to use the corresponding proposal's third party ad
server.
If this field is true, thirdPartyAdServerId
and customThirdPartyAdServerName
will be ignored.
This attribute
is applicable when:public Integer getThirdPartyAdServerId()
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.
This attribute
is applicable when:public void setThirdPartyAdServerId(Integer thirdPartyAdServerId)
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.
This attribute
is applicable when:public String getCustomThirdPartyAdServerName()
thirdPartyAdServerId
is set to 0, and actual third party ad server name
is set here.
When thirdPartyAdServerId is not 0, this field
is ignored.
This attribute
is applicable when:public void setCustomThirdPartyAdServerName(String customThirdPartyAdServerName)
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.
This attribute
is applicable when:public EnvironmentType getEnvironmentType()
ProposalLineItem is targeting.
The default value
is EnvironmentType.BROWSER. If this value
is EnvironmentType.VIDEO_PLAYER,
then this ProposalLineItem can only target
ad units that have
sizes whose AdUnitSize.environmentType
is also
EnvironmentType.VIDEO_PLAYER.
This field can only be changed if the linkStatus
is LinkStatus.UNLINKED.
Otherwise its value is read-only and set to Product.environmentType of the product
this proposal line item was created from.
public void setEnvironmentType(EnvironmentType environmentType)
environmentType - * The environment that the ProposalLineItem is targeting.
The default value
is EnvironmentType.BROWSER. If this value
is EnvironmentType.VIDEO_PLAYER,
then this ProposalLineItem can only target
ad units that have
sizes whose AdUnitSize.environmentType
is also
EnvironmentType.VIDEO_PLAYER.
This field can only be changed if the linkStatus
is LinkStatus.UNLINKED.
Otherwise its value is read-only and set to Product.environmentType of the product
this proposal line item was created from.
public LinkStatus getLinkStatus()
ProposalLineItem
and its {link Product}.
This attribute
is applicable when:public void setLinkStatus(LinkStatus linkStatus)
linkStatus - * The status of the link between this ProposalLineItem
and its {link 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 © 2016. All Rights Reserved.