public class Proposal extends Object implements Serializable
Proposal represents an agreement between an interactive
advertising seller and a buyer that specifies the details of an
advertising campaign.| Constructor and Description |
|---|
Proposal() |
Proposal(Long id,
Boolean isProgrammatic,
Long dfpOrderId,
String name,
PricingModel pricingModel,
DateTime startDateTime,
DateTime endDateTime,
String timeZoneId,
ProposalStatus status,
Boolean isArchived,
ProposalCompanyAssociation advertiser,
ProposalCompanyAssociation[] agencies,
Long probabilityOfClose,
BillingCap billingCap,
BillingSchedule billingSchedule,
BillingSource billingSource,
BillingBase billingBase,
String poNumber,
String internalNotes,
Money budget,
SalespersonSplit primarySalesperson,
SalespersonSplit[] secondarySalespeople,
long[] salesPlannerIds,
Long primaryTraffickerId,
long[] secondaryTraffickerIds,
long[] sellerContactIds,
long[] appliedTeamIds,
BaseCustomFieldValue[] customFieldValues,
AppliedLabel[] appliedLabels,
AppliedLabel[] effectiveAppliedLabels,
Long advertiserDiscount,
Long proposalDiscount,
String currencyCode,
Long exchangeRate,
Boolean refreshExchangeRate,
Long agencyCommission,
Long valueAddedTax,
Boolean isSold,
ProposalApprovalStatus approvalStatus,
WorkflowProgress workflowProgress,
DateTime lastModifiedDateTime,
ProposalLink[] resources,
DateTime actualExpiryTime,
DateTime expectedExpiryTime,
Integer thirdPartyAdServerId,
String customThirdPartyAdServerName,
ProposalTermsAndConditions[] termsAndConditions,
RetractionDetails lastRetractionDetails,
ProposalMarketplaceInfo marketplaceInfo,
OfflineError[] offlineErrors,
Boolean hasOfflineErrors,
BuyerRfp buyerRfp,
Boolean hasBuyerRfp) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
DateTime |
getActualExpiryTime()
Gets the actualExpiryTime value for this Proposal.
|
ProposalCompanyAssociation |
getAdvertiser()
Gets the advertiser value for this Proposal.
|
Long |
getAdvertiserDiscount()
Gets the advertiserDiscount value for this Proposal.
|
ProposalCompanyAssociation[] |
getAgencies()
Gets the agencies value for this Proposal.
|
ProposalCompanyAssociation |
getAgencies(int i) |
Long |
getAgencyCommission()
Gets the agencyCommission value for this Proposal.
|
AppliedLabel[] |
getAppliedLabels()
Gets the appliedLabels value for this Proposal.
|
AppliedLabel |
getAppliedLabels(int i) |
long[] |
getAppliedTeamIds()
Gets the appliedTeamIds value for this Proposal.
|
long |
getAppliedTeamIds(int i) |
ProposalApprovalStatus |
getApprovalStatus()
Gets the approvalStatus value for this Proposal.
|
BillingBase |
getBillingBase()
Gets the billingBase value for this Proposal.
|
BillingCap |
getBillingCap()
Gets the billingCap value for this Proposal.
|
BillingSchedule |
getBillingSchedule()
Gets the billingSchedule value for this Proposal.
|
BillingSource |
getBillingSource()
Gets the billingSource value for this Proposal.
|
Money |
getBudget()
Gets the budget value for this Proposal.
|
BuyerRfp |
getBuyerRfp()
Gets the buyerRfp value for this Proposal.
|
String |
getCurrencyCode()
Gets the currencyCode value for this Proposal.
|
BaseCustomFieldValue[] |
getCustomFieldValues()
Gets the customFieldValues value for this Proposal.
|
BaseCustomFieldValue |
getCustomFieldValues(int i) |
String |
getCustomThirdPartyAdServerName()
Gets the customThirdPartyAdServerName value for this Proposal.
|
static org.apache.axis.encoding.Deserializer |
getDeserializer(String mechType,
Class _javaType,
QName _xmlType)
Get Custom Deserializer
|
Long |
getDfpOrderId()
Gets the dfpOrderId value for this Proposal.
|
AppliedLabel[] |
getEffectiveAppliedLabels()
Gets the effectiveAppliedLabels value for this Proposal.
|
AppliedLabel |
getEffectiveAppliedLabels(int i) |
DateTime |
getEndDateTime()
Gets the endDateTime value for this Proposal.
|
Long |
getExchangeRate()
Gets the exchangeRate value for this Proposal.
|
DateTime |
getExpectedExpiryTime()
Gets the expectedExpiryTime value for this Proposal.
|
Boolean |
getHasBuyerRfp()
Gets the hasBuyerRfp value for this Proposal.
|
Boolean |
getHasOfflineErrors()
Gets the hasOfflineErrors value for this Proposal.
|
Long |
getId()
Gets the id value for this Proposal.
|
String |
getInternalNotes()
Gets the internalNotes value for this Proposal.
|
Boolean |
getIsArchived()
Gets the isArchived value for this Proposal.
|
Boolean |
getIsProgrammatic()
Gets the isProgrammatic value for this Proposal.
|
Boolean |
getIsSold()
Gets the isSold value for this Proposal.
|
DateTime |
getLastModifiedDateTime()
Gets the lastModifiedDateTime value for this Proposal.
|
RetractionDetails |
getLastRetractionDetails()
Gets the lastRetractionDetails value for this Proposal.
|
ProposalMarketplaceInfo |
getMarketplaceInfo()
Gets the marketplaceInfo value for this Proposal.
|
String |
getName()
Gets the name value for this Proposal.
|
OfflineError[] |
getOfflineErrors()
Gets the offlineErrors value for this Proposal.
|
OfflineError |
getOfflineErrors(int i) |
String |
getPoNumber()
Gets the poNumber value for this Proposal.
|
PricingModel |
getPricingModel()
Gets the pricingModel value for this Proposal.
|
SalespersonSplit |
getPrimarySalesperson()
Gets the primarySalesperson value for this Proposal.
|
Long |
getPrimaryTraffickerId()
Gets the primaryTraffickerId value for this Proposal.
|
Long |
getProbabilityOfClose()
Gets the probabilityOfClose value for this Proposal.
|
Long |
getProposalDiscount()
Gets the proposalDiscount value for this Proposal.
|
Boolean |
getRefreshExchangeRate()
Gets the refreshExchangeRate value for this Proposal.
|
ProposalLink[] |
getResources()
Gets the resources value for this Proposal.
|
ProposalLink |
getResources(int i) |
long[] |
getSalesPlannerIds()
Gets the salesPlannerIds value for this Proposal.
|
long |
getSalesPlannerIds(int i) |
SalespersonSplit[] |
getSecondarySalespeople()
Gets the secondarySalespeople value for this Proposal.
|
SalespersonSplit |
getSecondarySalespeople(int i) |
long[] |
getSecondaryTraffickerIds()
Gets the secondaryTraffickerIds value for this Proposal.
|
long |
getSecondaryTraffickerIds(int i) |
long[] |
getSellerContactIds()
Gets the sellerContactIds value for this Proposal.
|
long |
getSellerContactIds(int i) |
static org.apache.axis.encoding.Serializer |
getSerializer(String mechType,
Class _javaType,
QName _xmlType)
Get Custom Serializer
|
DateTime |
getStartDateTime()
Gets the startDateTime value for this Proposal.
|
ProposalStatus |
getStatus()
Gets the status value for this Proposal.
|
ProposalTermsAndConditions[] |
getTermsAndConditions()
Gets the termsAndConditions value for this Proposal.
|
ProposalTermsAndConditions |
getTermsAndConditions(int i) |
Integer |
getThirdPartyAdServerId()
Gets the thirdPartyAdServerId value for this Proposal.
|
String |
getTimeZoneId()
Gets the timeZoneId value for this Proposal.
|
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Return type metadata object
|
Long |
getValueAddedTax()
Gets the valueAddedTax value for this Proposal.
|
WorkflowProgress |
getWorkflowProgress()
Gets the workflowProgress value for this Proposal.
|
int |
hashCode() |
void |
setActualExpiryTime(DateTime actualExpiryTime)
Sets the actualExpiryTime value for this Proposal.
|
void |
setAdvertiser(ProposalCompanyAssociation advertiser)
Sets the advertiser value for this Proposal.
|
void |
setAdvertiserDiscount(Long advertiserDiscount)
Sets the advertiserDiscount value for this Proposal.
|
void |
setAgencies(int i,
ProposalCompanyAssociation _value) |
void |
setAgencies(ProposalCompanyAssociation[] agencies)
Sets the agencies value for this Proposal.
|
void |
setAgencyCommission(Long agencyCommission)
Sets the agencyCommission value for this Proposal.
|
void |
setAppliedLabels(AppliedLabel[] appliedLabels)
Sets the appliedLabels value for this Proposal.
|
void |
setAppliedLabels(int i,
AppliedLabel _value) |
void |
setAppliedTeamIds(int i,
long _value) |
void |
setAppliedTeamIds(long[] appliedTeamIds)
Sets the appliedTeamIds value for this Proposal.
|
void |
setApprovalStatus(ProposalApprovalStatus approvalStatus)
Sets the approvalStatus value for this Proposal.
|
void |
setBillingBase(BillingBase billingBase)
Sets the billingBase value for this Proposal.
|
void |
setBillingCap(BillingCap billingCap)
Sets the billingCap value for this Proposal.
|
void |
setBillingSchedule(BillingSchedule billingSchedule)
Sets the billingSchedule value for this Proposal.
|
void |
setBillingSource(BillingSource billingSource)
Sets the billingSource value for this Proposal.
|
void |
setBudget(Money budget)
Sets the budget value for this Proposal.
|
void |
setBuyerRfp(BuyerRfp buyerRfp)
Sets the buyerRfp value for this Proposal.
|
void |
setCurrencyCode(String currencyCode)
Sets the currencyCode value for this Proposal.
|
void |
setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)
Sets the customFieldValues value for this Proposal.
|
void |
setCustomFieldValues(int i,
BaseCustomFieldValue _value) |
void |
setCustomThirdPartyAdServerName(String customThirdPartyAdServerName)
Sets the customThirdPartyAdServerName value for this Proposal.
|
void |
setDfpOrderId(Long dfpOrderId)
Sets the dfpOrderId value for this Proposal.
|
void |
setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)
Sets the effectiveAppliedLabels value for this Proposal.
|
void |
setEffectiveAppliedLabels(int i,
AppliedLabel _value) |
void |
setEndDateTime(DateTime endDateTime)
Sets the endDateTime value for this Proposal.
|
void |
setExchangeRate(Long exchangeRate)
Sets the exchangeRate value for this Proposal.
|
void |
setExpectedExpiryTime(DateTime expectedExpiryTime)
Sets the expectedExpiryTime value for this Proposal.
|
void |
setHasBuyerRfp(Boolean hasBuyerRfp)
Sets the hasBuyerRfp value for this Proposal.
|
void |
setHasOfflineErrors(Boolean hasOfflineErrors)
Sets the hasOfflineErrors value for this Proposal.
|
void |
setId(Long id)
Sets the id value for this Proposal.
|
void |
setInternalNotes(String internalNotes)
Sets the internalNotes value for this Proposal.
|
void |
setIsArchived(Boolean isArchived)
Sets the isArchived value for this Proposal.
|
void |
setIsProgrammatic(Boolean isProgrammatic)
Sets the isProgrammatic value for this Proposal.
|
void |
setIsSold(Boolean isSold)
Sets the isSold value for this Proposal.
|
void |
setLastModifiedDateTime(DateTime lastModifiedDateTime)
Sets the lastModifiedDateTime value for this Proposal.
|
void |
setLastRetractionDetails(RetractionDetails lastRetractionDetails)
Sets the lastRetractionDetails value for this Proposal.
|
void |
setMarketplaceInfo(ProposalMarketplaceInfo marketplaceInfo)
Sets the marketplaceInfo value for this Proposal.
|
void |
setName(String name)
Sets the name value for this Proposal.
|
void |
setOfflineErrors(int i,
OfflineError _value) |
void |
setOfflineErrors(OfflineError[] offlineErrors)
Sets the offlineErrors value for this Proposal.
|
void |
setPoNumber(String poNumber)
Sets the poNumber value for this Proposal.
|
void |
setPricingModel(PricingModel pricingModel)
Sets the pricingModel value for this Proposal.
|
void |
setPrimarySalesperson(SalespersonSplit primarySalesperson)
Sets the primarySalesperson value for this Proposal.
|
void |
setPrimaryTraffickerId(Long primaryTraffickerId)
Sets the primaryTraffickerId value for this Proposal.
|
void |
setProbabilityOfClose(Long probabilityOfClose)
Sets the probabilityOfClose value for this Proposal.
|
void |
setProposalDiscount(Long proposalDiscount)
Sets the proposalDiscount value for this Proposal.
|
void |
setRefreshExchangeRate(Boolean refreshExchangeRate)
Sets the refreshExchangeRate value for this Proposal.
|
void |
setResources(int i,
ProposalLink _value) |
void |
setResources(ProposalLink[] resources)
Sets the resources value for this Proposal.
|
void |
setSalesPlannerIds(int i,
long _value) |
void |
setSalesPlannerIds(long[] salesPlannerIds)
Sets the salesPlannerIds value for this Proposal.
|
void |
setSecondarySalespeople(int i,
SalespersonSplit _value) |
void |
setSecondarySalespeople(SalespersonSplit[] secondarySalespeople)
Sets the secondarySalespeople value for this Proposal.
|
void |
setSecondaryTraffickerIds(int i,
long _value) |
void |
setSecondaryTraffickerIds(long[] secondaryTraffickerIds)
Sets the secondaryTraffickerIds value for this Proposal.
|
void |
setSellerContactIds(int i,
long _value) |
void |
setSellerContactIds(long[] sellerContactIds)
Sets the sellerContactIds value for this Proposal.
|
void |
setStartDateTime(DateTime startDateTime)
Sets the startDateTime value for this Proposal.
|
void |
setStatus(ProposalStatus status)
Sets the status value for this Proposal.
|
void |
setTermsAndConditions(int i,
ProposalTermsAndConditions _value) |
void |
setTermsAndConditions(ProposalTermsAndConditions[] termsAndConditions)
Sets the termsAndConditions value for this Proposal.
|
void |
setThirdPartyAdServerId(Integer thirdPartyAdServerId)
Sets the thirdPartyAdServerId value for this Proposal.
|
void |
setTimeZoneId(String timeZoneId)
Sets the timeZoneId value for this Proposal.
|
void |
setValueAddedTax(Long valueAddedTax)
Sets the valueAddedTax value for this Proposal.
|
void |
setWorkflowProgress(WorkflowProgress workflowProgress)
Sets the workflowProgress value for this Proposal.
|
String |
toString() |
public Proposal()
public Proposal(Long id, Boolean isProgrammatic, Long dfpOrderId, String name, PricingModel pricingModel, DateTime startDateTime, DateTime endDateTime, String timeZoneId, ProposalStatus status, Boolean isArchived, ProposalCompanyAssociation advertiser, ProposalCompanyAssociation[] agencies, Long probabilityOfClose, BillingCap billingCap, BillingSchedule billingSchedule, BillingSource billingSource, BillingBase billingBase, String poNumber, String internalNotes, Money budget, SalespersonSplit primarySalesperson, SalespersonSplit[] secondarySalespeople, long[] salesPlannerIds, Long primaryTraffickerId, long[] secondaryTraffickerIds, long[] sellerContactIds, long[] appliedTeamIds, BaseCustomFieldValue[] customFieldValues, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, Long advertiserDiscount, Long proposalDiscount, String currencyCode, Long exchangeRate, Boolean refreshExchangeRate, Long agencyCommission, Long valueAddedTax, Boolean isSold, ProposalApprovalStatus approvalStatus, WorkflowProgress workflowProgress, DateTime lastModifiedDateTime, ProposalLink[] resources, DateTime actualExpiryTime, DateTime expectedExpiryTime, Integer thirdPartyAdServerId, String customThirdPartyAdServerName, ProposalTermsAndConditions[] termsAndConditions, RetractionDetails lastRetractionDetails, ProposalMarketplaceInfo marketplaceInfo, OfflineError[] offlineErrors, Boolean hasOfflineErrors, BuyerRfp buyerRfp, Boolean hasBuyerRfp)
public Long getId()
Proposal.
This attribute is read-only.public void setId(Long id)
id - * The unique ID of the Proposal.
This attribute is read-only.public Boolean getIsProgrammatic()
Proposal is for programmatic
deals.
This value is default to false.public void setIsProgrammatic(Boolean isProgrammatic)
isProgrammatic - * Flag that specifies whether this Proposal is for programmatic
deals.
This value is default to false.public Long getDfpOrderId()
Order.
This will be null if the Proposal
has not been pushed to Ad Manager.
This attribute is read-only.public void setDfpOrderId(Long dfpOrderId)
dfpOrderId - * The unique ID of corresponding Order.
This will be null if the Proposal
has not been pushed to Ad Manager.
This attribute is read-only.public String getName()
Proposal. This value has a maximum
length of 255 characters. This value
is copied to Order.name when the proposal
turns into an order.
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 Proposal. This value has a maximum
length of 255 characters. This value
is copied to Order.name when the proposal
turns into an order.
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 PricingModel getPricingModel()
Proposal uses the
Net or Gross pricing model.
This field is optional and defaults to PricingModel.NET.
This attribute is applicable when:public void setPricingModel(PricingModel pricingModel)
pricingModel - * The option to specify whether the Proposal uses the
Net or Gross pricing model.
This field is optional and defaults to PricingModel.NET.
This attribute is applicable when:public DateTime getStartDateTime()
Proposal are eligible to begin serving.
This attribute
is derived from the proposal line item of the proposal
which has the earliest
ProposalLineItem.startDateTime. This attribute
will be null,
if this proposal has no related line items, or none
of its line items have a start time.
This attribute is read-only.public void setStartDateTime(DateTime startDateTime)
startDateTime - * The date and time at which the order and line items associated
with
the Proposal are eligible to begin serving.
This attribute
is derived from the proposal line item of the proposal
which has the earliest
ProposalLineItem.startDateTime. This attribute
will be null,
if this proposal has no related line items, or none
of its line items have a start time.
This attribute is read-only.public DateTime getEndDateTime()
Proposal stop being served. This attribute
is derived from the proposal line item of the proposal which has the
latest ProposalLineItem.endDateTime. This attribute will be
null,
if this proposal has no related line items, or none
of its line items have an end time.
This attribute is read-only.public void setEndDateTime(DateTime endDateTime)
endDateTime - * The date and time at which the order and line items associated
with
the Proposal stop being served. This attribute
is derived from the proposal line item of the proposal which has the
latest ProposalLineItem.endDateTime. This attribute will be
null,
if this proposal has no related line items, or none
of its line items have an end time.
This attribute is read-only.public String getTimeZoneId()
Proposal. 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 applicable when:public void setTimeZoneId(String timeZoneId)
timeZoneId - * The time zone ID in tz database format (e.g. "America/Los_Angeles")
for this
Proposal. 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 applicable when:public ProposalStatus getStatus()
Proposal.
This attribute is read-only.public void setStatus(ProposalStatus status)
status - * The status of the Proposal.
This attribute is read-only.public Boolean getIsArchived()
Proposal.
This attribute is read-only.public void setIsArchived(Boolean isArchived)
isArchived - * The archival status of the Proposal.
This attribute is read-only.public ProposalCompanyAssociation getAdvertiser()
Proposal belongs, and
a set of
Contact objects associated with the advertiser.
The
ProposalCompanyAssociation.type of this attribute
should be
ProposalCompanyAssociationType.ADVERTISER.
This attribute is
required when the proposal turns into an order, and
its
ProposalCompanyAssociation.companyId will
be copied to
Order.advertiserId.
This attribute becomes readonly once the Proposal
has been pushed.public void setAdvertiser(ProposalCompanyAssociation advertiser)
advertiser - * The advertiser, to which this Proposal belongs, and
a set of
Contact objects associated with the advertiser.
The
ProposalCompanyAssociation.type of this attribute
should be
ProposalCompanyAssociationType.ADVERTISER.
This attribute is
required when the proposal turns into an order, and
its
ProposalCompanyAssociation.companyId will
be copied to
Order.advertiserId.
This attribute becomes readonly once the Proposal
has been pushed.public ProposalCompanyAssociation[] getAgencies()
Contact objects associated
with each agency.
This attribute is optional. A Proposal only
has at most one
Company with ProposalCompanyAssociationType.PRIMARY_AGENCY
type,
but a Company can appear more than once with
different
ProposalCompanyAssociationType values. If
primary
agency exists, its ProposalCompanyAssociation.companyId
will be copied to
Order.agencyId when the proposal turns into
an order.public void setAgencies(ProposalCompanyAssociation[] agencies)
agencies - * List of agencies and the set of Contact objects associated
with each agency.
This attribute is optional. A Proposal only
has at most one
Company with ProposalCompanyAssociationType.PRIMARY_AGENCY
type,
but a Company can appear more than once with
different
ProposalCompanyAssociationType values. If
primary
agency exists, its ProposalCompanyAssociation.companyId
will be copied to
Order.agencyId when the proposal turns into
an order.public ProposalCompanyAssociation getAgencies(int i)
public void setAgencies(int i,
ProposalCompanyAssociation _value)
public Long getProbabilityOfClose()
Proposal. This percentage
value is in
terms of millipercent, and should be multiples of
10 with the range from 0 to
100000. This attribute will be used to calculate the
revenue in reporting.
This attribute
is applicable when:public void setProbabilityOfClose(Long probabilityOfClose)
probabilityOfClose - * The probability to close this Proposal. This percentage
value is in
terms of millipercent, and should be multiples of
10 with the range from 0 to
100000. This attribute will be used to calculate the
revenue in reporting.
This attribute
is applicable when:public BillingCap getBillingCap()
Proposal. This attribute is
optional and
default value is BillingCap.CAPPED_CUMULATIVE.
Either this attribute
or billingSchedule will be used, according
to the billingSource.
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 - * The billing cap of this Proposal. This attribute is
optional and
default value is BillingCap.CAPPED_CUMULATIVE.
Either this attribute
or billingSchedule will be used, according
to the billingSource.
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()
Proposal. This attribute
is optional and
default value is BillingSchedule.PRORATED.
Either this attribute
or billingCap will be used, according to
the billingSource.
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 - * The billing schedule of this Proposal. This attribute
is optional and
default value is BillingSchedule.PRORATED.
Either this attribute
or billingCap will be used, according to
the billingSource.
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()
Proposal. This attribute
is optional and
default value is BillingSource.THIRD_PARTY_VOLUME.
If the value is
BillingSource.CONTRACTED, the billingSchedule
will be used for
billing, otherwise the billingCap will be
used.
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 - * The billing source of this Proposal. This attribute
is optional and
default value is BillingSource.THIRD_PARTY_VOLUME.
If the value is
BillingSource.CONTRACTED, the billingSchedule
will be used for
billing, otherwise the billingCap will be
used.
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()
Proposal. For example, for
a flat fee
contracted billingSource, set this to
BillingBase.REVENUE. This attribute is optional
and defaults to
BillingBase.VOLUME.
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 - * The billing base of this Proposal. For example, for
a flat fee
contracted billingSource, set this to
BillingBase.REVENUE. This attribute is optional
and defaults to
BillingBase.VOLUME.
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 String getPoNumber()
Proposal.
This attribute is
optional and has a maximum length of 63 characters.
It is copied to
Order.poNumber when the proposal turns into
an order.
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 setPoNumber(String poNumber)
poNumber - * User defined purchase order number for the Proposal.
This attribute is
optional and has a maximum length of 63 characters.
It is copied to
Order.poNumber when the proposal turns into
an order.
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 String getInternalNotes()
Proposal. 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 setInternalNotes(String internalNotes)
internalNotes - * Provides any additional notes that may annotate the Proposal. 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 Money getBudget()
Proposal. 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 optional and
default value is 0.
The Money.currencyCode is readonly.
This attribute
is applicable when:public void setBudget(Money budget)
budget - * The total budget allocated for all the proposal line items
belonging to the
Proposal. 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 optional and
default value is 0.
The Money.currencyCode is readonly.
This attribute
is applicable when:public SalespersonSplit getPrimarySalesperson()
advertiser.
This attribute is required when the proposal turns
into an order.
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 setPrimarySalesperson(SalespersonSplit primarySalesperson)
primarySalesperson - * The primary salesperson who brokered the transaction with the
advertiser.
This attribute is required when the proposal turns
into an order.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.public SalespersonSplit[] getSecondarySalespeople()
Proposal besides primary salesperson.
This attribute is optional. A proposal could have
8 secondary salespeople at most,
but must also have a primarySalesperson if
any secondary salesperson exists.
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 setSecondarySalespeople(SalespersonSplit[] secondarySalespeople)
secondarySalespeople - * List of secondary salespeople who are responsible for the sales
of
the Proposal besides primary salesperson.
This attribute is optional. A proposal could have
8 secondary salespeople at most,
but must also have a primarySalesperson if
any secondary salesperson exists.
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 SalespersonSplit getSecondarySalespeople(int i)
public void setSecondarySalespeople(int i,
SalespersonSplit _value)
public long[] getSalesPlannerIds()
User objects who are the sales
planners of
the Proposal. This attribute is optional.
A proposal could have
8 sales planners at most.
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 setSalesPlannerIds(long[] salesPlannerIds)
salesPlannerIds - * List of unique IDs of User objects who are the sales
planners of
the Proposal. This attribute is optional.
A proposal could have
8 sales planners at most.
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.public long getSalesPlannerIds(int i)
public void setSalesPlannerIds(int i,
long _value)
public Long getPrimaryTraffickerId()
User who is primary trafficker
and is responsible for
trafficking the Proposal. This attribute is
required when the proposal
turns into an order, and will be copied to Order#primaryTraffickerId .
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 setPrimaryTraffickerId(Long primaryTraffickerId)
primaryTraffickerId - * The unique ID of the User who is primary trafficker
and is responsible for
trafficking the Proposal. This attribute is
required when the proposal
turns into an order, and will be copied to Order#primaryTraffickerId .
This attribute can be configured as editable after
the proposal has been submitted.
Please check with your network administrator for editable
fields configuration.public long[] getSecondaryTraffickerIds()
User objects who are responsible
for trafficking
the Proposal besides the primary trafficker.
This attribute is optional.
A proposal could have 8 secondary traffickers at most,
but must also have a primary
trafficker if any secondary trafficker exists.
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 setSecondaryTraffickerIds(long[] secondaryTraffickerIds)
secondaryTraffickerIds - * List of unique IDs of User objects who are responsible
for trafficking
the Proposal besides the primary trafficker.
This attribute is optional.
A proposal could have 8 secondary traffickers at most,
but must also have a primary
trafficker if any secondary trafficker exists.
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 long getSecondaryTraffickerIds(int i)
public void setSecondaryTraffickerIds(int i,
long _value)
public long[] getSellerContactIds()
users who are the seller's contacts.
This attribute
is applicable when:public void setSellerContactIds(long[] sellerContactIds)
sellerContactIds - * users who are the seller's contacts.
This attribute
is applicable when:public long getSellerContactIds(int i)
public void setSellerContactIds(int i,
long _value)
public long[] getAppliedTeamIds()
Proposal is on directly.
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 setAppliedTeamIds(long[] appliedTeamIds)
appliedTeamIds - * The IDs of all teams that the Proposal is on directly.
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 long getAppliedTeamIds(int i)
public void setAppliedTeamIds(int i,
long _value)
public BaseCustomFieldValue[] getCustomFieldValues()
Proposal.
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 Proposal.
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()
Proposal.
This attribute is optional.public void setAppliedLabels(AppliedLabel[] appliedLabels)
appliedLabels - * The set of labels applied directly to the Proposal.
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 Long getAdvertiserDiscount()
Proposal according to the
advertiser.
The percentage value is stored as millipercents, and
must be multiples of 10
with the range from 0 to 99990. This attribute is
optional and default value is 0.
This attribute
is applicable when:public void setAdvertiserDiscount(Long advertiserDiscount)
advertiserDiscount - * The discount applied to the Proposal according to the
advertiser.
The percentage value is stored as millipercents, and
must be multiples of 10
with the range from 0 to 99990. This attribute is
optional and default value is 0.
This attribute
is applicable when:public Long getProposalDiscount()
ProposalLineItem objects in the Proposal.
The percentage value is stored as millipercents, and must be multiples
of 10
with the range from 0 to 99990. This attribute is
optional and default value is 0.
This attribute
is applicable when:public void setProposalDiscount(Long proposalDiscount)
proposalDiscount - * The proposal discount, which will be applied to all
ProposalLineItem objects in the Proposal.
The percentage value is stored as millipercents, and must be multiples
of 10
with the range from 0 to 99990. This attribute is
optional and default value is 0.
This attribute
is applicable when:public String getCurrencyCode()
Proposal. This attribute
is optional and defaults to
network's currency code.public void setCurrencyCode(String currencyCode)
currencyCode - * The currency code of this Proposal. This attribute
is optional and defaults to
network's currency code.public Long getExchangeRate()
currencyCode to the
network's currency. The
value is stored as the exchange rate times
10,000,000,000 truncated to a long. This attribute
is assigned by Google when
first created or updated with refreshExchangeRate
set to true. This attribute
is ignored if the feature is not enabled.
This attribute is read-only.public void setExchangeRate(Long exchangeRate)
exchangeRate - * The exchange rate from the currencyCode to the
network's currency. The
value is stored as the exchange rate times
10,000,000,000 truncated to a long. This attribute
is assigned by Google when
first created or updated with refreshExchangeRate
set to true. This attribute
is ignored if the feature is not enabled.
This attribute is read-only.public Boolean getRefreshExchangeRate()
true to update the exchangeRate
to the latest exchange rate
when updating the proposal. This attribute is optional
and defaults to false. This
attribute is ignored if the feature is not enabled.public void setRefreshExchangeRate(Boolean refreshExchangeRate)
refreshExchangeRate - * Set this field to true to update the exchangeRate
to the latest exchange rate
when updating the proposal. This attribute is optional
and defaults to false. This
attribute is ignored if the feature is not enabled.public Long getAgencyCommission()
Proposal.
The percentage value is stored as millipercents, and must be multiples
of 10
with the range from 0 to 99990. This attribute is
optional and default value is 0.
This attribute
is applicable when:public void setAgencyCommission(Long agencyCommission)
agencyCommission - * The commission for the primary agency of the Proposal.
The percentage value is stored as millipercents, and must be multiples
of 10
with the range from 0 to 99990. This attribute is
optional and default value is 0.
This attribute
is applicable when:public Long getValueAddedTax()
Proposal.
The percentage value is stored as millipercents, and
must be multiples of 10
with the range from 0 to 100000. This attribute is
optional and default value is 0.
This attribute
is applicable when:public void setValueAddedTax(Long valueAddedTax)
valueAddedTax - * The value added tax (VAT) applied on final cost of the Proposal.
The percentage value is stored as millipercents, and
must be multiples of 10
with the range from 0 to 100000. This attribute is
optional and default value is 0.
This attribute
is applicable when:public Boolean getIsSold()
Order is OrderStatus.APPROVED or OrderStatus.PAUSED.
This attribute is read-only.public void setIsSold(Boolean isSold)
isSold - * Indicates whether the proposal has been sold, i.e., corresponds
to whether the status of an
Order is OrderStatus.APPROVED or OrderStatus.PAUSED.
This attribute is read-only.public ProposalApprovalStatus getApprovalStatus()
Proposal for the active
user or null if the active
user has no action needed.
This attribute
is applicable when:public void setApprovalStatus(ProposalApprovalStatus approvalStatus)
approvalStatus - * The approval status of the Proposal for the active
user or null if the active
user has no action needed.
This attribute
is applicable when:public WorkflowProgress getWorkflowProgress()
Proposal.
This attribute
is applicable when:public void setWorkflowProgress(WorkflowProgress workflowProgress)
workflowProgress - * The progress report for the workflow applied on the Proposal.
This attribute
is applicable when:public DateTime getLastModifiedDateTime()
Proposal was last modified.
This attribute is read-only.public void setLastModifiedDateTime(DateTime lastModifiedDateTime)
lastModifiedDateTime - * The date and time this Proposal was last modified.
This attribute is read-only.public ProposalLink[] getResources()
Proposal. 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.
This attribute
is applicable when:public void setResources(ProposalLink[] resources)
resources - * The list of resources on this Proposal. 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.
This attribute
is applicable when:public ProposalLink getResources(int i)
public void setResources(int i,
ProposalLink _value)
public DateTime getActualExpiryTime()
Proposal will expire.
This attribute
is applicable when:public void setActualExpiryTime(DateTime actualExpiryTime)
actualExpiryTime - * The actual date and time at which the inventory reserved by
the Proposal will expire.
This attribute
is applicable when:public DateTime getExpectedExpiryTime()
Proposal will expire.
This attribute
is applicable when:public void setExpectedExpiryTime(DateTime expectedExpiryTime)
expectedExpiryTime - * The expected date and time at which the inventory reserved
by the Proposal will expire.
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.
Third party ad server is optional. By default, this
field is 0, and customThirdPartyAdServerName is null which means
no third party ad server is specified.
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.
Third party ad server is optional. By default, this
field is 0, and customThirdPartyAdServerName is null which means
no third party ad server is specified.
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 ProposalTermsAndConditions[] getTermsAndConditions()
Proposal. This
field is optional.
This attribute
is applicable when:public void setTermsAndConditions(ProposalTermsAndConditions[] termsAndConditions)
termsAndConditions - * A list of terms and conditions for this Proposal. This
field is optional.
This attribute
is applicable when:public ProposalTermsAndConditions getTermsAndConditions(int i)
public void setTermsAndConditions(int i,
ProposalTermsAndConditions _value)
public RetractionDetails getLastRetractionDetails()
public void setLastRetractionDetails(RetractionDetails lastRetractionDetails)
lastRetractionDetails - * Details describing the most recent proposal retraction.
This attribute
is applicable when:public ProposalMarketplaceInfo getMarketplaceInfo()
public void setMarketplaceInfo(ProposalMarketplaceInfo marketplaceInfo)
marketplaceInfo - * The marketplace info of this proposal if it has a corresponding
order in Marketplace.
This attribute
is applicable when:public OfflineError[] getOfflineErrors()
public void setOfflineErrors(OfflineError[] offlineErrors)
offlineErrors - * Errors that occurred during offline processes. If any errors
occur during an offline process,
such as reserving inventory, this field will be populated
with those errors, otherwise this
field will be null.
This attribute is read-only.public OfflineError getOfflineErrors(int i)
public void setOfflineErrors(int i,
OfflineError _value)
public Boolean getHasOfflineErrors()
public void setHasOfflineErrors(Boolean hasOfflineErrors)
hasOfflineErrors - * Whether errors occured during offline processes.
This attribute is read-only.public BuyerRfp getBuyerRfp()
Proposal, which
is optional. This field will be null
if the proposal is not initiated from RFP.
This attribute
is applicable when:public void setBuyerRfp(BuyerRfp buyerRfp)
buyerRfp - * The buyer RFP associated with this Proposal, which
is optional. This field will be null
if the proposal is not initiated from RFP.
This attribute
is applicable when:public Boolean getHasBuyerRfp()
Proposal contains a BuyerRfp field.
If this field is true, it
indicates that the Proposal in question orignated
from a buyer.
This attribute
is applicable when:public void setHasBuyerRfp(Boolean hasBuyerRfp)
hasBuyerRfp - * Whether a Proposal contains a BuyerRfp field.
If this field is true, it
indicates that the Proposal in question orignated
from a buyer.
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 © 2020. All rights reserved.