Consumer Experience Event Schema

https://ns.adobe.com/xdm/context/experienceevent-consumer

Digital content consumption data from web and mobile applications as well as online and offline purchase data such as channel, commerce, and device information.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Stable	No	Forbidden	Permitted	fieldgroups/experience-event/experienceevent-consumer.schema.json

Schema Hierarchy

Consumer Experience Event https://ns.adobe.com/xdm/context/experienceevent-consumer
- Application Details https://ns.adobe.com/xdm/context/experienceevent-application
- Channel Details https://ns.adobe.com/xdm/context/experienceevent-channel
- Environment Details https://ns.adobe.com/xdm/context/experienceevent-environment-details
- Campaign Marketing Details https://ns.adobe.com/xdm/context/experienceevent-marketing
- Media Interaction Details https://ns.adobe.com/xdm/context/experienceevent-media
- Search Details https://ns.adobe.com/xdm/context/experienceevent-search
- Segment Membership Details https://ns.adobe.com/xdm/context/experienceevent-segmentmembership
- Technical Details https://ns.adobe.com/xdm/context/experienceevent-technical-details
- Web Details https://ns.adobe.com/xdm/context/experienceevent-web
- Commerce Details https://ns.adobe.com/xdm/context/experienceevent-commerce

Consumer Experience Event Example

{
  "@id": "https://data.adobe.io/experienceid-123456",
  "xdm:dataSource": {
    "@id": "https://data.adobe.io/datasources/datasource-123",
    "xdm:code": "DataSourceIntegrationCode-123"
  },
  "xdm:timestamp": "2017-09-26T15:52:25+00:00",
  "xdm:identityMap": {
    "ECID": [
      {
        "id": "68519882713298129995549973016107434638",
        "primary": true
      }
    ],
    "AVID": [
      {
        "id": "2dfb7d8e00003ba4-056de00000000085",
        "primary": false
      }
    ]
  },
  "xdm:channel": {
    "@id": "https://ns.adobe.com/xdm/channels/apns",
    "@type": "https://ns.adobe.com/xdm/channel-types/mobile"
  },
  "xdm:environment": {
    "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:connectionType": "cable"
  },
  "xdm:productListItems": [
    {
      "xdm:SKU": "1002352692",
      "xdm:lineItemId": "12345678",
      "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light",
      "xdm:currencyCode": "USD",
      "xdm:quantity": 1,
      "xdm:priceTotal": 159
    }
  ],
  "xdm:commerce": {
    "xdm:order": {
      "xdm:purchaseID": "a8g784hjq1mnp3",
      "xdm:purchaseOrderNumber": "123456",
      "xdm:payments": [
        {
          "xdm:transactionID": "transactid-a111",
          "xdm:paymentAmount": 59,
          "xdm:paymentType": "credit_card",
          "xdm:currencyCode": "USD"
        },
        {
          "xdm:transactionId": "transactid-a222",
          "xdm:paymentAmount": 100,
          "xdm:paymentType": "gift_card",
          "xdm:currencyCode": "USD"
        }
      ],
      "xdm:currencyCode": "USD",
      "xdm:priceTotal": 159
    },
    "xdm:purchases": {
      "xdm:value": 1
    }
  },
  "xdm:placeContext": {
    "xdm:localTime": "2017-09-26T15:52:25+13:00",
    "xdm:geo": {
      "@id": "https://data.adobe.io/entities/geo/tokyo",
      "xdm:countryCode": "JP",
      "xdm:stateProvince": "JP-13",
      "xdm:city": "Tōkyō",
      "xdm:postalCode": "141-0032",
      "schema:latitude": 35.6185,
      "schema:longitude": 139.73237
    }
  },
  "xdm:web": {
    "xdm:webPageDetails": {
      "xdm:siteSection": "Shopping Cart",
      "xdm:server": "example.com",
      "xdm:name": "Purchase Confirmation",
      "xdm:URL": "https://www.example.com/orderConf",
      "xdm:errorPage": false,
      "xdm:homePage": false,
      "xdm:pageViews": {
        "xdm:value": 1
      }
    },
    "xdm:webReferrer": {
      "xdm:URL": "https://www.example.com/checkout",
      "xdm:referrerType": "internal"
    }
  },
  "xdm:marketing": {
    "xdm:trackingCode": "marketingcampaign111"
  }
}

