Open Measurement extensions

Unity Ads supports Open Measurement-capable creatives. IAB’s Open Measurement SDK (OM SDK) offers common code and libraries for facilitating third-party access to measurement data. Sites and apps that integrate the OM SDK can send measurement signals to an Open Measurement Interface Definition (OMID) API. Measurement providers can place tags that collect these signals. To ingest and act on bid requests that support OM creatives, Unity has updated its OpenRTB specs to reflect related changes to the bid request and response fields.

Parent object	Attribute	Type	Example	Description
`bid.source`	`omidpn`	string	`"omidpn": "Unity3d"`	An identifier for the Open Measurement SDK integration. This is the same as the `name` parameter of the OMID Partner object.
`bid.source`	`omidpv`	string	`"omidpv": "1.3.0"`	The version of the Open Measurement SDK integration. This is the same as the `versionString` parameter of the OMID Partner object.
`bid.imp.video`	`api`	int array	`"api": [7]`	Supported API frameworks for this impression. A value of `7` signifies Open Measurement support.
`response.seatbid.bid`	`api`	int	`"api":7`	The API framework supported for this impression. A value of `7` signifies Open Measurement (OM) support. For more information, refer to the API Frameworks section of the IAB Open Measurement SDK manual. Note: Unity expects the OMID-1 API Framework value (`7`) for each bid inside the response so the SDK can handle the OM creative.

For more information, refer to Creative formats.

Example bid request

{
    "id": "ABCDEfghijkLMNOPqrstUV",
    "imp": [{
        "id": "1",
        "video": {
            "mimes": ["video/mp4"],
            "minduration": 5,
            "maxduration": 30,
            "protocols": [2, 3, 5, 6],
            "w": 320,
            "h": 480,
            "linearity": 1,
            "sequence": 1,
            "battr": [1, 3, 5, 6, 8, 9, 13],
            "pos": 7,
            "api": [7]
        },
        "pmp": {},
        "displaymanager": "unity sdk",
        "displaymanagerver": "4000",
        "instl": 1,
        "tagid": "com.example.enterprise-vast",
        "secure": 1
    }],
    "app": {
        "id": "1",
        "publisher": {
            "id": "12345"
        }
    },
    "device": {
        "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E302",
        "geo": {
            "lat": 55.5555,
            "lon": 11.1111,
            "type": 2,
            "country": "DNK",
            "region": "84",
            "metro": "0",
            "city": "Copenhagen",
            "utcoffset": 60
        },
        "ip": "111.222.111.222",
        "devicetype": 4,
        "model": "iPhone10,1",
        "os": "ios",
        "osv": "11.3.1",
        "hwv": "iPhone10,1",
        "h": 647,
        "w": 375,
        "language": "en",
        "carrier": "Sprint",
        "connectiontype": 2,
        "ifa": "A123456B-7C89-01D2-3456-E7F890123GH4"
    },
    "at": 1,
    "tmax": 500,
    "source": {
        "pchain": "11111:12345",
        "omidpn": "Unity3d",
        "omidpv": "1.3.0"
    },
    "regs": {
        "ext": {}
    },
    "ext": {
        "placementType": "",
        "gameCategory": "Games",
        "subGameCategory": "Casual",
        "sessionDepth": 0
    }
}

Open Measurement extensions#

Open Measurement extensions