experienceevent-environment-details.schema.json

{
    "meta:license": [
        "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/xdm/context/experienceevent-environment-details",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Environment Details",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:tags": {
        "industry": [
            "all"
        ]
    },
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/experienceevent"
    ],
    "description": "Environment details such as device details, browser info, local time, and other geographical information.",
    "definitions": {
        "experienceevent-environment-details": {
            "properties": {
                "xdm:environment": {
                    "title": "Environment",
                    "$ref": "https://ns.adobe.com/xdm/context/environment",
                    "description": "Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions."
                },
                "xdm:device": {
                    "title": "Device",
                    "$ref": "https://ns.adobe.com/xdm/context/device",
                    "description": "An identified device, application or device browser instance that is trackable across sessions, normally by cookies."
                },
                "xdm:placeContext": {
                    "title": "Place context",
                    "$ref": "https://ns.adobe.com/xdm/context/placecontext",
                    "description": "The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours."
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/experienceevent-environment-details"
        }
    ],
    "meta:status": "stable",
    "examples": [
        {
            "xdm:environment": {
                "xdm:type": "browser",
                "xdm:browserDetails": {
                    "xdm:name": "Chrome",
                    "xdm:version": "63.0.3239",
                    "xdm:acceptLanguage": "en",
                    "xdm:cookiesEnabled": true,
                    "xdm:javaScriptEnabled": true,
                    "xdm:javaScriptVersion": "1.8.5",
                    "xdm:javaEnabled": true,
                    "xdm:javaVersion": "Java SE 8",
                    "xdm:viewportHeight": 900,
                    "xdm:viewportWidth": 1680
                },
                "xdm:operatingSystem": "MAC OS",
                "xdm:operatingSystemVersion": "10.13",
                "xdm:connectionType": "cable"
            },
            "xdm:device": {
                "xdm:typeID": "TypeIdentifier-111",
                "xdm:typeIDService": "https://ns.adobe.com/xdm/external/deviceatlas",
                "xdm:type": "mobile",
                "xdm:manufacturer": "Apple",
                "xdm:model": "iPhone 6",
                "xdm:modelNumber": "A1586",
                "xdm:screenHeight": 667,
                "xdm:screenWidth": 375,
                "xdm:colorDepth": 16777216,
                "xdm:screenOrientation": "portrait"
            },
            "xdm:placeContext": {
                "xdm:localTime": "2017-09-26T15:52:25+13:00",
                "xdm:geo": {
                    "@id": "https://data.adobe.io/entities/geo/tokyo",
                    "xdm:countryCode": "JP",
                    "xdm:stateProvince": "JP-13",
                    "xdm:city": "Tōkyō",
                    "xdm:postalCode": "141-0032",
                    "schema:latitude": 35.6185,
                    "schema:longitude": 139.73237
                }
            }
        }
    ]
}