REST Resource: networks.proposals

Resource: Proposal

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

JSON representation 
{
  "name": string,
  "agencies": [
    {
      object (ProposalCompanyAssociation)
    }
  ],
  "salesPlannerUsers": [
    string
  ],
  "sellerContactUsers": [
    string
  ],
  "appliedTeams": [
    string
  ],
  "customFieldValues": [
    {
      object (CustomFieldValue)
    }
  ],
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "effectiveAppliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "currencyCode": string,
  "marketplaceInfo": {
    object (ProposalMarketplaceInfo)
  },
  "buyerRfp": {
    object (BuyerRfp)
  },
  "order": string,
  "displayName": string,
  "startTime": string,
  "endTime": string,
  "archived": boolean,
  "advertiser": string,
  "notes": string,
  "primarySalesperson": string,
  "trafficker": string,
  "sold": boolean,
  "updateTime": string,
  "deliveryPausingEnabled": boolean,
  "supplyPath": enum (SupplyPathType)
}
Fields
name

string

Identifier. The resource name of the Proposal. Format: networks/{networkCode}/proposals/{proposal_id}
agencies[]

object (ProposalCompanyAssociation)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.
salesPlannerUsers[]

string

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{networkCode}/users/{userId}
sellerContactUsers[]

string

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{networkCode}/users/{userId}
appliedTeams[]

string

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{networkCode}/teams/{team_id}
customFieldValues[]

object (CustomFieldValue)

Optional. The values of the custom fields associated with the Proposal.
appliedLabels[]

object (AppliedLabel)

Optional. The set of labels applied directly to the Proposal.
effectiveAppliedLabels[]

object (AppliedLabel)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.
currencyCode

string

Optional. The currency code of this Proposal. If not directly set, the currency code will be the network's currency code.
marketplaceInfo

object (ProposalMarketplaceInfo)

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.
buyerRfp

object (BuyerRfp)

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.
order

string

Output only. The resource name of the corresponding Order. This will not be set if the Proposal has not been pushed to Ad Manager. Format: networks/{networkCode}/orders/{orderId}
displayName

string

Required. The display name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.displayName when the proposal turns into an order.
startTime

string (Timestamp format)

Output only. The time at which the Order and LineItems associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest [startTime][ProposalLineItem.start_time]. This attribute will be empty if this Proposal has no associated [ProposalLineItems][ProposalLineItem] or if none of its [ProposalLineItems][ProposalLineItem] have a start time.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Output only. The time at which the Order and LineItems associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest [endTime][ProposalLineItem.end_time]. This attribute will be empty if this Proposal has no associated [ProposalLineItems][ProposalLineItem] or if none of its [ProposalLineItems][ProposalLineItem] have an end time.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
archived

boolean

Output only. Whether the Proposal is archived or not.
advertiser

string

Required. The resource name of the Company of type ADVERTISER to which this Proposal belongs. This attribute is required when the proposal turns into an order, and will be copied to Order.advertiser. This attribute becomes read-only once the Proposal has been pushed. Format: networks/{networkCode}/companies/{companyId}
notes

string

Optional. Provides any additional notes that may annotate the Proposal. This attribute has a maximum length of 65,535 characters.
primarySalesperson

string

Optional. The resource name of the User representing the primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. Format: networks/{networkCode}/users/{userId}
trafficker

string

Optional. The resource name of the User who is the 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.trafficker. Format: networks/{networkCode}/users/{userId}
sold

boolean

Output only. Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is APPROVED or PAUSED.
updateTime

string (Timestamp format)

Output only. The time this Proposal was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
deliveryPausingEnabled

boolean

Optional. Non-empty default. Whether delivery of the Proposal can be paused. Defaults to true. If false, the buyer and the seller agree that the Proposal should not be paused.
supplyPath

enum (SupplyPathType)

Optional. Non-empty default. The supply path type of this Proposal. If no value is provided on creation, defaults to DEMAND_SIDE_PLATFORM.

ProposalCompanyAssociation

A ProposalCompanyAssociation represents a Company associated with the Proposal and a set of Contacts belonging to the company.

JSON representation 
{
  "sellerContacts": [
    string
  ],
  "company": string,
  "type": enum (ProposalCompanyAssociationType)
}
Fields
sellerContacts[]