Consumer Experience Event Properties

Property	Type	Required	Defined by
xdm:application	Application	Optional	Application Details
xdm:channel	Experience Channel	Optional	Channel Details
xdm:commerce	Commerce	Optional	Commerce Details
xdm:dataSource	Data Source	Optional	Technical Details
xdm:device	Device	Optional	Environment Details
xdm:environment	Environment	Optional	Environment Details
xdm:marketing	Marketing	Optional	Campaign Marketing Details
xdm:media	Media information	Optional	Media Interaction Details
xdm:placeContext	Place context	Optional	Environment Details
xdm:productListItems	Product list item	Optional	Commerce Details
xdm:receivedTimestamp	`string`	Optional	Technical Details
xdm:search	Search	Optional	Search Details
xdm:segmentMembership	`object`	Optional	Segment Membership Details
xdm:segmentMemberships	Segment membership item	Optional	Segment Membership Details
xdm:web	Web information	Optional	Web Details
`*`	any	Additional	this schema allows additional properties

xdm:application

Application

This fieldgroup is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login.

xdm:application

is optional
type: Application
defined in Application Details

xdm:application Type

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

xdm:channel

Experience channel

Experience channel related to the ExperienceEvent.

xdm:channel

is optional
type: Experience Channel
defined in Channel Details

xdm:channel Type

Experience Channel – https://ns.adobe.com/xdm/channels/channel

xdm:commerce

Commerce

Product returns, warranty registration, and shopping cart/order process.

xdm:commerce

is optional
type: Commerce
defined in Commerce Details

xdm:commerce Type

Commerce – https://ns.adobe.com/xdm/context/commerce

xdm:dataSource

Data source

Globally unique identification of a data source.

xdm:dataSource

is optional
type: Data Source
defined in Technical Details

xdm:dataSource Type

Data Source – https://ns.adobe.com/xdm/data/datasource

xdm:device

Device

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

xdm:device

is optional
type: Device
defined in Environment Details

xdm:device Type

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

xdm:environment

Environment

Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions.

xdm:environment

is optional
type: Environment
defined in Environment Details

xdm:environment Type

Environment – https://ns.adobe.com/xdm/context/environment

xdm:marketing

Marketing

Tracks offer impression and social network interactions.

xdm:marketing

is optional
type: Marketing
defined in Campaign Marketing Details

xdm:marketing Type

Marketing – https://ns.adobe.com/xdm/context/marketing

xdm:media

Media

Media activity information related to the experience event.

xdm:media

is optional
type: Media information
defined in Media Interaction Details

xdm:media Type

Media information – https://ns.adobe.com/xdm/context/media

xdm:placeContext

Place context

The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours.

xdm:placeContext

is optional
type: Place context
defined in Environment Details

xdm:placeContext Type

Place context – https://ns.adobe.com/xdm/context/placecontext

xdm:productListItems

Product list items

A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record.

xdm:productListItems

is optional
type: Product list item
defined in Commerce Details

xdm:productListItems Type

Array type: Product list item

All items must be of the type:

Product list item – https://ns.adobe.com/xdm/content/productlistitem

xdm:receivedTimestamp

Received time stamp

The time at which this interaction was received by a server.

xdm:receivedTimestamp

is optional
type: string
defined in Technical Details

xdm:receivedTimestamp Type

string

format: date-time – date and time (according to RFC 3339, section 5.6)

xdm:search

Search

The information related to web or mobile search.

xdm:search

is optional
type: Search
defined in Search Details

xdm:search Type

Search – https://ns.adobe.com/xdm/context/search

xdm:segmentMembership

Segment Membership Map

xdm:segmentMembership

is optional
type: object
defined in Segment Membership Details

xdm:segmentMembership Type

object with following properties:

Property	Type	Required

xdm:segmentMemberships

Segment Memberships

The segments associated with this ExperienceEvent. Deprecated, use xdm:segmentMembership instead.

xdm:segmentMemberships

is optional
type: Segment membership item
defined in Segment Membership Details

xdm:segmentMemberships Type

Array type: Segment membership item