type BuyerRfp (v201808)

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


Namespace
https://www.google.com/apis/ads/publisher/v201808

Field

costPerUnit

Money

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.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

units

xsd:long

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

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

budget

Money

Total amount of Money available to spend on this deal. In the case of 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.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

currencyCode

xsd:string

Currency code for this deal's budget and CPM.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

startDateTime

DateTime

The DateTime in which the proposed deal should start serving.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

endDateTime

DateTime

The DateTime in which the proposed deal should end serving.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

description

xsd:string

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.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

creativePlaceholders

CreativePlaceholder[]

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

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

targeting

Targeting

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

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

additionalTerms

xsd:string

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.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

adExchangeEnvironment

AdExchangeEnvironment

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


Enumerations
DISPLAY
Ads serve in a browser.
VIDEO
In-stream video ads serve in a video.
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. Examples include mobile app interstitials and mobile app rewarded ads.
DISPLAY_OUTSTREAM_VIDEO
Out-stream video ads serve in a browser. Examples include in-feed and in-banner video ads.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

rfpType

RfpType

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.


Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
PROGRAMMATIC_GUARANTEED
Indicates the BuyerRfp is a Programmatic Guaranteed RFP.
PREFERRED_DEAL
Indicates the BuyerRfp is a Preferred Deal RFP.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
  • using preferred deals, not using sales management.

Send feedback about...

Ad Manager API
Ad Manager API
Need help? Visit our support page.