PARAMETERS (myDSP RTB Integration)

myDSP RTB Integration Guidelines SRTB JSON XRTB XML GET

Related articles:

Base URL

Parametres

Jason/XML

Stats

Traffic rules

PARAMETERS (myDSP RTB Integration)

Essential / Required Parameters

Required parameters that must be included in every request:

• sid - Subid (alphanumeric, max 50 chars)
  sid - Subid (alphanumeric, max 50 chars)
  Note: Alphanumeric(a-z A-Z 0-9), "-", "_" and ".". All other characters are not supported and will be removed in the logs. International characters or any other special characters are also not supported

• ip - User IPv4 address
  Note:User IP. IPv4 Only. It has to match the real user IP, so be sure to take into consideration the X-Forwarded-For header values and other possible real IP indicators. NOTE: If you're passing the xff parameter please put the default connecting IP in this field and the full value of x-forwarded-for in the xff parameter. If passing data in the xff parameter those values will be considered for the real IP values (the first public IP in the list generally, however keep in mind that due to the potentially manipulative nature of "Real IP" headers there are some filters applied and some requests will be blocked)

• ua - URL-encoded User Agent
  Note: User Agent, URL Encoded. Be sure that the value you're forwarding is only url encoded ONCE. If you are forwarding a request from another source be sure not to encode an already encoded string

• brand - For brand/search feeds, pass the targeted brand domain
  Note: Only for brand /search traffic

Highly recommended

These parameters significantly improve request quality:

• url - Page URL (max 4000 chars)
  Note: URL of the page that the user is viewing (not your redirect link) OR in case of deeplink brand feeds the final URL that the user is supposed to be sent to. Please make sure not to send invalid URLs. All urls must be valid http/https urls with a hostname, no other protocols are supported. URL Encoded

• k - Keywords (max lenght: 150, truncated to 150 chars if longer)
  Note: Keywords. All keywords have to be comma (,) separated. Stick to sending up to 5 keywords at most. Don't send massive keywords (like 50+ characters for one keyword). Keep them short and on point. Replace spaces with +

• l - Language codes
  Note: Languages taken from the user's navigator.languages browser property OR the value from "Accept-Language" header. For multiple values (if taken from navigator.languages) please separate them with a comma; URL Encoded

• dai - Device Advertising ID (AAID, IDFA or equivalent)
• uid - First-Party cookie User ID or Equivalent
  Note: If you are passing the "dai" parameter this value is ignored

• bm - Bid Max. Current highest bid on your network for this particular type of visitor
• cat - IAB Category of the visitor's currently viewed website
• brandct - Content Type for brand traffic. Integer Values
  Note: brand/search only, current categories:

0:"Other",

1:"PLA (Product Listing Ads)",

2:"Social",

3:"Deal Site (Coupon)",

4:"Ad Network",

5:"Apps & Plugins (eg. Browser Extension, Mobile App)",

6:"Intext",

7:"Domain Redirect (Domains Misspell - Parked Domains)",

8:"BNPL (Buy Now Pay Later)",

9:"Push",

10:"Native",

11:"Blog",

12:"Newsletter",

13:"Search",

14:"Tile"

• brandsrc - Brand click origin (eg. "https%3A%2F%2Fcoupons.businessinsider.com") URL Encoded
  Note: brand/search only

• ch-ua - sec-ch-ua header or navigator.userAgentData equivalent. URL Encoded
• ch-mob - sec-ch-ua-mobile header or navigator.userAgentData equivalent. URL Encoded
• ch-os - sec-ch-ua-platform header or navigator.userAgentData equivalent. URL Encoded
• ch-osv - sec-ch-ua-platform-version header or navigator.userAgentData equivalent. High Entropy Client Hint. URL Encoded
• fetch-site - sec-fetch-site header. URL Encoded
• fetch-mode - sec-fetch-mode header. URL Encoded
• fetch-user - sec-fetch-user header. URL Encoded
• fetch-dest - sec-fetch-dest header. URL Encoded
• xrw - App ID/Name for Android/iOS or any Desktop Store Apps (if available)

Optional, not required Parameters

• xff - X-Forwarded-For header values that indicate the real user IP. Full Value of the XFF header should be passed. If the user has the XFF header set but you are not passing it in this parameter be sure to parse and put the real IP in the above mentioned "ip" parameter
• to - Timeout in milliseconds. Integer Values. Max Time you are willing to wait for a response to your request. This is something that will require a bit of tuning from your side of things (publisher side) and when you're deciding on a value please be sure to take into consideration the network travel time of your request as well
  Note: Min value is 50 and all values below 50 will be ignored

• i - Iframe Indicator for mixed traffic feeds 0=not iframed, 1=iframed; Note: Only taken into consideration if your feed is categorized as "mixed traffic" in regards to iframes
  Note: Not required, defaults to the value assigned to your feed

• a - Adult Traffic Indicator. 0=not adult, 1=adult; Note: Only taken into consideration if your feed is categorized as "mixed traffic" in regards to traffic type
  Note: Note: Not required, defaults to the value assigned to your feed

• bc - Max Number of Bids to return for your request
  Note: No, defaults to 1, Disabled at the moment, only returning 1

• wh - Width X Height of the user's screen (eg. 1920x1080)
• bf - Bid Floor. Minimum bid to return. If all bids are below the bid floor a 204 will be returned. Values in USD only. If your feed is set to use CPM values then please pass CPM values, otherwise defaults to CPC
• e_c - External Click ID. You can use this parameter to pass your own click id which will then enable you to get stats based on your click ids
  Note: Max Length: 100 (truncated to 100 chars if longer)

• cc - Compliance Check flag (&cc=1) that indicates the request is checking for malicious/non-compliant ads. Clicks from these requests will not count towards your revenue
• wseat - Seat Whitelist (in case of publishers allowing only specific seats to bid on their traffic). Comma Separated & URL Encoded
  Note: Not required, but revenue impact can be severe in cases where the list is present on the publisher side but not communicated in the request (Not implemented currently, feature in progress)
• bseat - Seat Blocklist (in case of publishers blocking specific seats from bidding on their traffic). Comma Separated & URL Encoded
  Note: Not required, No, but revenue impact can be severe in cases where the list is present on the publisher side but not communicated in the request (Not implemented currently, feature in progress)