Skip to content

Latest commit

 

History

History
399 lines (216 loc) · 8.25 KB

application.schema.md

File metadata and controls

399 lines (216 loc) · 8.25 KB
Raw

Application Schema

https://ns.adobe.com/xdm/context/application

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.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted datatypes/application.schema.json

Schema Hierarchy

  • Application https://ns.adobe.com/xdm/context/application

Application 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
}

Application Properties

Property Type Required Defined by
xdm:applicationCloses Measure Optional Application (this schema)
xdm:closeType enum Optional Application (this schema)
xdm:crashes Measure Optional Application (this schema)
xdm:featureUsages Measure Optional Application (this schema)
xdm:firstLaunches Measure Optional Application (this schema)
xdm:id string Optional Application (this schema)
xdm:installs Measure Optional Application (this schema)
xdm:isClose boolean Optional Application (this schema)
xdm:isInstall boolean Optional Application (this schema)
xdm:isLaunch boolean Optional Application (this schema)
xdm:isUpgrade boolean Optional Application (this schema)
xdm:launches Measure Optional Application (this schema)
xdm:name string Optional Application (this schema)
xdm:sessionLength integer Optional Application (this schema)
xdm:upgrades Measure Optional Application (this schema)
xdm:userPerspective enum Optional Application (this schema)
xdm:version string Optional Application (this schema)
* any Additional this schema allows additional properties

xdm:applicationCloses

Graceful termination of an application.

xdm:applicationCloses

  • is optional
  • type: Measure
  • defined in this schema

xdm:applicationCloses Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:closeType

Close Type

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.

xdm:closeType

  • is optional
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

xdm:closeType Known Values

Value Description
close Close
unknown Unknown

xdm:crashes

Triggered when the application does not exit gracefully. Event is sent on application launch after a crash.

xdm:crashes

  • is optional
  • type: Measure
  • defined in this schema

xdm:crashes Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:featureUsages

Activation of an application feature that is being measured.

xdm:featureUsages

  • is optional
  • type: Measure
  • defined in this schema

xdm:featureUsages Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:firstLaunches

Triggered on first launch after install.

xdm:firstLaunches

  • is optional
  • type: Measure
  • defined in this schema

xdm:firstLaunches Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:id

Application Identifier

Identifier of the application.

xdm:id

  • is optional
  • type: string
  • defined in this schema

xdm:id Type

string

xdm:installs

Install of an application on a device where the specific install event is available.

xdm:installs

  • is optional
  • type: Measure
  • defined in this schema

xdm:installs Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:isClose

Is Close

Close of an application.

xdm:isClose

  • is optional
  • type: boolean
  • defined in this schema

xdm:isClose Type

boolean

xdm:isInstall

Is Install

Install of an application.

xdm:isInstall

  • is optional
  • type: boolean
  • defined in this schema

xdm:isInstall Type

boolean

xdm:isLaunch

Is Launch

Launch of an application.

xdm:isLaunch

  • is optional
  • type: boolean
  • defined in this schema

xdm:isLaunch Type

boolean

xdm:isUpgrade

Is Upgrade

Upgrade of an application.

xdm:isUpgrade

  • is optional
  • type: boolean
  • defined in this schema

xdm:isUpgrade Type

boolean

xdm:launches

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.

xdm:launches

  • is optional
  • type: Measure
  • defined in this schema

xdm:launches Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:name

Name

Name of the application.

xdm:name

  • is optional
  • type: string
  • defined in this schema

xdm:name Type

string

xdm:sessionLength

Session Length

Length of the application session in seconds. Usually referred as the time the application was in foreground.

xdm:sessionLength

  • is optional
  • type: integer
  • defined in this schema

xdm:sessionLength Type

integer

  • minimum value: 0

xdm:upgrades

Upgrade of an application that has previously been installed. Triggered on first launch after upgrade.

xdm:upgrades

  • is optional
  • type: Measure
  • defined in this schema

xdm:upgrades Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:userPerspective

User Perspective

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.

xdm:userPerspective

  • is optional
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

xdm:userPerspective Known Values

Value Description
foreground Foreground
background Background
detached Detached

xdm:version

Version

Version of the application.

xdm:version

  • is optional
  • type: string
  • defined in this schema

xdm:version Type

string