Skip to content

CJM-97211 Introduce xdm-schema for message-rendering-context dataset #1977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions components/behaviors/time-series.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
"delivery.feedback": "Delivery Feedback",
"message.feedback": "Message Feedback",
"message.tracking": "Message Tracking",
"message.renderingData": "Message Rendering Data",
"pushTracking.applicationOpened": "Push Tracking Application Opened",
"pushTracking.customAction": "Push Tracking Custom Action",
"listOperation.removeFromList": "List Operation Remove From List",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/recipient": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/recipient/email": "[email protected]",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/recipient/name": "Jane Doe",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/recipient/bcc": [
"[email protected]",
"[email protected]"
]
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/sender": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/sender/email": "[email protected]",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/sender/name": "Adobe Team",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/sender/errorEmail": "[email protected]",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/sender/replyToEmail": "[email protected]",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/sender/replyToName": "Adobe Support"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/recipient": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/recipient/number": "+15551234567"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/sender": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/sender/numbers": [
"+15557654321"
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
{
"meta:license": [
"Copyright 2025 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/message-delivery-metadata",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Message Delivery Metadata",
"description": "Schema for delivery metadata for different channels in Adobe Journey Optimizer",
"type": "object",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"],
"definitions": {
"messageDeliveryMetadata": {
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata": {
"type": "object",
"title": "Email Metadata",
"description": "Metadata specific to email delivery",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient": {
"type": "object",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient/email": {
"type": "string",
"format": "email",
"description": "Recipient's email address"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient/name": {
"type": "string",
"description": "Recipient's name"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient/bcc": {
"type": "array",
"description": "BCC email address",
"items": {
"type": "string",
"format": "email"
}
}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient/email"
]
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender": {
"type": "object",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender/email": {
"type": "string",
"format": "email",
"description": "Sender's email address"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender/name": {
"type": "string",
"description": "Sender's name"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender/errorEmail": {
"type": "string",
"format": "email",
"description": "Email address for delivery errors"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender/replyToEmail": {
"type": "string",
"format": "email",
"description": "Reply-to email address"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender/replyToName": {
"type": "string",
"description": "Reply-to name"
}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender/email",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender/name",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender/replyToEmail",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender/errorEmail"
]
}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/sender"
]
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata": {
"type": "object",
"title": "SMS Metadata",
"description": "Metadata specific to SMS delivery",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/recipient": {
"type": "object",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/recipient/number": {
"type": "string",
"description": "Recipient's phone number"
}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/recipient/number"
]
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/sender": {
"type": "object",
"description": "Sender's phone number",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/sender/numbers": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/sender/numbers"
]
}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/recipient",
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/smsMetadata/sender"
]
}
}
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
},
{
"$ref": "#/definitions/messageDeliveryMetadata"
}
],
"meta:status": "stable"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent/subject": "Welcome to Adobe Journey Optimizer!",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent/html": "<html><body><h1>Hello, John!</h1><p>Thank you for joining us.</p></body></html>",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent/text": "Hello, John! Thank you for joining us."
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/smsContent": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/smsContent/title": "Promo",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/smsContent/message": "Your code is 12345. Use it to get 20% off!",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/smsContent/media": "https://example.com/media/promo.jpg"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
{
"meta:license": [
"Copyright 2025 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/message-rendered-content",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Message Rendered Content",
"description": "Schema for storing the rendered message per channel in Adobe Journey Optimizer",
"type": "object",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"],
"definitions": {
"messageRenderedContent": {
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent": {
"type": "object",
"title": "Email Channel Content",
"description": "Email-specific rendered content",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent/subject": {
"type": "string",
"description": "The email subject line"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent/html": {
"type": "string",
"description": "The HTML content of the email"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent/text": {
"type": "string",
"description": "The plain text content of the email"
}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent/subject",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent/html"
]
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/smsContent": {
"type": "object",
"title": "SMS Channel Content",
"description": "SMS-specific rendered content",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/smsContent/title": {
"type": "string",
"description": "The title of the SMS message"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/smsContent/message": {
"type": "string",
"description": "The text content of the SMS message"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/smsContent/media": {
"type": "string",
"description": "Media content reference for the SMS (MMS)"
}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/smsContent/message"
]
}
}
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
},
{
"$ref": "#/definitions/messageRenderedContent"
}
],
"meta:status": "stable"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/profile": "{\"firstName\":\"John\",\"lastName\":\"Doe\",\"email\":\"[email protected]\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/offer": "{\"offerId\":\"OFF123\",\"description\":\"20% off your next purchase\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/context": "{\"channel\":\"email\",\"language\":\"en-US\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/propertiesContext": "{\"brand\":\"Adobe\",\"campaign\":\"Spring Sale\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/decisionPolicy": "{\"policyId\":\"POLICY1\",\"decision\":\"accept\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/offerContentAttributes": "{\"headline\":\"Special Offer\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/url": "{\"landingPage\":\"https://adobe.com/sale\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/fragment": "{\"header\":\"Welcome!\",\"footer\":\"Thank you\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/externalDataLookup": "{\"lookupId\":\"LKP1\",\"result\":\"success\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/url-support": "{\"shortener\":\"bit.ly\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/inputSchema": "{\"fields\":[\"firstName\",\"lastName\"]}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/channelConfiguration": "{\"provider\":\"SendGrid\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/segment": "{\"segmentId\":\"SEG1\"}",
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/renderingContext/_cjmProperties": "{\"internalFlag\":true}"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderingMetadata/retrievedEntities": [
"{\"entityType\":\"profile\",\"id\":\"12345\"}",
"{\"entityType\":\"offer\",\"id\":\"OFF123\"}"
]
}
}
Loading