Ads API .NET library
|
A More...
Properties | |
long | id [get, set] |
The unique ID of the More... | |
bool | idSpecified [get, set] |
bool | isProgrammatic [get, set] |
Flag that specifies whether this More... | |
bool | isProgrammaticSpecified [get, set] |
long | dfpOrderId [get, set] |
The unique ID of corresponding Order. This will be More... | |
bool | dfpOrderIdSpecified [get, set] |
string | name [get, set] |
The name of the More... | |
DateTime | startDateTime [get, set] |
The date and time at which the order and line items associated with the More... | |
DateTime | endDateTime [get, set] |
The date and time at which the order and line items associated with the More... | |
ProposalStatus | status [get, set] |
The status of the More... | |
bool | statusSpecified [get, set] |
bool | isArchived [get, set] |
The archival status of the More... | |
bool | isArchivedSpecified [get, set] |
ProposalCompanyAssociation | advertiser [get, set] |
The advertiser, to which this More... | |
ProposalCompanyAssociation[] | agencies [get, set] |
List of agencies and the set of Contact objects associated with each agency. This attribute is optional. A More... | |
string | internalNotes [get, set] |
Provides any additional notes that may annotate the More... | |
SalespersonSplit | primarySalesperson [get, set] |
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. More... | |
long[] | salesPlannerIds [get, set] |
List of unique IDs of User objects who are the sales planners of the More... | |
long | primaryTraffickerId [get, set] |
The unique ID of the User who is primary trafficker and is responsible for trafficking the More... | |
bool | primaryTraffickerIdSpecified [get, set] |
long[] | sellerContactIds [get, set] |
users who are the seller's contacts. More... | |
long[] | appliedTeamIds [get, set] |
The IDs of all teams that the More... | |
BaseCustomFieldValue[] | customFieldValues [get, set] |
The values of the custom fields associated with the More... | |
AppliedLabel[] | appliedLabels [get, set] |
The set of labels applied directly to the More... | |
AppliedLabel[] | effectiveAppliedLabels [get, set] |
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. More... | |
string | currencyCode [get, set] |
The currency code of this More... | |
bool | isSold [get, set] |
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. More... | |
bool | isSoldSpecified [get, set] |
DateTime | lastModifiedDateTime [get, set] |
The date and time this More... | |
ProposalMarketplaceInfo | marketplaceInfo [get, set] |
The marketplace info of this proposal if it has a corresponding order in Marketplace. More... | |
BuyerRfp | buyerRfp [get, set] |
The buyer RFP associated with this More... | |
bool | hasBuyerRfp [get, set] |
Whether a Proposal contains a BuyerRfp field. If this field is true, it indicates that the Proposal in question orignated from a buyer. More... | |
bool | hasBuyerRfpSpecified [get, set] |
bool | deliveryPausingEnabled [get, set] |
Whether pausing is consented for the More... | |
bool | deliveryPausingEnabledSpecified [get, set] |
A
Proposal
represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.
|
getset |
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.
|
getset |
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.
|
getset |
The set of labels applied directly to the
Proposal
. This attribute is optional.
|
getset |
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.
|
getset |
The buyer RFP associated with this
Proposal
, which is optional. This field will be null if the proposal is not initiated from RFP.
|
getset |
The currency code of this
Proposal
. This attribute is optional and defaults to network's currency code.
|
getset |
The values of the custom fields associated with the
. 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.
|
getset |
Whether pausing is consented for the
Proposal
. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.
|
getset |
true
, if a value is specified for deliveryPausingEnabled, false
otherwise.
|
getset |
|
getset |
true
, if a value is specified for dfpOrderId, false
otherwise.
|
getset |
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.
|
getset |
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.
|
getset |
|
getset |
true
, if a value is specified for hasBuyerRfp, false
otherwise.
|
getset |
The unique ID of the
Proposal
. This attribute is read-only.
|
getset |
true
, if a value is specified for id, false
otherwise.
|
getset |
Provides any additional notes that may annotate the
. 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.
|
getset |
The archival status of the
Proposal
. This attribute is read-only.
|
getset |
true
, if a value is specified for isArchived, false
otherwise.
|
getset |
Flag that specifies whether this
Proposal
is for programmatic deals. This value is default to false
.
|
getset |
true
, if a value is specified for isProgrammatic, false
otherwise.
|
getset |
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.
|
getset |
true
, if a value is specified for isSold, false
otherwise.
|
getset |
The date and time this
Proposal
was last modified. This attribute is read-only.
|
getset |
The marketplace info of this proposal if it has a corresponding order in Marketplace.
|
getset |
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.
|
getset |
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.
|
getset |
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.
|
getset |
true
, if a value is specified for primaryTraffickerId, false
otherwise.
|
getset |
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.
|
getset |
users who are the seller's contacts.
|
getset |
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.
|
getset |
The status of the
Proposal
. This attribute is read-only.
|
getset |
true
, if a value is specified for status, false
otherwise.