type Proposal (v202111)

Service

ProposalService

Dependencies

ProposalPage createProposals() updateProposals()

▼

Proposal

A Proposal represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.

---

Namespace

https://www.google.com/apis/ads/publisher/v202111

Field
id	xsd:long The unique ID of the Proposal. This attribute is read-only.
isProgrammatic	xsd:boolean Flag that specifies whether this Proposal is for programmatic deals. This value is default to false.
dfpOrderId	xsd:long 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.
name	xsd:string 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.
startDateTime	DateTime 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.
endDateTime	DateTime 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.
status	ProposalStatus The status of the Proposal. This attribute is read-only. Enumerations DRAFT Indicates that the Proposal has just been created or retracted but no approval has been requested yet. PENDING_APPROVAL Indicates that a request for approval has been made for the Proposal. APPROVED Indicates that the Proposal has been approved and is ready to serve. REJECTED Indicates that the Proposal has been rejected in the approval workflow. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
isArchived	xsd:boolean The archival status of the Proposal. This attribute is read-only.
advertiser	ProposalCompanyAssociation 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.
agencies	ProposalCompanyAssociation[] 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.
internalNotes	xsd:string 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.
primarySalesperson	SalespersonSplit 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.
salesPlannerIds	xsd:long[] 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.
primaryTraffickerId	xsd:long 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.
sellerContactIds	xsd:long[] users who are the seller's contacts.
appliedTeamIds	xsd:long[] 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.
customFieldValues	BaseCustomFieldValue[] CustomFieldValue DropDownCustomFieldValue 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.
appliedLabels	AppliedLabel[] The set of labels applied directly to the Proposal. This attribute is optional.
effectiveAppliedLabels	AppliedLabel[] 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.
currencyCode	xsd:string The currency code of this Proposal. This attribute is optional and defaults to network's currency code.
exchangeRate	xsd:long 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.
refreshExchangeRate	xsd:boolean 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.
isSold	xsd:boolean 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.
lastModifiedDateTime	DateTime The date and time this Proposal was last modified. This attribute is read-only.
marketplaceInfo	ProposalMarketplaceInfo The marketplace info of this proposal if it has a corresponding order in Marketplace.
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.
hasBuyerRfp	xsd:boolean Whether a Proposal contains a BuyerRfp field. If this field is true, it indicates that the Proposal in question orignated from a buyer.
deliveryPausingEnabled	xsd:boolean 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.