environment.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/environment",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Environment",
    "type": "object",
    "meta:extensible": true,
    "description": "Information about the surrounding situation the event observation occurred, specifically detailing transitory information such as the network or software versions. IMPORTANT: All values should be aligned with the [DeviceAtlas](https://deviceatlas.com) database licensed by Adobe. ",
    "definitions": {
        "type": {
            "properties": {
                "xdm:type": {
                    "title": "Type",
                    "type": "string",
                    "description": "The type of the application environment.",
                    "enum": [
                        "browser",
                        "application",
                        "iot",
                        "external",
                        "widget"
                    ],
                    "meta:enum": {
                        "browser": "Browser",
                        "application": "Application",
                        "iot": "Internet of things",
                        "external": "External system",
                        "widget": "Application extension"
                    },
                    "meta:titleId": "environment##xdm:type##title##45711",
                    "meta:descriptionId": "environment##xdm:type##description##26511"
                }
            }
        },
        "browserdetails": {
            "properties": {
                "xdm:browserDetails": {
                    "title": "Browser details",
                    "$ref": "https://ns.adobe.com/xdm/context/browserdetails",
                    "description": "The browser specific details such as browser name, version, javascript version, user agent string, and accept language.",
                    "meta:titleId": "environment##xdm:browserDetails##title##87231",
                    "meta:descriptionId": "environment##xdm:browserDetails##description##88151"
                }
            }
        },
        "os-properties": {
            "properties": {
                "xdm:operatingSystem": {
                    "title": "Operating system",
                    "type": "string",
                    "description": "The name of the operating system used when the observation was made. The attribute should not contain any version information such as '10.5.3', but instead contain 'edition' designations such as 'Ultimate' or 'Professional'.",
                    "meta:titleId": "environment##xdm:operatingSystem##title##5821",
                    "meta:descriptionId": "environment##xdm:operatingSystem##description##92111"
                },
                "xdm:operatingSystemVersion": {
                    "title": "Operating system version",
                    "type": "string",
                    "description": "The full version identifier for the operating system used when the observation was made. Versions are generally numerically composed but may be in a vendor defined format.",
                    "meta:titleId": "environment##xdm:operatingSystemVersion##title##55521",
                    "meta:descriptionId": "environment##xdm:operatingSystemVersion##description##13541"
                },
                "xdm:operatingSystemVendor": {
                    "title": "Operating system vendor",
                    "type": "string",
                    "description": "The name of the operating system vendor used when the observation was made.",
                    "meta:titleId": "environment##xdm:operatingSystemVendor##title##2141",
                    "meta:descriptionId": "environment##xdm:operatingSystemVendor##description##55711"
                }
            }
        },
        "colordepth": {
            "properties": {
                "xdm:colorDepth": {
                    "title": "Color depth",
                    "type": "integer",
                    "description": "The number of bits used for each color component of a single pixel.",
                    "minimum": 0,
                    "meta:titleId": "environment##xdm:colorDepth##title##50921",
                    "meta:descriptionId": "environment##xdm:colorDepth##description##68521"
                }
            }
        },
        "viewport-properties": {
            "properties": {
                "xdm:viewportHeight": {
                    "title": "Viewport height",
                    "type": "integer",
                    "description": "The vertical size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport height.",
                    "minimum": 0,
                    "meta:titleId": "environment##xdm:viewportHeight##title##15331",
                    "meta:descriptionId": "environment##xdm:viewportHeight##description##82791"
                },
                "xdm:viewportWidth": {
                    "title": "Viewport width",
                    "type": "integer",
                    "description": "The horizontal size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport width.",
                    "minimum": 0,
                    "meta:titleId": "environment##xdm:viewportWidth##title##13801",
                    "meta:descriptionId": "environment##xdm:viewportWidth##description##33071"
                }
            }
        },
        "screen-properties": {
            "properties": {
                "xdm:duration": {
                    "title": "Duration",
                    "type": "integer",
                    "description": "The number of milliseconds that the user was on the screen.",
                    "minimum": 0,
                    "meta:titleId": "environment##xdm:duration##title##5391",
                    "meta:descriptionId": "environment##xdm:duration##description##76571"
                },
                "xdm:viewedScreen": {
                    "title": "Viewed Screen",
                    "type": "string",
                    "description": "The friendly name assigned to the screen that the user was on.",
                    "meta:titleId": "environment##xdm:viewedScreen##title##62701",
                    "meta:descriptionId": "environment##xdm:viewedScreen##description##36461"
                },
                "xdm:previousScreen": {
                    "title": "Previous Screen",
                    "type": "string",
                    "description": "The frinedly name assigned to the screen the user was on prior to the viewedScreen.",
                    "meta:titleId": "environment##xdm:previousScreen##title##46381",
                    "meta:descriptionId": "environment##xdm:previousScreen##description##28811"
                }
            }
        },
        "connectiontype": {
            "properties": {
                "xdm:connectionType": {
                    "title": "Connection type",
                    "type": "string",
                    "description": "Internet connection type.",
                    "enum": [
                        "dialup",
                        "isdn",
                        "bisdn",
                        "dsl",
                        "cable",
                        "wireless_wifi",
                        "mobile",
                        "mobile_edge",
                        "mobile_gprs",
                        "mobile_2g",
                        "mobile_3g",
                        "mobile_lte",
                        "t1",
                        "t3",
                        "oc3",
                        "lan",
                        "modem"
                    ],
                    "meta:enum": {
                        "dialup": "Dial-up",
                        "isdn": "ISDN",
                        "bisdn": "BISDN",
                        "dsl": "DSL",
                        "cable": "Cable",
                        "wireless_wifi": "Wireless wifi",
                        "mobile": "Mobile",
                        "mobile_edge": "Mobile Edge",
                        "mobile_gprs": "Mobile GPRS",
                        "mobile_2g": "Mobile 2G",
                        "mobile_3g": "Mobile 3G",
                        "mobile_lte": "Mobile LTE",
                        "t1": "T1",
                        "t3": "T3",
                        "oc3": "OC3",
                        "lan": "LAN",
                        "modem": "Modem"
                    },
                    "meta:titleId": "environment##xdm:connectionType##title##5651",
                    "meta:descriptionId": "environment##xdm:connectionType##description##11031"
                }
            }
        },
        "carrier": {
            "properties": {
                "xdm:carrier": {
                    "title": "Mobile network carrier",
                    "type": "string",
                    "description": "A mobile network carrier or MNO, also known as a wireless service provider, wireless carrier, cellular company, or mobile network carrier, is a provider of services wireless communications that owns or controls all the elements necessary to sell and deliver services to an end user.",
                    "meta:titleId": "environment##xdm:carrier##title##16671",
                    "meta:descriptionId": "environment##xdm:carrier##description##45391"
                }
            }
        },
        "isp-properties": {
            "properties": {
                "xdm:domain": {
                    "title": "Domain",
                    "type": "string",
                    "description": "The domain of the users ISP.",
                    "meta:titleId": "environment##xdm:domain##title##10311",
                    "meta:descriptionId": "environment##xdm:domain##description##57231"
                },
                "xdm:ISP": {
                    "title": "Internet service provider",
                    "type": "string",
                    "description": "The name of the user's internet service provider.",
                    "meta:titleId": "environment##xdm:ISP##title##84271",
                    "meta:descriptionId": "environment##xdm:ISP##description##41681"
                }
            }
        },
        "language": {
            "properties": {
                "dc:language": {
                    "meta:usereditable": false,
                    "title": "Language",
                    "type": "string",
                    "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$",
                    "description": "The language of the environment to represent the user's linguistic, geographical, or cultural preferences for data presentation.\nLanguages are specified in language code as defined in [IETF RFC 3066](https://www.ietf.org/rfc/rfc3066.txt), which is part of BCP 47, which is used elsewhere in XDM.",
                    "examples": [
                        "en-US",
                        "pt-BR",
                        "es-ES"
                    ],
                    "meta:titleId": "environment##dc:language##title##85111",
                    "meta:descriptionId": "environment##dc:language##description##68251"
                }
            }
        },
        "ipv4": {
            "properties": {
                "xdm:ipV4": {
                    "title": "IPv4",
                    "type": "string",
                    "format": "ipv4",
                    "description": "The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. ",
                    "meta:titleId": "environment##xdm:ipV4##title##40491",
                    "meta:descriptionId": "environment##xdm:ipV4##description##90631"
                }
            }
        },
        "ipv6": {
            "properties": {
                "xdm:ipV6": {
                    "title": "IPv6",
                    "type": "string",
                    "format": "ipv6",
                    "description": "The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. ",
                    "meta:titleId": "environment##xdm:ipV6##title##92181",
                    "meta:descriptionId": "environment##xdm:ipV6##description##94051"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/type"
        },
        {
            "$ref": "#/definitions/browserdetails"
        },
        {
            "$ref": "#/definitions/os-properties"
        },
        {
            "$ref": "#/definitions/colordepth"
        },
        {
            "$ref": "#/definitions/viewport-properties"
        },
        {
            "$ref": "#/definitions/screen-properties"
        },
        {
            "$ref": "#/definitions/connectiontype"
        },
        {
            "$ref": "#/definitions/carrier"
        },
        {
            "$ref": "#/definitions/isp-properties"
        },
        {
            "$ref": "#/definitions/language"
        },
        {
            "$ref": "#/definitions/ipv4"
        },
        {
            "$ref": "#/definitions/ipv6"
        }
    ],
    "meta:status": "stable",
    "meta:createdDate": "2020-08-10",
    "meta:titleId": "environment##title##23541",
    "meta:descriptionId": "environment##description##90601",
    "examples": [
        {
            "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:operatingSystemVendor": "Apple",
            "xdm:connectionType": "cable",
            "xdm:domain": "verizon.com",
            "xdm:ISP": "Verizon"
        }
    ]
}