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,
DateTime startDateTime,
DateTime endDateTime,
ProposalStatus status,
Boolean isArchived,
ProposalCompanyAssociation advertiser,
ProposalCompanyAssociation[] agencies,
String internalNotes,
SalespersonSplit primarySalesperson,
long[] salesPlannerIds,
Long primaryTraffickerId,
long[] sellerContactIds,
long[] appliedTeamIds,
BaseCustomFieldValue[] customFieldValues,
AppliedLabel[] appliedLabels,
AppliedLabel[] effectiveAppliedLabels,
String currencyCode,
Long exchangeRate,
Boolean refreshExchangeRate,
Boolean isSold,
DateTime lastModifiedDateTime,
ProposalMarketplaceInfo marketplaceInfo,
BuyerRfp buyerRfp,
Boolean hasBuyerRfp) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
ProposalCompanyAssociation |
getAdvertiser()
Gets the advertiser value for this Proposal.
|
ProposalCompanyAssociation[] |
getAgencies()
Gets the agencies value for this Proposal.
|
ProposalCompanyAssociation |
getAgencies(int i) |
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) |
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) |
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.
|
Boolean |
getHasBuyerRfp()
Gets the hasBuyerRfp 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.
|
ProposalMarketplaceInfo |
getMarketplaceInfo()
Gets the marketplaceInfo value for this Proposal.
|
String |
getName()
Gets the name value for this Proposal.
|
SalespersonSplit |
getPrimarySalesperson()
Gets the primarySalesperson value for this Proposal.
|
Long |
getPrimaryTraffickerId()
Gets the primaryTraffickerId value for this Proposal.
|
Boolean |
getRefreshExchangeRate()
Gets the refreshExchangeRate value for this Proposal.
|
long[] |
getSalesPlannerIds()
Gets the salesPlannerIds value for this Proposal.
|
long |
getSalesPlannerIds(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.
|
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Return type metadata object
|
int |
hashCode() |
void |
setAdvertiser(ProposalCompanyAssociation advertiser)
Sets the advertiser value for this Proposal.
|
void |
setAgencies(int i,
ProposalCompanyAssociation _value) |
void |
setAgencies(ProposalCompanyAssociation[] agencies)
Sets the agencies 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 |
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 |
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 |
setHasBuyerRfp(Boolean hasBuyerRfp)
Sets the hasBuyerRfp 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 |
setMarketplaceInfo(ProposalMarketplaceInfo marketplaceInfo)
Sets the marketplaceInfo value for this Proposal.
|
void |
setName(String name)
Sets the name 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 |
setRefreshExchangeRate(Boolean refreshExchangeRate)
Sets the refreshExchangeRate value for this Proposal.
|
void |
setSalesPlannerIds(int i,
long _value) |
void |
setSalesPlannerIds(long[] salesPlannerIds)
Sets the salesPlannerIds 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.
|
String |
toString() |
public Proposal()
public Proposal(Long id, Boolean isProgrammatic, Long dfpOrderId, String name, DateTime startDateTime, DateTime endDateTime, ProposalStatus status, Boolean isArchived, ProposalCompanyAssociation advertiser, ProposalCompanyAssociation[] agencies, String internalNotes, SalespersonSplit primarySalesperson, long[] salesPlannerIds, Long primaryTraffickerId, long[] sellerContactIds, long[] appliedTeamIds, BaseCustomFieldValue[] customFieldValues, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, String currencyCode, Long exchangeRate, Boolean refreshExchangeRate, Boolean isSold, DateTime lastModifiedDateTime, ProposalMarketplaceInfo marketplaceInfo, 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 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 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 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 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 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[] 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 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 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 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 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 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.