Skip to main content

Using Additional Sub IDs

As explained in the Using Sub Ids documentation, Sub Ids are used by Publishers to segment traffic. For example, they might do this by traffic source. This information will then be displayed in the Statistics tab, in the Sub IDs sub-tab.

As well as this, there are two more parameters that are essentially the exact same as 'sub' overall: 'sub2' and 'sub3'.

Examples​

Asynchronous ad zones: Banners, Sticky Banners, Instant Messages, Outstream Ads and Mutli-Formats​

Added data-sub = XXXXXX, data-sub2 = XXXXXX and data-sub3 = XXXXXX

<script async type="application/javascript" src="https://ads.examplesite.com/ad-provider.js"></script>
<ins class="adsbynetwork" data-zoneid="1234567" data-sub="XXXXXX" data-sub2="XXXXXX" data-sub3="XXXXXX"></ins>
<script>(AdProvider = window.AdProvider || []).push({"serve": {}});</script>

iFrames​

Added &sub= XXXXXX, &sub2= XXXXXX and &sub3= XXXXXX

<iframe src="//a.examplesite.com/iframe.php?idzone=1234567&size=300x250&sub=XXXXXX&sub2=XXXXXX&sub3=XXXXXX" width="300" height="250" scrolling="no" marginwidth="0" marginheight="0" frameborder="0"></iframe>

Native​

Added as data-ad_sub= "XXXXXX"; data-ad_sub2 = "XXXXXX"; data-ad_sub3 = "XXXXXX";

data-ad_sub= "XXXXXX";
data-ad_sub2 = "XXXXXX";
data-ad_sub3 = "XXXXXX";

<script type="text/javascript" data-idzone="123" data-ad_sub="123456" data-ad_sub="789101" data-ad_sub="1213141" src="https://a.examplesite.com/nativeads.js"></script>

RTB​

Added in ext object as &sub=XXXXXX, &sub2=XXXXXX, &sub3=XXXXXX




{
   "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
   "imp": [
       {
           "id": "974090632",
           "banner": {
               "w": 300,
               "h": 250
           }
       }
   ],
   "site": {
       "id": "12345",
       "domain": "sitedomain.com",
       "cat": ["IAB25-3"],
       "page": "https://sitedomain.com/page"
   },
   "device": {
       "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
       "ip": "131.34.123.159",
       "geo": {
           "country": "IRL"
       },
       "language": "en",
       "os": "Linux & UNIX",
       "js": 0,
       "ext": {
           "remote_addr": "131.34.123.159",
           "x_forwarded_for": "",
           "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
       }
   },
   "user": {
       "id": "57592f333f8983.043587162282415065"
   },
   "ext": {
       "sub": 1221,
       "sub2": 2222,
       "sub3": 3333
   }
}

These parameters could be used to segment the traffic even more. However, unlike sub, this won’t be displayed in the Sub IDs sub-tab of the Statistics tab. However, we do register them internally. The only way to get the data for these metrics is through the API Global Routes for Publishers.

Here are two examples of how the request should look in order to pull data from sub2 and sub3 respectively:

Grouping by sub2 and sub3​


{
  "count": 0,
  "detailed": 0,
  "timezone": "Europe/Dublin",
  "totals": 1,
  "filter": {
    "date_from": "2019-11-07",
    "date_to": "2019-11-07",
     "zone_id": [
      1234567
    ]
  },
  "group_by": [
    "sub2",
    "sub3"
  ],
  "order_by": [
    {
      "field": "impressions",
      "order": "desc"
    }
  ],
  "projection": [
    "base"
  ],
  "limit": 25,
  "offset": 0
}

Filtering and grouping by sub2 and sub 3​



{
  "count": 0,
  "detailed": 0,
  "timezone": "Europe/Dublin",
  "totals": 1,
  "filter": {
    "date_from": "2019-11-07",
    "date_to": "2019-11-07",
    "sub": [
      10001
    ],
    "sub2":[
      10002
    ],
    "sub3":[
      10003
    ],
    "zone_id": [
      1234567
    ]
  },
  "group_by": [
    "sub2",
    "sub3"
  ],
  "order_by": [
    {
      "field": "impressions",
      "order": "desc"
    }
  ],
  "projection": [
    "base"
  ],
  "limit": 25,
  "offset": 0
}

Note: It is only possible to group in two dimensions. If you you want to group by 'sub', you will need to remove either 'sub2' or 'sub3'. Otherwise, the response will generate an error.


{
  "message": "Request `group_by` data is invalid."
}