https://ns.adobe.com/experience/campaign-experienceevent
Campaign ExperienceEvent field group for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the required Adobe Campaign ExperienceEvent field groups.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In |
|---|---|---|---|---|---|---|
| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | adobe/experience/campaign-experienceevent.schema.json |
- Adobe Campaign ExperienceEvent Template
https://ns.adobe.com/experience/campaign-experienceevent- Extensibility base schema
https://ns.adobe.com/xdm/common/extensible - Advertising Details
https://ns.adobe.com/xdm/context/experienceevent-advertising - Application Details
https://ns.adobe.com/xdm/context/experienceevent-application - Channel Details
https://ns.adobe.com/xdm/context/experienceevent-channel - Commerce Details
https://ns.adobe.com/xdm/context/experienceevent-commerce - Direct Marketing Details
https://ns.adobe.com/xdm/context/experienceevent-directmarketing - 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 - Profile Stitch Details
https://ns.adobe.com/xdm/context/experienceevent-profile-stitch - 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 - Adobe Campaign ExperienceEvent Full Extension
https://ns.adobe.com/experience/campaign/experienceevent-all - Experience Event - Proposition Reference
https://ns.adobe.com/experience/decisioning/proposition - Adobe Target ExperienceEvent Shared Extension
https://ns.adobe.com/experience/target/experienceevent-shared - Adobe Unified Profile Service ExperienceEvent Shared Extension
https://ns.adobe.com/experience/profile/experienceevent-shared - Adobe Experience Platform Implementation Details
https://ns.adobe.com/experience/implementations-ext - End User ID Details
https://ns.adobe.com/xdm/context/experienceevent-enduserids
- Extensibility base schema
{
"@id": "https://data.adobe.io/experienceid-1234567",
"xdm:dataSource": {
"@id": "https://data.adobe.io/datasources/datasource-124",
"xdm:code": "DataSourceIntegrationCode-124"
},
"xdm:timestamp": "2017-09-26T15:52:25+00:00",
"xdm:identityMap": {
"ECID": [
{
"xdm:id": "68519882713298129995549973016107434638",
"xdm:primary": true
}
],
"CPGN": [
{
"xdm:id": "https://data.adobe.io/entities/identity/1234567",
"xdm:primary": true
}
]
},
"xdm:directMarketing": {
"xdm:sends": {
"xdm:value": 1
}
},
"xdm:channel": {
"@id": "https://ns.adobe.com/xdm/channels/email"
},
"https://ns.adobe.com/experience/campaign/message": {
"xdm:id": 10000,
"xdm:profile": {
"xdm:person": {
"xdm:birthMonth": 1,
"xdm:birthDay": 3,
"xdm:birthYear": 1996,
"xdm:gender": "female"
},
"xdm:workAddress": {
"@id": "https://ns.adobe.com/entities/address/123",
"xdm:primary": true,
"xdm:city": "San Jose",
"xdm:stateProvinceISO": "CA",
"xdm:postalCode": "95110",
"xdm:countryCode": "US"
},
"xdm:workEmail": {
"xdm:primary": true,
"xdm:address": "[email protected]"
}
},
"xdm:variant": "English",
"xdm:seedMember": false,
"xdm:quarantine": false,
"xdm:proofMember": false,
"xdm:controlGroupMember": false,
"xdm:testMember": true,
"xdm:size": 421,
"xdm:outboundIP": "10.20.30.40",
"xdm:externalID": "uuid:00112233-4455-6677-8899-AABBCCDDEEFF"
},
"https://ns.adobe.com/experience/campaign/delivery": {
"xdm:id": 1001,
"xdm:from": "[email protected]",
"xdm:testEnabled": true,
"xdm:messageClass": "continuous",
"xdm:templateID": 1000,
"xdm:deliveryName": "DM200",
"xdm:deliveryLabel": "Birthday Wishes"
},
"https://ns.adobe.com/experience/campaign/marketingCampaign": {
"xdm:id": 100,
"xdm:campaignName": "CAMP2010"
},
"https://ns.adobe.com/experience/campaign/orchestration": {
"xdm:eventID": "onJourneyEnter"
},
"https://ns.adobe.com/experience/campaign/containerID": "customer-stage",
"https://ns.adobe.com/experience/campaign/eventSource": "pipelined-mta"
}The identifier denoting the container with which Campaign ExperienceEvent is associated.
https://ns.adobe.com/experience/campaign/containerID
- is optional
- type:
string - defined in Adobe Campaign ExperienceEvent Full Extension
string
https://ns.adobe.com/experience/campaign/delivery
- is optional
- type:
object - defined in Adobe Campaign ExperienceEvent Full Extension
object with following properties:
| Property | Type | Required | Default |
|---|---|---|---|
xdm:deliveryLabel |
string | Optional | |
xdm:deliveryName |
string | Optional | |
xdm:from |
string | Optional | |
xdm:id |
integer | Optional | |
xdm:messageClass |
string | Optional | "one_time" |
xdm:templateID |
integer | Optional | |
xdm:templateName |
string | Optional | |
xdm:testEnabled |
boolean | Optional | false |
A human-friendly name of the campaign activity which is originating this message.
xdm:deliveryLabel
- is optional
- type:
string
string
A human-friendly identifier of the campaign activity which is originating this message.
xdm:deliveryName
- is optional
- type:
string
string
Address used as a from/sender/caller address. Depending on the communication channel, the address has a different format.
email: an email address.textMessageorphone: a shortcode or phone number.
xdm:from
- is optional
- type:
string
string
The campaign activity originating this message.
xdm:id
- is optional
- type:
integer
integer
Mode of delivery for the messages sent.
xdm:messageClass
- is optional
- type:
string - default:
"one_time"
string
| Value | Description |
|---|---|
one_time |
Marketing (One Time) |
continuous |
Recurring |
event_based |
Transactional (Event-based) |
The delivery template's ID used to initialize this delivery.
The type the template used in Adobe Campaign can be identified using the messageClass.
messageClass=oneTime: the template is standard delivery template.messageClass=continuous: the template is a recurring delivery.messageClass=transactional: the template is a transactional message template.
xdm:templateID
- is optional
- type:
integer
integer
A human-friendly identifier of the the parent entity (in case of event_based or continuous message Class) of the campaign activity originating this message.
xdm:templateName
- is optional
- type:
string
string
Specify whether campaign activity is of type A/B testing.
xdm:testEnabled
- is optional
- type:
boolean - default:
false
boolean
A human-friendly name of the campaign activity which is originating this message.
https://ns.adobe.com/experience/campaign/eventSource
- is optional
- type:
string - defined in Adobe Campaign ExperienceEvent Full Extension
string
https://ns.adobe.com/experience/campaign/eventSource Known Values
| Value | Description |
|---|---|
replay-pipelined-mta |
This event was generated via Replay Utility tool generated from Pipelined |
replay-pipelined-inMail |
This event was generated via Replay Utility tool generated from Pipelined |
replay-pipelined-trackinglogd |
This event was generated via Replay Utility tool generated from Pipelined |
replay-pipelined-pipelined |
This event was generated via Replay Utility tool generated from Pipelined |
pipelined-mta |
This event was generated via Pipelined generated from mta |
pipelined-inMail |
This event was generated via Pipelined generated from inMail |
pipelined-trackinglogd |
This event was generated via Pipelined generated from trackinglogd |
pipelined-pipelined |
This event was generated via Pipelined generated from Pipelined |
replay |
This event was generated via Replay Utility tool which did not have any event source |
pipelined-tracker |
This event was generated via Pipelined generated from TrackeR |
https://ns.adobe.com/experience/campaign/link
- is optional
- type:
object - defined in Adobe Campaign ExperienceEvent Full Extension
object with following properties:
| Property | Type | Required | Default |
|---|---|---|---|
xdm:category |
string | Optional | |
xdm:description |
string | Optional | |
xdm:id |
string | Optional | |
xdm:inAppMessageAction |
string | Optional | |
xdm:inAppMessageButtonText |
string | Optional | |
xdm:label |
string | Optional | |
xdm:occurrence |
integer | Optional | 1 |
xdm:url |
string | Optional |
The category of the link. It may be subscription, or a user-defined category.
xdm:category
- is optional
- type:
string
string
A human-friendly description of the link.
xdm:description
- is optional
- type:
string
string
Unique Identifier of the Link
xdm:id
- is optional
- type:
string
string
Actions on the In-App message delivered, e.g. action on primary button, secondary button or close button.
xdm:inAppMessageAction
- is optional
- type:
string
string
| Value | Description |
|---|---|
primary |
Primary action |
secondary |
Secondary action |
dismiss |
Dismiss action |
The user-friendly text on the button.
xdm:inAppMessageButtonText
- is optional
- type:
string
string
The user-friendly label clicking on which the link opens.
xdm:label
- is optional
- type:
string
string
URL occurrence index in the content (first is 1). When the same URL is available several times in the same content, its is necessary to track which occurrence of the URL has been clicked on.
xdm:occurrence
- is optional
- type:
integer - default:
1
integer
- minimum value:
1 - maximum value:
32767
URL of the Link.
xdm:url
- is optional
- type:
string
string
- format:
uri– Uniformous Resource Identifier (according to RFC3986)
https://ns.adobe.com/experience/campaign/marketingCampaign
- is optional
- type:
object - defined in Adobe Campaign ExperienceEvent Full Extension
object with following properties:
| Property | Type | Required |
|---|---|---|
xdm:campaignName |
string | Optional |
xdm:id |
integer | Optional |
A human-friendly identifier of the marketing campaign which is originating this message.
xdm:campaignName
- is optional
- type:
string
string
Identifier of the marketing campaign to which activity originating this message belongs to.
xdm:id
- is optional
- type:
integer
integer
The medium is a combination of the source of the event (message, web, ...) and its format if applicable.
https://ns.adobe.com/experience/campaign/medium
- is optional
- type:
string - defined in Adobe Campaign ExperienceEvent Full Extension
string
https://ns.adobe.com/experience/campaign/medium Known Values
| Value | Description |
|---|---|
message_text |
The source of the event is message in a text format. |
message_html |
The source of the event is message in a html format. |
message_line |
The source of the event is a line message. |
web |
The source of the event is web tracking tag in a web page. |
offer |
The source of the event is an offer. |
https://ns.adobe.com/experience/campaign/message
- is optional
- type: message.schema
- defined in Adobe Campaign ExperienceEvent Full Extension
- message.schema –
https://ns.adobe.com/experience/campaign/message
Information of the fields that have changed since the previous ExperienceEvent to keep track of the state changes across events. For e.g. if when an email gets sent, an ExperienceEvent with metric sends will be sent. This may get bounced and an ExperienceEvent with metric bounces will be sent then. It may be important for a downstream application to know that the previous ExperienceEvent with metric sends is now to be invalidated. This field will contain the values from the previous ExperienceEvent that have a different value in the current ExperienceEvent.
https://ns.adobe.com/experience/campaign/mutation
- is optional
- type: Adobe Campaign Mutation Event
- defined in Adobe Campaign ExperienceEvent Full Extension
- Adobe Campaign Mutation Event –
https://ns.adobe.com/experience/campaign/mutationevent
The offer in the message for an 'offer opened' event.
https://ns.adobe.com/experience/campaign/offerOpened
- is optional
- type: Campaign Offer Response Detail
- defined in Adobe Campaign ExperienceEvent Full Extension
- Campaign Offer Response Detail –
https://ns.adobe.com/experience/campaign/offer-response-detail
The offers in the message of a 'email-send' event.
https://ns.adobe.com/experience/campaign/offersProposed
-
is optional
-
type: Campaign Offer Proposition Detail
Array type: Campaign Offer Proposition Detail
All items must be of the type:
- Campaign Offer Proposition Detail –
https://ns.adobe.com/experience/campaign/offer-proposition-detail
https://ns.adobe.com/experience/campaign/orchestration
- is optional
- type: orchestration.schema
- defined in Adobe Campaign ExperienceEvent Full Extension
- orchestration.schema –
https://ns.adobe.com/experience/campaign/orchestration
A unique identifier for the proposition event referenced by another "XDM ExperienceEvent". It is the expectation that applications use this "propositionID" in every experience event that was influenced by the set of propositions. An individual profile's proposition-response history is maintained with these proposition identifiers.
https://ns.adobe.com/experience/decisioning/propositionID
- is optional
- type:
string - defined in Experience Event - Proposition Reference
string
- format:
uri-reference– URI Reference (according to RFC3986)
https://ns.adobe.com/experience/implementations
- is optional
- type: Adobe Experience Platform Implementation Details
- defined in Adobe Experience Platform Implementation Details
- Adobe Experience Platform Implementation Details –
https://ns.adobe.com/experience/implementations
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
- is optional
- type:
string - defined in Adobe Unified Profile Service ExperienceEvent Shared Extension
string
Identifier used to stitch Target events with Analytics events
https://ns.adobe.com/experience/target/supplementalDataID
- is optional
- type:
string - defined in Adobe Target ExperienceEvent Shared Extension
string
Information related to advertising impressions, clickthroughs, and attribution.
xdm:advertising
- is optional
- type: Advertising
- defined in Advertising Details
- Advertising –
https://ns.adobe.com/xdm/context/advertising
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
- Application –
https://ns.adobe.com/xdm/context/application
Experience channel related to the ExperienceEvent.
xdm:channel
- is optional
- type: Experience Channel
- defined in Channel Details
- Experience Channel –
https://ns.adobe.com/xdm/channels/channel
Product returns, warranty registration, and shopping cart/order process.
xdm:commerce
- is optional
- type: Commerce
- defined in Commerce Details
- Commerce –
https://ns.adobe.com/xdm/context/commerce
Globally unique identification of a data source.
xdm:dataSource
- is optional
- type: Data Source
- defined in Technical Details
- Data Source –
https://ns.adobe.com/xdm/data/datasource
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
- Device –
https://ns.adobe.com/xdm/context/device
Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications.
xdm:directMarketing
- is optional
- type: Direct marketing
- defined in Direct Marketing Details
- Direct marketing –
https://ns.adobe.com/xdm/context/direct-marketing
Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent.
xdm:endUserIDs
- is optional
- type: End user IDs
- defined in End User ID Details
- End user IDs –
https://ns.adobe.com/xdm/context/enduserids
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
- Environment –
https://ns.adobe.com/xdm/context/environment
Tracks offer impression and social network interactions.
xdm:marketing
- is optional
- type: Marketing
- defined in Campaign Marketing Details
- Marketing –
https://ns.adobe.com/xdm/context/marketing
Media activity information related to the experience event.
xdm:media
- is optional
- type: Media information
- defined in Media Interaction Details
- Media information –
https://ns.adobe.com/xdm/context/media
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
- Place context –
https://ns.adobe.com/xdm/context/placecontext
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
Array type: Product list item
All items must be of the type:
- Product list item –
https://ns.adobe.com/xdm/content/productlistitem
Details about the IDs that were joined by profile stitching.
xdm:profileStitch
-
is optional
-
type: Profile stitch
-
defined in Profile Stitch Details
Array type: Profile stitch
All items must be of the type:
- Profile stitch –
https://ns.adobe.com/xdm/context/profileStitch
The time at which this interaction was received by a server.
xdm:receivedTimestamp
- is optional
- type:
string - defined in Technical Details
string
- format:
date-time– date and time (according to RFC 3339, section 5.6)
The information related to web or mobile search.
xdm:search
- is optional
- type: Search
- defined in Search Details
- Search –
https://ns.adobe.com/xdm/context/search
xdm:segmentMembership
- is optional
- type:
object - defined in Segment Membership Details
object with following properties:
| Property | Type | Required |
|---|
The segments associated with this ExperienceEvent. Deprecated, use xdm:segmentMembership instead.
xdm:segmentMemberships
-
is optional
-
type: Segment membership item
-
defined in Segment Membership Details
Array type: Segment membership item
All items must be of the type:
- Segment membership item –
https://ns.adobe.com/xdm/context/segmentmembershipitem
Link clicks, web page details, referrer information, and browser details.
xdm:web
- is optional
- type: Web information
- defined in Web Details
- Web information –
https://ns.adobe.com/xdm/context/webinfo