REST Resource: bidders.endpoints

  • An Endpoint resource represents a bidder endpoint that receives bid requests.

  • The Endpoint resource includes fields such as name, url, maximumQps, tradingLocation, and bidProtocol.

  • TradingLocation specifies the region where the bidder application is located and corresponds to the user location for bid requests.

  • BidProtocol defines the protocol options, like OPENRTB_JSON or OPENRTB_PROTOBUF, that a bidder endpoint can use.

  • Methods available for Endpoints include get, list, and patch.

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

The 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.

See https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for further information.

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

get

 Gets a bidder endpoint by its name.

list

 Lists all the bidder's endpoints.

patch

 Updates a bidder's endpoint.