Accounts

An Accounts resource is the root data class for the Ad Exchange Buyer API. You can only manipulate accounts that you have been granted permission to access. Please contact your technical account manager to configure permissions.

For a list of methods for this resource, see the end of this page.

Resource representations

Configuration data for an Ad Exchange buyer account.

{
  "kind": "adexchangebuyer#account",
  "id": integer,
  "cookieMatchingUrl": string,
  "cookieMatchingNid": string,
  "bidderLocation": [
    {
      "url": string,
      "maximumQps": integer,
      "region": string,
      "bidProtocol": string
    }
  ],
  "maximumTotalQps": integer,
  "maximumActiveCreatives": integer,
  "numberActiveCreatives": integer
}
Property name Value Description Notes
bidderLocation[] list List of URLs for this account's bidder locations. It is recommended that bidders use separate URLs for separate physical server locations (for example, a bidder could have one URL for a European server and another for an Asian server). These URLs are set by the bidder. Each item in the list is a set of three values, where the first is the url for a bidder, the second is the maximumQps for that bidder, and the third is the region where the server associated with the url is located.
bidderLocation[].bidProtocol string The protocol that the bidder endpoint is using. Defaults to PROTOCOL_ADX. It will not be returned if set to the default value; it will only be returned if it is modified from the default value. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON.

Acceptable values are:
  • "PROTOCOL_ADX"
  • "PROTOCOL_OPENRTB_2_2"
  • "PROTOCOL_OPENRTB_2_3"
  • "PROTOCOL_OPENRTB_2_4"
  • "PROTOCOL_OPENRTB_PROTOBUF_2_3"
  • "PROTOCOL_OPENRTB_PROTOBUF_2_4"
writable
bidderLocation[].maximumQps integer The maximum queries per second that Ad Exchange should send to each individual bidder URL for this account. writable
bidderLocation[].region string The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
  • ASIA
  • EUROPE
  • US_EAST
  • US_WEST
writable
bidderLocation[].url string The URLs to which Ad Exchange should send bid requests for this account.
writable
cookieMatchingNid string The nid parameter value used in cookie match requests. This cannot be changed through an update operation. Please contact your technical account manager if you need to change it.
cookieMatchingUrl string The base URL used in cookie match requests.
writable
id integer Account ID.  This cannot be changed through an update operation.
kind string Resource type. This is always "adexchangebuyer#account".
maximumActiveCreatives integer The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
maximumTotalQps integer The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
numberActiveCreatives integer The number of creatives that this account inserted or bid with in the last 30 days.

Methods

get
Gets one account by ID.
list
Retrieves the authenticated user's list of accounts.
patch
Updates an existing account. This method supports patch semantics.
update
Updates an existing account.

Send feedback about...

Buyer REST API
Buyer REST API