Context Object

This object passes information about the context of the where, how, and to whom the ad will be shown, i.e. the user, their device, their location, the channel (e.g., site, app, digital out-of-home) with which they are interacting, the channel’s publisher, its content, and any regulations that are in effect (e.g., COPPA, GDPR).

Context Object Properties
Value Type Description
regs object Contains any regulation specific information, e.g. GDPR, see Regulations Context
restrictions object This object allows lists of restrictions on ad responses to be specified including specific content categories, advertisers, ads pertaining to specific apps, or creative attributes, see Restrictions Context
site object Specifies the website on which the ad will be shown, see Site Context
user object Contains details of the user to whom the ad will be shown, User Context
device object Specifies the device on which the ad will be shown, see Device Context
app object Specifies the app on which the ad will be shown, see App Context
dooh object Specifies the Direct out of Home (DOOH) details for this ad, see DOOH Context

Example Context JSON

{
    "id":"0123456789ABCDEF",
    "item":[
        {
            "id":"1"
        },
        {
            "id":"2"
        }
    ],
    "context":{
        "regs":{
            "gdpr":0,
            "coppa":1
        },
        "restrictions":{
            "bcat":[
                "IAB24",
                "IAB25",
                "IAB26"
            ],
            "cattax":1,
            "badv":[
                "example.com",
                "example_2.com"
            ]
        },
        "site":{
            "id":"1234",
            "name":"Awesome Example Site",
            "domain":"examplesitedomain.com",
            "mobile":1,
            "amp":0,
            "pub":{
                "id":"9876",
                "name":"Example Publisher, Inc.",
                "domain":"examplepubdomain.com"
            }
        },
        "user":{
            "id":"a0af45c77890045deec100acb8443baff57c",
            "consent":"ihdknkhkq8y",
            "buyeruid":"fcd4282456238256034abcdef220d9aa5892",
            "yob":1990,
            "gender":"F",
            "ext":{
                "consented_providers_settings":{
                    "consented_providers":[
                        1,
                        52,
                        45,
                        23
                    ]
                }
            }
        },
        "device":{
            "type":4,
            "ifa":"8846d6fa10008bceaaf322908dfcb221",
            "ip":"1.2.3.4",
            "ua":"Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) Gecko/20110319 Firefox/3.6.16",
            "make":"Apple",
            "model":"iPhone",
            "hwv":"6s",
            "os":13,
            "osv":"11.4.1",
            "mccmnc":"310-005",
            "geo":{
                "type":1,
                "lat":42.3601,
                "lon":71.0581,
                "country":"USA",
                "utcoffset":-300
            }
        }
    }
}