string

Optional. The resource names of the Contacts associated with the Company. Format: networks/{networkCode}/contacts/{contactId}
company

string

Required. The resource name of the Company associated with the Proposal. Format: networks/{networkCode}/companies/{companyId}
type

enum (ProposalCompanyAssociationType)

Required. The association type between the Company and the Proposal.

ProposalCompanyAssociationType

Describes the type of a Company associated with a Proposal.

Enums
PROPOSAL_COMPANY_ASSOCIATION_TYPE_UNSPECIFIED Default value. This value is unused.
BILLING_AGENCY The company is a billing agency.
BRANDING_AGENCY The company is a branding agency.
OTHER_AGENCY The company is other type of agency.
PRIMARY_AGENCY The company is a primary agency.

ProposalMarketplaceInfo

Marketplace info for a Proposal with a corresponding order in Marketplace.

JSON representation 
{
  "marketplaceOrderId": string,
  "draftProposal": boolean,
  "negotiationStatus": enum (ProposalNegotiationStatus),
  "marketplaceComment": string,
  "newVersionFromBuyer": boolean,
  "buyerAccountId": string,
  "partnerClientId": string
}
Fields
marketplaceOrderId

string

Output only. The marketplace ID of this Proposal. This is a shared ID between Ad Manager and the buy-side platform. This value is null if the Proposal has not been sent to the buyer.
draftProposal

boolean

Output only. Whether the non-free-editable fields of a Proposal are opened for edit. A Proposal that is open for edit will not receive buyer updates from Marketplace. If the buyer updates the Proposal while this is open for local editing, Google will set newVersionFromBuyer to true. You will then need to call ProposalService.BatchDiscardDraftProposals to revert your edits to get the buyer's latest changes.
negotiationStatus

enum (ProposalNegotiationStatus)

Output only. The negotiation status of the Proposal.
marketplaceComment

string

Optional. The comment on the Proposal to be sent to the buyer.
newVersionFromBuyer

boolean

Output only. Indicates that the buyer has made updates to the Proposal on Marketplace. This attribute is only meaningful if the Proposal is open for edit (i.e., draftProposal is true).
buyerAccountId

string (int64 format)

Required. The account ID of the buyer that this Proposal is being negotiated with.
partnerClientId

string

Output only. The ID used to represent the Display & Video 360 client buyer partner ID (if Display & Video 360) or the Authorized Buyers client buyer account ID.

ProposalNegotiationStatus

Represents the Proposal's negotiation status for Marketplace.

Enums
PROPOSAL_NEGOTIATION_STATUS_UNSPECIFIED Default value. This value is unused.
AWAITING_BUYER_REVIEW Indicates that a Proposal has been updated by the seller and is awaiting buyer approval.
AWAITING_SELLER_REVIEW Indicates that a Proposal has been updated by the buyer and is awaiting seller approval.
BUYER_INITIATED Indicates that a new Proposal has been created by the buyer and is awaiting seller action.
CANCELLED Indicates that negotiations for the Proposal have been cancelled.
FINALIZED Indicates that the Proposal has been accepted by both the buyer and the seller.
SELLER_ACCEPTANCE_REQUESTED Indicates that the buyer has accepted the Proposal and is awaiting the seller's acceptance.
BUYER_ACCEPTANCE_REQUESTED Indicates that the seller has accepted the Proposal and is awaiting the buyer's acceptance.
SELLER_INITIATED Indicates that a new Proposal has been created by the seller and has not been sent to Marketplace yet.

BuyerRfp

Represents the buyer RFP information associated with a Proposal describing the requirements from the buyer.

JSON representation 
{
  "costPerUnit": {
    object (Money)
  },
  "budget": {
    object (Money)
  },
  "startTime": string,
  "endTime": string,
  "creativePlaceholders": [
    {
      object (CreativePlaceholder)
    }
  ],
  "targeting": {
    object (Targeting)
  },
  "units": string,
  "description": string,
  "additionalTerms": string,
  "adExchangeEnvironment": enum (ProposalEnvironmentType),
  "rfpType": enum (BuyerRfpType)
}
Fields
costPerUnit

object (Money)

