Skip to content

ajo-entity-mixins.schema.md

Latest commit

 

History

History
493 lines (240 loc) · 14.9 KB

ajo-entity-mixins.schema.md

File metadata and controls

493 lines (240 loc) · 14.9 KB

AJO Entity Fields Schema

https://ns.adobe.com/experience/customerJourneyManagement/entities

A set of meta-data fields related to various AJO entities which are related to message sent to profile.

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

Schema Hierarchy

  • AJO Entity Fields https://ns.adobe.com/experience/customerJourneyManagement/entities

AJO Entity Fields Example

{
  "https://ns.adobe.com/experience/customerJourneyManagement/entities/campaign": {
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignID": "9e3c3315-f2ca-42c0-85d2-6d3e83802b18",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignVersionID": "f08f3a02-b390-4e24-af16-7fe4a93a05fe",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/name": "Marketing Campaign",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/description": "Used for sending email/push messages",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignActionID": "93rc3315-f2ca-42c0-85d2-6d3e83802b18"
  },
  "https://ns.adobe.com/experience/customerJourneyManagement/entities/channelDetails": {
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/email": {
      "https://ns.adobe.com/experience/customerJourneyManagement/entities/email/subject": "Hi there, season end sale is here!"
    },
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/push": {
      "https://ns.adobe.com/experience/customerJourneyManagement/entities/push/title": "Hi, You've got a coupon"
    },
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/messageID": "04832ee5-51ff-4706-af8a-a8ff6756308b",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/baseMessageID": "04832ee5-51ff-4706-af8a-a8ff6756308b",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/messagePublicationID": "04832ee5-51ff-4706-af8a-a8ff6756308b",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/variantID": "04832ee5-51ff-4706-af8a-a8ff6756308b",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/channel": {
      "@id": "https://ns.adobe.com/xdm/channels/email"
    },
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/template": "Hi {{person.firstName}}",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/messagePublishedAt": "2021-06-25T15:52:25+00:00"
  },
  "https://ns.adobe.com/experience/customerJourneyManagement/entities/experiment": {
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentID": "123456",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentID": "04832ee5-51ff-4706-af8a-a8ff6756sdfd",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentName": "Hero page experiment",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentName": "The first treatment"
  },
  "https://ns.adobe.com/experience/customerJourneyManagement/entities/journey": {
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyVersionID": "04832ee5-51ff-4706-af8a-a8ff6756308b",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyName": "Marketing Test Journey",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyID": "0879238rf-51ff-4706-af8a-a8ff6756308b",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionName": "Email 100Kb Message",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionID": "04832ee5-51ff-4706-af8a-dsff6756308b",
    "https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyNameAndVersion": "Email 100Kb Message (1b)"
  }
}

AJO Entity Fields Properties

Property Type Required Defined by
https://ns.adobe.com/experience/customerJourneyManagement/entities/campaign object Optional AJO Entity Fields (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/entities/channelDetails channelDetails.schema Optional AJO Entity Fields (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/entities/experiment object Optional AJO Entity Fields (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/entities/journey object Optional AJO Entity Fields (this schema)
* any Additional this schema allows additional properties

https://ns.adobe.com/experience/customerJourneyManagement/entities/campaign

AJO Campaign Entity

AJO Campaign Entity Specific Fields

https://ns.adobe.com/experience/customerJourneyManagement/entities/campaign

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

https://ns.adobe.com/experience/customerJourneyManagement/entities/campaign Type

object with following properties:

Property Type Required
https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignActionID string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignID string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignVersionID string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/description string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/name string Optional

https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignActionID

Campaign Action ID

Action ID of the Campaign that triggered this message execution.

https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignActionID

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignActionID Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignID

AJO Campaign ID

AJO Campaign ID. Remains unchanged even after republishing.

https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignID

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignID Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignVersionID

AJO Campaign Version ID

AJO Campaign Version ID. Changes on republishing. Represents immutable version of campaign.

https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignVersionID

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignVersionID Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/description

AJO Campaign Description

AJO Campaign Description.

https://ns.adobe.com/experience/customerJourneyManagement/entities/description

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/description Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/name

AJO Campaign Name

AJO Campaign Name.

https://ns.adobe.com/experience/customerJourneyManagement/entities/name

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/name Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/channelDetails

AJO Channel/Message Entity

AJO Channel/Message Entity Specific Fields. Denormalized on variantId

https://ns.adobe.com/experience/customerJourneyManagement/entities/channelDetails

  • is optional
  • type: channelDetails.schema
  • defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/entities/channelDetails Type

  • channelDetails.schema – https://ns.adobe.com/experience/customerJourneyManagement/entities/channelDetails

https://ns.adobe.com/experience/customerJourneyManagement/entities/experiment

AJO Experiment Entity Specific Fields

AJO Experiment Entity Specific Fields

https://ns.adobe.com/experience/customerJourneyManagement/entities/experiment

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

https://ns.adobe.com/experience/customerJourneyManagement/entities/experiment Type

object with following properties:

Property Type Required
https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentId string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentName string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentID string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentName string Optional

https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentId

Experiment ID

This along with treatmentId has one to one mapping with messageID

https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentId

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentId Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentName

Experiment Name

Name of the experiment

https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentName

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentName Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentID

Treatment ID

This along with experimentId has one to one mapping with messageID

https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentID

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentID Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentName

Treatment Name

Name of the treatment

https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentName

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentName Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/journey

AJO Journey Entity

AJO Journey Entity Specific Fields

https://ns.adobe.com/experience/customerJourneyManagement/entities/journey

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

https://ns.adobe.com/experience/customerJourneyManagement/entities/journey Type

object with following properties:

Property Type Required
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionID string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionName string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyID string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyName string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyNameAndVersion string Optional
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyVersionID string Optional

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionID

Journey Action ID

Represents the Journey Action ID

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionID

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionID Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionName

Journey Action Name

Represents the Journey Label

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionName

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionName Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyID

Journey ID

Represents the journey ID

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyID

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyID Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyName

Journey Name

Represents the journey name

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyName

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyName Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyNameAndVersion

Journey Name and Version

Represents the concatenated values of Journey Name and Version

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyNameAndVersion

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyNameAndVersion Type

string

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyVersionID

Journey Version ID

Represents a frozen version of a Journey

https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyVersionID

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyVersionID Type

string