Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in SELLER_REVIEW_REQUESTED
state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.
Scopes
You will need authorization for the https://www.googleapis.com/auth/authorized-buyers-marketplace scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/authorized-buyers-marketplace.
You can set the scope for this method like this: authorizedbuyersmarketplace1 --scope <scope> buyers proposals-send-rfp ...
Required Scalar Argument
- <buyer> (string)
- Required. The current buyer who is sending the RFP in the format:
buyers/{accountId}
.
- Required. The current buyer who is sending the RFP in the format:
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
SendRfpRequest:
client: string
display-name: string
estimated-gross-spend:
currency-code: string
nanos: integer
units: string
flight-end-time: string
flight-start-time: string
geo-targeting:
excluded-criteria-ids: [string]
targeted-criteria-ids: [string]
note: string
preferred-deal-terms:
fixed-price:
amount:
currency-code: string
nanos: integer
units: string
type: string
programmatic-guaranteed-terms:
fixed-price:
amount:
currency-code: string
nanos: integer
units: string
type: string
guaranteed-looks: string
impression-cap: string
minimum-daily-looks: string
percent-share-of-voice: string
reservation-type: string
publisher-profile: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r . client=et
- If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format:
buyers/{accountId}/clients/{clientAccountid}
.
- If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format:
display-name=sanctus
- Required. The display name of the proposal being created by this RFP.
estimated-gross-spend currency-code=lorem
- The three-letter currency code defined in ISO 4217.
nanos=94
- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If
units
is positive,nanos
must be positive or zero. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-750,000,000.
- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If
-
units=sed
- The whole units of the amount. For example if
currencyCode
is"USD"
, then 1 unit is one US dollar.
- The whole units of the amount. For example if
-
.. flight-end-time=diam
- Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
flight-start-time=dolores
- Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
geo-targeting excluded-criteria-ids=dolores
- A list of numeric IDs to be excluded.
- Each invocation of this argument appends the given value to the array.
-
targeted-criteria-ids=et
- A list of numeric IDs to be included.
- Each invocation of this argument appends the given value to the array.
-
.. note=sed
- A message that is sent to the publisher. Maximum length is 1024 characters.
preferred-deal-terms.fixed-price.amount currency-code=no
- The three-letter currency code defined in ISO 4217.
nanos=16
- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If
units
is positive,nanos
must be positive or zero. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-750,000,000.
- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If
-
units=elitr
- The whole units of the amount. For example if
currencyCode
is"USD"
, then 1 unit is one US dollar.
- The whole units of the amount. For example if
-
.. type=sed
- The pricing type for the deal.
-
...programmatic-guaranteed-terms.fixed-price.amount currency-code=no
- The three-letter currency code defined in ISO 4217.
nanos=10
- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If
units
is positive,nanos
must be positive or zero. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-750,000,000.
- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If
-
units=at
- The whole units of the amount. For example if
currencyCode
is"USD"
, then 1 unit is one US dollar.
- The whole units of the amount. For example if
-
.. type=sadipscing
- The pricing type for the deal.
-
.. guaranteed-looks=aliquyam
- Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
impression-cap=dolores
- The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
minimum-daily-looks=sadipscing
- Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
percent-share-of-voice=erat
- For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
-
reservation-type=aliquyam
- The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
-
.. publisher-profile=amet
- Required. The profile of the publisher who will receive this RFP in the format:
buyers/{accountId}/publisherProfiles/{publisherProfileId}
.
- Required. The profile of the publisher who will receive this RFP in the format:
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").