application.schema.json

{
    "meta:license": [
        "Copyright 2018 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/application",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Application",
    "type": "object",
    "description": "Details related to the application generated interactions. Application refers to a software experience, such as a mobile or desktop application that can be installed, run, closed, or uninstalled by an end user. Details are not intended to describe agents such as chatbots, browser-based plugins, or other experiences that do not apply to applications.",
    "meta:extensible": true,
    "definitions": {
        "application": {
            "properties": {
                "xdm:applicationCloses": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Graceful termination of an application.",
                    "meta:descriptionId": "application##xdm:applicationCloses##description##26811"
                },
                "xdm:crashes": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Triggered when the application does not exit gracefully. Event is sent on application launch after a crash.",
                    "meta:descriptionId": "application##xdm:crashes##description##70691"
                },
                "xdm:featureUsages": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Activation of an application feature that is being measured.",
                    "meta:descriptionId": "application##xdm:featureUsages##description##55561"
                },
                "xdm:installs": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Install of an application on a device where the specific install event is available.",
                    "meta:descriptionId": "application##xdm:installs##description##34431"
                },
                "xdm:firstLaunches": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Triggered on first launch after install.",
                    "meta:descriptionId": "application##xdm:firstLaunches##description##62371"
                },
                "xdm:launches": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "Launch of an application. Triggered on every run, including crashes and installs. Also triggered on a resume from background when the session timeout has been exceeded.",
                    "meta:descriptionId": "application##xdm:launches##description##63161"
                },
                "xdm:upgrades": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "meta:descriptionId": "application##xdm:upgrades##description##30911",
                    "description": "Upgrade of an application that has previously been installed. Triggered on first launch after upgrade."
                }
            }
        },
        "identifier": {
            "properties": {
                "xdm:id": {
                    "title": "Application Identifier",
                    "type": "string",
                    "description": "Identifier of the application.",
                    "meta:titleId": "application##xdm:id##title##361",
                    "meta:descriptionId": "application##xdm:id##description##26071"
                }
            }
        },
        "name": {
            "properties": {
                "xdm:name": {
                    "title": "Name",
                    "type": "string",
                    "description": "Name of the application.",
                    "meta:titleId": "application##xdm:name##title##64771",
                    "meta:descriptionId": "application##xdm:name##description##41941"
                }
            }
        },
        "version": {
            "properties": {
                "xdm:version": {
                    "title": "Version",
                    "type": "string",
                    "description": "Version of the application.",
                    "meta:titleId": "application##xdm:version##title##57861",
                    "meta:descriptionId": "application##xdm:version##description##76111"
                }
            }
        },
        "close-properties": {
            "properties": {
                "xdm:isClose": {
                    "title": "Is Close",
                    "type": "boolean",
                    "description": "Close of an application.",
                    "meta:titleId": "application##xdm:isClose##title##38721",
                    "meta:descriptionId": "application##xdm:isClose##description##28741"
                },
                "xdm:closeType": {
                    "title": "Close Type",
                    "type": "string",
                    "description": "Type of application close, sent on application isClose. Type is 'close' on graceful termination of an application, or 'unknown' when application termination source is unknown.",
                    "enum": [
                        "close",
                        "unknown"
                    ],
                    "meta:enum": {
                        "close": "Close",
                        "unknown": "Unknown"
                    },
                    "meta:titleId": "application##xdm:closeType##title##15961",
                    "meta:descriptionId": "application##xdm:closeType##description##55241"
                }
            }
        },
        "islaunch": {
            "properties": {
                "xdm:isLaunch": {
                    "title": "Is Launch",
                    "type": "boolean",
                    "description": "Launch of an application.",
                    "meta:titleId": "application##xdm:isLaunch##title##41181",
                    "meta:descriptionId": "application##xdm:isLaunch##description##80981"
                }
            }
        },
        "isinstall": {
            "properties": {
                "xdm:isInstall": {
                    "title": "Is Install",
                    "type": "boolean",
                    "description": "Install of an application.",
                    "meta:titleId": "application##xdm:isInstall##title##85691",
                    "meta:descriptionId": "application##xdm:isInstall##description##36641"
                }
            }
        },
        "isupgrade": {
            "properties": {
                "xdm:isUpgrade": {
                    "title": "Is Upgrade",
                    "type": "boolean",
                    "description": "Upgrade of an application.",
                    "meta:titleId": "application##xdm:isUpgrade##title##621",
                    "meta:descriptionId": "application##xdm:isUpgrade##description##88461"
                }
            }
        },
        "sessionlength": {
            "properties": {
                "xdm:sessionLength": {
                    "title": "Session Length",
                    "type": "integer",
                    "minimum": 0,
                    "description": "Length of the application session in seconds. Usually referred as the time the application was in foreground.",
                    "meta:titleId": "application##xdm:sessionLength##title##71421",
                    "meta:descriptionId": "application##xdm:sessionLength##description##20131"
                }
            }
        },
        "userperspective": {
            "properties": {
                "xdm:userPerspective": {
                    "title": "User Perspective",
                    "type": "string",
                    "description": "The perspective/physical relationship between the user and the app/brand at the time the event happened.  The most common are the app being in the foreground with the user directly interacting with it vs the app being in the background and still generating events.  Detached means the event was related to the app but didn't come directly from the app like the sending of an email or push notification from an external system.  Understanding the perspective of the user in relation to the app helps with accuratly generating sessions as the majority of the time you will not want to include background and detached events as part of an active session.",
                    "enum": [
                        "foreground",
                        "background",
                        "detached"
                    ],
                    "meta:enum": {
                        "foreground": "Foreground",
                        "background": "Background",
                        "detached": "Detached"
                    },
                    "meta:descriptionId": "application##xdm:userPerspective##description##46671",
                    "meta:titleId": "application##xdm:userPerspective##title##35971"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/application"
        },
        {
            "$ref": "#/definitions/identifier"
        },
        {
            "$ref": "#/definitions/name"
        },
        {
            "$ref": "#/definitions/version"
        },
        {
            "$ref": "#/definitions/close-properties"
        },
        {
            "$ref": "#/definitions/islaunch"
        },
        {
            "$ref": "#/definitions/isinstall"
        },
        {
            "$ref": "#/definitions/isupgrade"
        },
        {
            "$ref": "#/definitions/sessionlength"
        },
        {
            "$ref": "#/definitions/userperspective"
        }
    ],
    "meta:status": "stable",
    "meta:createdDate": "2020-08-10",
    "meta:titleId": "application##title##16871",
    "meta:descriptionId": "application##description##2701",
    "examples": [
        {
            "xdm:id": "A123",
            "xdm:name": "Myapp",
            "xdm:version": "1.0.1",
            "xdm:isLaunch": true,
            "xdm:userPerspective": "foreground"
        },
        {
            "xdm:id": "A123",
            "xdm:name": "Myapp",
            "xdm:version": "1.0.1"
        },
        {
            "xdm:id": "A123",
            "xdm:name": "Myapp",
            "xdm:version": "1.0.1",
            "xdm:isClose": true,
            "xdm:closeType": "close",
            "xdm:sessionlength": 5030
        }
    ]
}