Output only. CPM for the Proposal in question. Given that this field belongs to a request for proposal (for which initially a Proposal does not yet exist), this field should serve as guidance for publishers to create a Proposal with LineItems reflecting this CPM.
budget

object (Money)

Output only. Total amount of money available to spend on this deal. In the case of a Preferred Deal, the budget is equal to the maximum amount of money a buyer is willing to spend on a given Proposal, even though the budget might not be spent entirely, as impressions are not guaranteed.
startTime

string (Timestamp format)

Output only. The time at which the proposed deal should start serving.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Output only. The time at which the proposed deal should end serving.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
creativePlaceholders[]

object (CreativePlaceholder)

Output only. A list of inventory sizes in which creatives will eventually be served.
targeting

object (Targeting)

Output only. Targeting information for the proposal in question. Currently this field only contains GeoTargeting information.
units

string (int64 format)

Output only. The number of impressions per day that a buyer wishes to see in the Proposal derived from the request for proposal in question.
description

string

Output only. A description of the proposed deal. This can be used for the buyer to tell the publisher more detailed information about the deal in question.
additionalTerms

string

Output only. Additional terms of the deal in question. This field can be used to state more specific targeting information for the deal, as well as any additional information regarding this deal. Given that this field belongs to a request for proposal (for which initially a Proposal does not yet exist), this field can be populated by buyers to specify additional information that they wish publishers to incorporate into the Proposal derived from this request for proposal.
adExchangeEnvironment

enum (ProposalEnvironmentType)

Output only. Identifies the format of the inventory or "channel" through which the ad serves. Environments currently supported include DISPLAY, VIDEO, and MOBILE.
rfpType

enum (BuyerRfpType)

Output only. Deal type; either Programmatic Guaranteed or Preferred Deal. This field corresponds to the type of Proposal that a buyer wishes to negotiate with a seller.

ProposalEnvironmentType

Identifies the format of inventory or "channel" in which ads serve.

Enums
PROPOSAL_ENVIRONMENT_TYPE_UNSPECIFIED Default value. This value is unused.
DISPLAY Ads serve in a browser.
DISPLAY_OUTSTREAM_VIDEO Out-stream video ads serve in a browser. Examples include in-feed and in-banner video ads.
GAMES In-stream video ads serve in a game.
MOBILE Ads serve in a mobile app.
MOBILE_OUTSTREAM_VIDEO Out-stream video ads serve in a mobile app.
VIDEO In-stream video ads serve in a video.

BuyerRfpType

Decribes the type of BuyerRfp.

Enums
BUYER_RFP_TYPE_UNSPECIFIED Default value. This value is unused.
PREFERRED_DEAL Indicates the BuyerRfp is a Preferred Deal RFP.
PROGRAMMATIC_GUARANTEED Indicates the BuyerRfp is a Programmatic Guaranteed RFP.

SupplyPathType

Describes how the demand will be supplied

Enums
SUPPLY_PATH_TYPE_UNSPECIFIED Not specified value.
DIRECT The demand will be supplied by the ad server directly.
DEMAND_SIDE_PLATFORM The demand will be supplied by a demand side platform (DSP).

Methods

batchArchive

 Archives Proposal objects.

batchCreate

 Creates Proposal objects.

batchDiscardDraft

 Discards drafts, or revert local modifications, of Proposal objects.

batchPause

 Pauses Proposal objects.

batchPushToOrder

 Push changes on Proposals to corresponding Orders, after negotiations have been finalized.

batchRedraft

 Redrafts Proposal objects for negotiation.

batchRequestBuyerAccept

 Requests buyer acceptance for Proposal objects.

batchRequestBuyerReview

 Requests buyer review for Proposal objects.

batchReserve

 Reserves inventory for Proposal objects.

batchResume

 Resumes Proposal objects.

batchTerminate

 Terminates negotiation on Proposal objects.

batchUnarchive

 Unarchives Proposal objects.

batchUpdate

 Batch updates Proposal objects.

create

 Creates a Proposal object.

fetchMarketplaceComments

 Fetches MarketplaceComments made on Proposals.

get

 Retrieves a Proposal object.

list

 Lists Proposal objects.

patch

 Updates a Proposal object.