Skip to content

Latest commit

 

History

History
356 lines (200 loc) · 7.54 KB

device.schema.md

File metadata and controls

356 lines (200 loc) · 7.54 KB
Raw

Device Schema

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

An identified device that is an application or browser instance that is trackable across sessions, normally by cookies.

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

Schema Hierarchy

Device Example

{
  "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"
}

Device Properties

Property Type Required Defined by
xdm:colorDepth integer Optional Device (this schema)
xdm:isBackgroundPushEnabled boolean Optional Device (this schema)
xdm:isLocationEnabled boolean Optional Device (this schema)
xdm:isPushOptIn boolean Optional Device (this schema)
xdm:locationPermission enum Optional Device (this schema)
xdm:manufacturer string Optional Device (this schema)
xdm:model string Optional Device (this schema)
xdm:modelNumber string Optional Device (this schema)
xdm:screenHeight integer Optional Device (this schema)
xdm:screenOrientation enum Optional Device (this schema)
xdm:screenWidth integer Optional Device (this schema)
xdm:type string Optional Device (this schema)
xdm:typeID string Optional Device (this schema)
xdm:typeIDService string Optional Device (this schema)
* any Additional this schema allows additional properties

xdm:colorDepth

Color depth

The number of colors the display is able to represent.

xdm:colorDepth

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

xdm:colorDepth Type

integer

xdm:isBackgroundPushEnabled

Background Push Enabled Flag

For devices like mobile , this tracks the system background push enabled permision status.

xdm:isBackgroundPushEnabled

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

xdm:isBackgroundPushEnabled Type

boolean

xdm:isLocationEnabled

Location Enabled Flag

Indicates whether or not the device has location services enabled.

xdm:isLocationEnabled

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

xdm:isLocationEnabled Type

boolean

xdm:isPushOptIn

Push Opt In Flag

Indicates whether or not the device opted-in to receive push notifications.

xdm:isPushOptIn

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

xdm:isPushOptIn Type

boolean

xdm:locationPermission

Location Permission

Tracks the device location permision attribute setting.

xdm:locationPermission

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

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

xdm:locationPermission Known Values

Value Description
SYSTEM_LOCATION_DISABLED System Location Disabled
NOT_ALLOWED Not Allowed
ALWAYS_ALLOWED Always Allowed
FOREGROUND_ALLOWED Foreground Allowed
UNPROMPTED Unprompted

xdm:manufacturer

Manufacturer

The name of the organization who owns the design and creation of the device, for example, 'Apple' is the manufacturer of the iPhone.

xdm:manufacturer

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

xdm:manufacturer Type

string

xdm:model

Model

The name of the model for the device. This is the common, human-readable, or marketing name for the device. For example, the 'iPhone 6S' is a particular model of mobile phone.

xdm:model

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

xdm:model Type

string

xdm:modelNumber

Model number

The unique model number designation assigned by the manufacturer for this device. Model numbers are not versions, but unique identifiers that identify a particular model configuration. While the model for a particular phone might be 'iPhone 6S' the model number would be 'A1633', or 'A1634' based on configuration at the time of sale.

xdm:modelNumber

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

xdm:modelNumber Type

string

xdm:screenHeight

Screen height

The number of vertical pixels of the device's active display in the default orientation.

xdm:screenHeight

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

xdm:screenHeight Type

integer

xdm:screenOrientation

Screen orientation

The current screen orientation such as "portrait" or "landscape".

xdm:screenOrientation

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

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

xdm:screenOrientation Known Values

Value Description
portrait Portrait
landscape Landscape

xdm:screenWidth

Screen width

The number of horizontal pixels of the device's active display in the default orientation.

xdm:screenWidth

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

xdm:screenWidth Type

integer

xdm:type

Type

Type of device being tracked.

xdm:type

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

xdm:type Type

string

xdm:type Known Values

Value Description
mobile Mobile
tablet Tablet
desktop Desktop
ereader E-reader
gaming Gaming console
television Television
settop Set-top box
mediaplayer Media player
computers Computers
tv screens TV screens

xdm:typeID

Type identifier

An identifier for the device. This may be an identifier from 'DeviceAtlas' or another service that identifies the hardware that is being used.

xdm:typeID

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

xdm:typeID Type

string

xdm:typeIDService

Type identifier service

The namespace of the service that is used to identify the device type.

xdm:typeIDService

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

xdm:typeIDService Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:typeIDService Known Values

Value Description
https://ns.adobe.com/xdm/external/deviceatlas DeviceAtlas
https://ns.adobe.com/xdm/external/adobecampaign Adobe Campaign