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 in, 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": {
    "environment": {
      "properties": {
        "xdm:type": {
          "title": "Type",
          "type": "string",
          "description": "The type of the application environment.",
          "enum": ["browser", "application", "iot", "external"],
          "meta:enum": {
            "browser": "Browser",
            "application": "Application",
            "iot": "IoT",
            "external": "External System"
          }
        },
        "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, accept language."
        },
        "xdm:operatingSystem": {
          "title": "Operating System",
          "type": "string",
          "description":
            "The name of the operating system used when the observation was made. This attribute should not contain any version information i.e. 10.5.3, but can contain *edition* designations such as 'Ultimate', or 'Professional'."
        },
        "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."
        },
        "xdm:operatingSystemVendor": {
          "title": "Operating System Vendor",
          "type": "string",
          "description":
          "The name of the operating system vendor used when the observation was made."
        },
        "xdm:colorDepth": {
          "title": "Color Depth",
          "type": "integer",
          "description":
            "The number of bits used for each color component of a single pixel.",
          "minimum": 0
        },
        "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
        },
        "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
        },
        "xdm:connectionType": {
          "title": "Connection Type",
          "type": "string",
          "description": "Internet connection type.",
          "enum": [
            "dialup",
            "isdn",
            "bisdn",
            "dsl",
            "cable",
            "wireless_wifi",
            "mobile",
            "mobile_edge",
            "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"
          }
        },
        "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."
        },
        "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. "
        },
        "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. "
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/environment"
    }
  ],
  "meta:status": "stabilizing"
}