forked from adobe/xdm
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathajo-entity-mixins.schema.json
More file actions
176 lines (176 loc) · 11.3 KB
/
ajo-entity-mixins.schema.json
File metadata and controls
176 lines (176 loc) · 11.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
{
"meta:license": [
"Copyright 2022 Adobe Systems Incorporated. All rights reserved.",
"This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
"you may not use this file except in compliance with the License. You may obtain a copy",
"of the License at https://creativecommons.org/licenses/by/4.0/"
],
"$id": "https://ns.adobe.com/experience/customerJourneyManagement/entities",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "AJO Entity Fields",
"description": "A set of meta-data fields related to various AJO entities which are related to message sent to profile.",
"type": "object",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": [
"https://ns.adobe.com/experience/customerJourneyManagement/ajoEntity"
],
"definitions": {
"entities": {
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/entities/campaign": {
"title": "AJO Campaign Entity",
"type": "object",
"description": "AJO Campaign Entity Specific Fields",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignID": {
"title": "AJO Campaign ID",
"type": "string",
"description": "AJO Campaign ID. Remains unchanged even after republishing."
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignVersionID": {
"title": "AJO Campaign Version ID",
"type": "string",
"description": "AJO Campaign Version ID. Changes on republishing. Represents immutable version of campaign."
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/name": {
"title": "AJO Campaign Name",
"type": "string",
"description": "AJO Campaign Name."
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/description": {
"title": "AJO Campaign Description",
"type": "string",
"description": "AJO Campaign Description."
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/campaignActionID": {
"title": "Campaign Action ID",
"type": "string",
"description": "Action ID of the Campaign that triggered this message execution."
}
}
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/channelDetails": {
"title": "AJO Channel/Message Entity",
"description": "AJO Channel/Message Entity Specific Fields. Denormalized on variantId",
"$ref": "https://ns.adobe.com/experience/customerJourneyManagement/entities/channelDetails"
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/experiment": {
"title": "AJO Experiment Entity Specific Fields",
"type": "object",
"description": "AJO Experiment Entity Specific Fields",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentID": {
"title": "Treatment ID",
"type": "string",
"description": "This along with experimentId has one to one mapping with messageID"
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentId": {
"title": "Experiment ID",
"type": "string",
"description": "This along with treatmentId has one to one mapping with messageID"
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/experimentName": {
"title": "Experiment Name",
"type": "string",
"description": "Name of the experiment"
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/treatmentName": {
"title": "Treatment Name",
"type": "string",
"description": "Name of the treatment"
}
}
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/journey": {
"title": "AJO Journey Entity",
"type": "object",
"description": "AJO Journey Entity Specific Fields",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyVersionID": {
"title": "Journey Version ID",
"type": "string",
"description": "Represents a frozen version of a Journey"
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyName": {
"title": "Journey Name",
"type": "string",
"description": "Represents the journey name"
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyID": {
"title": "Journey ID",
"type": "string",
"description": "Represents the journey ID"
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionName": {
"title": "Journey Action Name",
"type": "string",
"description": "Represents the Journey Label"
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyActionID": {
"title": "Journey Action ID",
"type": "string",
"description": "Represents the Journey Action ID"
},
"https://ns.adobe.com/experience/customerJourneyManagement/entities/journeyNameAndVersion": {
"title": "Journey Name and Version",
"type": "string",
"description": "Represents the concatenated values of Journey Name and Version"
}
}
}
}
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
},
{
"$ref": "#/definitions/entities"
}
],
"meta:status": "stable",
"examples": [
{
"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)"
}
}
]
}