Skip to content

Latest commit

 

History

History
686 lines (356 loc) · 24.4 KB

target-experienceevent.schema.md

File metadata and controls

686 lines (356 loc) · 24.4 KB

Adobe Target ExperienceEvent Template Schema

https://ns.adobe.com/experience/target-experienceevent

Target ExperienceEvent field group for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the required Adobe Target ExperienceEvent field groups.

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

Schema Hierarchy

Adobe Target ExperienceEvent Template 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
      }
    ]
  },
  "https://ns.adobe.com/experience/target/clientcode": "773baa41-4afd-4c4e-9178-1547f58e07bd",
  "https://ns.adobe.com/experience/target/mboxname": "orderConfirmPage",
  "https://ns.adobe.com/experience/target/mboxversion": "v60",
  "https://ns.adobe.com/experience/target/sessionid": "94ef199f-85e6-4e33-9a58-0e4162486714",
  "https://ns.adobe.com/experience/target/pagedetail/pageid": "http://data.adobe.com/experience/target/pagedetail/pageid/b1ba48aa-291f-4f94-bc65-a260150648a1",
  "https://ns.adobe.com/experience/target/pagedetail/pagescore": 100
}

Adobe Target ExperienceEvent Template Properties

Property Type Required Defined by
https://ns.adobe.com/experience/implementations Adobe Experience Platform Implementation Details Optional Adobe Experience Platform Implementation Details
https://ns.adobe.com/experience/profile/originDatasetID string Optional Adobe Unified Profile Service ExperienceEvent Shared Extension
https://ns.adobe.com/experience/target/activities Adobe Target Activity Optional Adobe Target ExperienceEvent Full Extension
https://ns.adobe.com/experience/target/clientcode string Optional Adobe Target ExperienceEvent Full Extension
https://ns.adobe.com/experience/target/environmentID string Optional Adobe Target ExperienceEvent Full Extension
https://ns.adobe.com/experience/target/mboxname string Optional Adobe Target ExperienceEvent Full Extension
https://ns.adobe.com/experience/target/mboxversion string Optional Adobe Target ExperienceEvent Full Extension
https://ns.adobe.com/experience/target/pagedetail/pageid string Optional Adobe Target ExperienceEvent Full Extension
https://ns.adobe.com/experience/target/pagedetail/pagescore number Optional Adobe Target ExperienceEvent Full Extension
https://ns.adobe.com/experience/target/sessionid string Optional Adobe Target ExperienceEvent Full Extension
xdm:advertising Advertising Optional Advertising Details
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:directMarketing Direct marketing Optional Direct Marketing Details
xdm:endUserIDs End user IDs Optional End User ID 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:profileStitch Profile stitch Optional Profile Stitch 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

https://ns.adobe.com/experience/implementations

Origin Dataset ID

Identity of the dataset that the Unified Profile Service ingested the data from. Usage is reserved for the Unified Profile Service.

https://ns.adobe.com/experience/profile/originDatasetID

string

Activities

A list of items representing executed activities.

https://ns.adobe.com/experience/target/activities

Array type: Adobe Target Activity

All items must be of the type:

Adobe Target Client Code

Adobe Target client code.

https://ns.adobe.com/experience/target/clientcode

string

Environment Identifier

Identifier of the environment on which the event was processed.

https://ns.adobe.com/experience/target/environmentID

string

Adobe Target Mbox Name

Adobe Target mbox name.

https://ns.adobe.com/experience/target/mboxname

string

Adobe Target Mbox Version

Adobe Target mbox version.

https://ns.adobe.com/experience/target/mboxversion

string

Target Unique Page Identifier

Target generated page identifier for current event.

https://ns.adobe.com/experience/target/pagedetail/pageid

string

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

Page Score

Customer assigned score to visited page.

https://ns.adobe.com/experience/target/pagedetail/pagescore

number

Adobe Target Session Identifier

Adobe Target session identifier.

https://ns.adobe.com/experience/target/sessionid

string

xdm:advertising

Advertising

Information related to advertising impressions, clickthroughs, and attribution.

xdm:advertising

xdm:advertising Type

  • Advertisinghttps://ns.adobe.com/xdm/context/advertising

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

xdm:application Type

  • Applicationhttps://ns.adobe.com/xdm/context/application

xdm:channel

Experience channel

Experience channel related to the ExperienceEvent.

xdm:channel

xdm:channel Type

xdm:commerce

Commerce

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

xdm:commerce

xdm:commerce Type

  • Commercehttps://ns.adobe.com/xdm/context/commerce

xdm:dataSource

Data source

Globally unique identification of a data source.

xdm:dataSource

xdm:dataSource Type

  • Data Sourcehttps://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

xdm:device Type

  • Devicehttps://ns.adobe.com/xdm/context/device

xdm:directMarketing

Direct marketing

Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications.

xdm:directMarketing

xdm:directMarketing Type

xdm:endUserIDs

EndUserIDs

Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent.

xdm:endUserIDs

xdm:endUserIDs Type

  • End user IDshttps://ns.adobe.com/xdm/context/enduserids

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

xdm:environment Type

  • Environmenthttps://ns.adobe.com/xdm/context/environment

xdm:marketing

Marketing

Tracks offer impression and social network interactions.

xdm:marketing

xdm:marketing Type

  • Marketinghttps://ns.adobe.com/xdm/context/marketing

xdm:media

Media

Media activity information related to the experience event.

xdm:media

xdm:media Type

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

xdm:placeContext Type

  • Place contexthttps://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

xdm:productListItems Type

Array type: Product list item

All items must be of the type:

xdm:profileStitch

Profile stitch

Details about the IDs that were joined by profile stitching.

xdm:profileStitch

xdm:profileStitch Type

Array type: Profile stitch

All items must be of the type:

xdm:receivedTimestamp

Received time stamp

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

xdm:receivedTimestamp

xdm:receivedTimestamp Type

string

xdm:search

Search

The information related to web or mobile search.

xdm:search

xdm:search Type

  • Searchhttps://ns.adobe.com/xdm/context/search

xdm:segmentMembership

Segment Membership Map

xdm:segmentMembership

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

xdm:segmentMemberships Type

Array type: Segment membership item

All items must be of the type:

xdm:web

Web

Link clicks, web page details, referrer information, and browser details.

xdm:web

  • is optional
  • type: Web information
  • defined in Web Details

xdm:web Type