REST Resource: bidders.endpoints
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Endpoint
Bidder endpoint that receives bid requests.
| JSON representation |
{
"name": string,
"url": string,
"maximumQps": string,
"tradingLocation": enum (TradingLocation),
"bidProtocol": enum (BidProtocol)
} |
| Fields |
name |
string
Output only. Name of the endpoint resource that must follow the pattern bidders/{bidderAccountId}/endpoints/{endpointId}, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server.
|
url |
string
Output only. The URL that bid requests should be sent to.
|
maximumQps |
string (int64 format)
The maximum number of queries per second allowed to be sent to this server.
|
tradingLocation |
enum (TradingLocation)
The trading location that bid requests should be sent from. See https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for further information.
|
bidProtocol |
enum (BidProtocol)
The protocol that the bidder endpoint is using.
|
TradingLocation
| Enums |
TRADING_LOCATION_UNSPECIFIED |
A placeholder for an undefined trading region. This value should not be used. |
US_WEST |
The Western US trading location. |
US_EAST |
The Eastern US trading location. |
EUROPE |
The European trading location. |
ASIA |
The Asia trading location. |
BidProtocol
The bid protocol options that a bidder endpoint can use.
| Enums |
BID_PROTOCOL_UNSPECIFIED |
Placeholder for undefined bid protocol. This value should not be used. |
GOOGLE_RTB |
Google RTB protocol / Protobuf encoding. |
OPENRTB_JSON |
OpenRTB / JSON encoding (unversioned/latest). |
OPENRTB_PROTOBUF |
OpenRTB / Protobuf encoding (unversioned/latest). |
Methods |
|
|
Gets a bidder endpoint by its name. |
|
|
Lists all the bidder's endpoints. |
|
|
Updates a bidder's endpoint. |
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 endpoint is a resource that receives bid requests and has properties like name, URL, maximum queries per second, trading location, and bid protocol.\u003c/p\u003e\n"],["\u003cp\u003eTrading Location refers to the geographical region where the bidder's infrastructure is located and influences latency measurements.\u003c/p\u003e\n"],["\u003cp\u003eBid Protocol defines the communication protocol and encoding used by the bidder endpoint for handling bid requests, with options like Google RTB, OpenRTB JSON, and OpenRTB Protobuf.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage bidder endpoints through methods like Get, List, and Patch to retrieve, view a list, or update them respectively.\u003c/p\u003e\n"]]],[],null,["# REST Resource: bidders.endpoints\n\n- [Resource: Endpoint](#Endpoint)\n - [JSON representation](#Endpoint.SCHEMA_REPRESENTATION)\n- [TradingLocation](#TradingLocation)\n- [BidProtocol](#BidProtocol)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Endpoint\n------------------\n\nBidder endpoint that receives bid requests.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"url\": string, \"maximumQps\": string, \"tradingLocation\": enum (/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints#TradingLocation), \"bidProtocol\": enum (/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints#BidProtocol) } ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server. |\n| `url` | `string` Output only. The URL that bid requests should be sent to. |\n| `maximumQps` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The maximum number of queries per second allowed to be sent to this server. |\n| `tradingLocation` | `enum (`[TradingLocation](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints#TradingLocation)`)` The trading location that bid requests should be sent from. See \u003chttps://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations\u003e for further information. |\n| `bidProtocol` | `enum (`[BidProtocol](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints#BidProtocol)`)` The protocol that the bidder endpoint is using. |\n\nTradingLocation\n---------------\n\nThe region where infrastructure hosting a bidder application may be located, and corresponds to the location of the users that bid requests are sent for. Trading location serves as a reference point for measuring and enforcing bidder latency.\n\nSee \u003chttps://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations\u003e for further information.\n\n| Enums ||\n|--------------------------------|-------------------------------------------------------------------------------|\n| `TRADING_LOCATION_UNSPECIFIED` | A placeholder for an undefined trading region. This value should not be used. |\n| `US_WEST` | The Western US trading location. |\n| `US_EAST` | The Eastern US trading location. |\n| `EUROPE` | The European trading location. |\n| `ASIA` | The Asia trading location. |\n\nBidProtocol\n-----------\n\nThe bid protocol options that a bidder endpoint can use.\n\n| Enums ||\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `BID_PROTOCOL_UNSPECIFIED` | Placeholder for undefined bid protocol. This value should not be used. |\n| `GOOGLE_RTB` | Google RTB protocol / Protobuf encoding. | Deprecated: The Google RTB protocol has been sunset. Use the OpenRTB protocol instead. |\n| `OPENRTB_JSON` | OpenRTB / JSON encoding (unversioned/latest). |\n| `OPENRTB_PROTOBUF` | OpenRTB / Protobuf encoding (unversioned/latest). |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------------|-------------------------------------|\n| ### [get](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints/get) | Gets a bidder endpoint by its name. |\n| ### [list](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints/list) | Lists all the bidder's endpoints. |\n| ### [patch](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints/patch) | Updates a bidder's endpoint. |"]]
