REST Resource: bidders
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Bidder
| 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 |
|
|
Gets a bidder account by its name. |
|
|
Lists all the bidder accounts that belong to the caller. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.
[null,null,["Last updated 2025-05-07 UTC."],[[["\u003cp\u003eThe Bidder resource provides settings and information for bidder accounts within Authorized Buyers or Open Bidding.\u003c/p\u003e\n"],["\u003cp\u003eEach bidder is identified by a unique name following the pattern \u003ccode\u003ebidders/{bidderAccountId}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eBidder settings include details for cookie matching and pretargeting configurations for deals.\u003c/p\u003e\n"],["\u003cp\u003eYou can access bidder information through the API using methods to get details for a specific bidder or list all accessible bidders.\u003c/p\u003e\n"]]],[],null,["# REST Resource: bidders\n\n- [Resource: Bidder](#Bidder)\n - [JSON representation](#Bidder.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Bidder\n----------------\n\nBidder settings.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"cookieMatchingUrl\": string, \"cookieMatchingNetworkId\": string, \"bypassNonguaranteedDealsPretargeting\": boolean, \"dealsBillingId\": string } ``` |\n\n| Fields ||\n|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `cookieMatchingUrl` | `string` Output only. The base URL used in cookie match requests. Refer to \u003chttps://developers.google.com/authorized-buyers/rtb/cookie-guide\u003e for further information. |\n| `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 \u003chttps://developers.google.com/authorized-buyers/rtb/cookie-guide\u003e for further information. |\n| `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. |\n| `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. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------|----------------------------------------------------------|\n| ### [get](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders/get) | Gets a bidder account by its name. |\n| ### [list](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders/list) | Lists all the bidder accounts that belong to the caller. |"]]
