Partager via

Cross-Partner Settings service

  • Article

The Cross-Partner Settings Service allows for the retrieval and editing of the the member-wide settings for a member in Prebid Server Premium (PSP). They contain global bidder timeouts, price granularity details for bids, and currency settings. Cross Partner Settings are Global Settings in the UI.

REST API

HTTP Method Endpoint Description
GET https://api.appnexus.com/prebid/cross-partner-settings Get all the cross-partner settings for the caller's member.
POST https://api.appnexus.com/prebid/cross-partner-settings Create a new cross-partner setting. Pass the cross-partner settings as JSON in the body of the request.
PUT https://api.appnexus.com/prebid/cross-partner-settings Update an existing cross-partner setting. Pass the updated cross-partner settings as JSON in the body of the request.
PATCH https://api.appnexus.com/prebid/cross-partner-settings Update a portion of an existing cross-partner setting. Pass the updated cross-partner settings as JSON in the body of the request.

GET

Retrieve all of the global PSP settings for the member.

Response

A successful response will return JSON containing the member-wide settings.

Property Type Description
bidder_timeout_ms integer The maximum time, in milliseconds, that Prebid Server Premium partners and other bidders in our marketplace are given to respond.
deleted boolean Indicates if the cross-partner setting has been deleted.
id integer Unique identifier for the cross-partner setting object.
last_modified string The last modification date of the cross-partner setting object.
last_modified_by string The user who last modified the cross-partner setting object.
member_id integer Unique identifier of the member the cross-partner setting object belongs to.
price_granularity object Defines the CPM price buckets into which demand partners' bids will be grouped in the ad server. See the price granularity table below.

Note

The full timeout hierarchy in order from highest to lowest priority is:

  1. Debug Auction timeout value (2000ms) [if debug=1/true].
  2. Ad Request auction_timeout_ms value set by the publisher.
    1. For AMP, see guidance here.
    2. For Android, see guidance here.
    3. For iOS, see guidance here.
  3. Placement-level auction_timeout_ms value. Contact your Microsoft Representative to set this value.
  4. PSP Global Settings (Cross Partner) Timeout value set by the publisher. See guidance here.
  5. Member-level default_auction_timeout_ms value for the given data center. Contact your Microsoft Representative to set this value.
  6. Member-level default_auction_timeout_ms value. Contact your Microsoft Representative to set this value.
  7. Microsoft data center/global default (150ms).

Price granularity

Price granularity defines the CPM price buckets into which demand partner bids will be grouped in the ad server. For more information, see Prebid documentation.

Property Type Description
label string The type of scale as defined in Prebid documentation (low, medium, high, auto, dense, custom).
ranges array Container object describing the price granularity range.
ranges.max integer The maximum length of the range.
ranges.increment float The amount to increment through the range.
precision integer The number of decimal places to round the price. Two is the default, so a price of 2.1234 would be rounded to two decimal places, 2.12.
currency_code string String containing desired currency code for price bucket calculations. Must be a part of the Microsoft-approved list of currencies.

Example response

{
   "id":5,
   "member_id":13859,
   "bidder_timeout_ms":250,
   "price_granularity":{
      "label":"Dense",
      "ranges":[
         {
            "max":3,
            "increment":0.01
         },
         {
            "max":8,
            "increment":0.05
         },
         {
            "max":20,
            "increment":0.5
         }
      ],
      "currency_code":"USD",
      "precision":2
   },
   "last_modified":"2019-10-31T17:37:50Z",
   "last_modified_by":"user123",
   "deleted":false
}

POST

Create a new cross-partner setting.

POST example call using curl

curl https://api.appnexus.com/prebid/cross-partner-settings

POST example JSON

{
   "id":123,
   "member_id":13859,
   "bidder_timeout_ms":995,
   "price_granularity":{
      "label":"Dense",
      "ranges":[
         {
            "max":3,
            "increment":0.01
         },
         {
            "max":8,
            "increment":0.05
         },
         {
            "max":20,
            "increment":0.5
         }
      ],
      "precision":2,
      "currency_code":"USD"
   }
}

POST: Parameters

Property Type Scope Description
bidder_timeout_ms integer Required The maximum time, in milliseconds, that Prebid Server Premium partners and other bidders in our marketplace are given to respond.
price_granularity object Required The price granularity settings. For more details on this object, see the price granularity table below.

POST: Price granularity

Price granularity defines the CPM price buckets into which demand partner bids will be grouped in the ad server. For more information, see Prebid documentation.

Property Type Scope Description
label array Required The type of scale as defined in Prebid documentation (low, medium, high, auto, dense, custom).
ranges array Required Container object describing the price granularity range.
ranges.max integer Required The maximum length of the range.
ranges.increment float Required The amount to increment through the range.
precision integer Required The number of decimal places to round the price. Two is the default, so a price of 2.1234 would be rounded to two decimal places, 2.12.
currency_code string Required String containing desired currency code for price bucket calculations. Must be a part of the Microsoft-approved list of currencies.

PUT

Overwrites an existing cross-partner setting. Pass the information as JSON in the body of the request.

Example call using curl

curl https://api.appnexus.com/prebid/cross-partner-settings

Example JSON

{
  "id": 450,
  "bidder_timeout_ms": 400,
  "price_granularity": {
    "label": "Auto",
    "currency_code": "USD",
    "precision": 2,
    "ranges": [
      {
        "max": 5,
        "increment": 0.05
      },
      {
        "max": 10,
        "increment": 0.1
      },
      {
        "max": 20,
        "increment": 0.5
      }
    ]
  }
}

Response

Returns updated Prebid demand partner object.

PATCH

Updates an existing cross-partner setting. Pass the information as JSON in the body of the request.

Example call using curl

curl https://api.appnexus.com/prebid/cross-partner-settings

Example JSON

{
  "bidder_timeout_ms": 500
}

Response

Returns the updated Prebid demand partner object.