REST Resource: bidders

  • The Bidder resource provides settings and information for bidder accounts within Authorized Buyers or Open Bidding.

  • Each bidder is identified by a unique name following the pattern bidders/{bidderAccountId}.

  • Bidder settings include details for cookie matching and pretargeting configurations for deals.

  • You can access bidder information through the API using methods to get details for a specific bidder or list all accessible bidders.

Resource: Bidder

Bidder settings.

JSON representation
{
  "name": string,
  "cookieMatchingUrl": string,
  "cookieMatchingNetworkId": string,
  "bypassNonguaranteedDealsPretargeting": boolean,
  "dealsBillingId": string
}
Fields
name

string

Output only. Name of the bidder resource that must follow the pattern bidders/{bidderAccountId}, where {bidderAccountId} is the account ID of the bidder whose information is to be received.

One can get their account ID on the Authorized Buyers or Open Bidding UI, or by contacting their Google account manager.

cookieMatchingUrl

string

Output only. The base URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information.

cookieMatchingNetworkId

string

Output only. The buyer's network ID used for cookie matching. This ID corresponds to the google_nid parameter in the URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information.

bypassNonguaranteedDealsPretargeting

boolean

Output only. An option to bypass pretargeting for private auctions and preferred deals.

When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations.

Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this option. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.

dealsBillingId

string

Output only. The billing ID for the deals pretargeting config. This billing ID is sent on the bid request for guaranteed and nonguaranteed deals matched in pretargeting.

Methods

get

Gets a bidder account by its name.

list

Lists all the bidder accounts that belong to the caller.