xdm/docs/reference/adobe/experience/decisioning/proposition-detail.schema.json at master · RussStringham/xdm · GitHub

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
{
    "meta:license": [
        "Copyright 2019 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/decisioning/proposition-detail",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Decision Proposition Details",
    "type": "object",
    "meta:abstract": true,
    "meta:extensible": true,
    "description": "A decision proposition detail is used to capture the output of a decisioning activity. Propositions are enriched with the observed metrics that applied to the selected options at the time the decision was made.",
    "definitions": {
        "proposition-detail-datatype": {
            "properties": {
                "xdm:activity": {
                    "title": "Decision Activity Snapshot",
                    "description": "Snapshot of the activity for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the decision activity. In the future, this will be deprecated in favor of scopeDetails.activity.",
                    "$ref": "https://ns.adobe.com/experience/decisioning/activity-detail",
                    "meta:titleId": "proposition-detail##xdm:activity##title##52161",
                    "meta:descriptionId": "proposition-detail##xdm:activity##description##28321"
                },
                "xdm:channel": {
                    "meta:status": "deprecated",
                    "title": "Channel (deprecated)",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "The channel in which proposition was made. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel'. (deprecated), use scope.placement.channel instead. ",
                    "meta:titleId": "proposition-detail##xdm:channel##title##33091",
                    "meta:descriptionId": "proposition-detail##xdm:channel##description##23581"
                },
                "xdm:placement": {
                    "title": "Placement Snapshot",
                    "description": "Snapshot of the placement for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the placement. In the future, this will be deprecated in favor of scopeDetails.placement.",
                    "$ref": "https://ns.adobe.com/experience/decisioning/placement-detail",
                    "meta:titleId": "proposition-detail##xdm:placement##title##42691",
                    "meta:descriptionId": "proposition-detail##xdm:placement##description##89831"
                },
                "xdm:selections": {
                    "title": "Selected Options' Snapshot",
                    "description": "Snapshot of the options that were selected by this activity. The objects contain a at least the xdm:id property value which is the identifier of an option. The intention is that either the selections or the fallback property is required. In the future, this will be deprecated in favor of items.",
                    "type": "array",
                    "items": {
                        "$ref": "https://ns.adobe.com/experience/decisioning/option-detail"
                    },
                    "minItems": 1,
                    "uniqueItems": true,
                    "meta:titleId": "proposition-detail##xdm:selections##title##87871",
                    "meta:descriptionId": "proposition-detail##xdm:selections##description##34631"
                },
                "xdm:fallback": {
                    "title": "Fallback Option Snapshot",
                    "description": "Snapshot of the fixed fallback option that was selected because no available option satisfied all constraints. The object contains at least the xdm:id property value which is the identifier of the fallback action. Note that the intention is that either the selections or the fallback property is required. In the future, this will be deprecated in favor of scopeDetails.activity.fallback.",
                    "$ref": "https://ns.adobe.com/experience/decisioning/option-detail",
                    "meta:titleId": "proposition-detail##xdm:fallback##title##20611",
                    "meta:descriptionId": "proposition-detail##xdm:fallback##description##92261"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/proposition-detail-datatype"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "proposition-detail##title##75481",
    "meta:descriptionId": "proposition-detail##description##60051",
    "examples": [
        {
            "xdm:activity": {
                "xdm:id": "xcore:offer-activity:ebc48132c26ccfc",
                "xdm:name": "Online College Counseler",
                "xdm:startDate": "2018-10-13T05:59:18.914Z",
                "xdm:endDate": "2018-12-27T05:59:18.914Z",
                "xdm:fallback": "xcore:fallback-offer:e91ce7243fd8c2a"
            },
            "xdm:placement": {
                "xdm:id": "xcore:offer-placement:c652463157c2aa1",
                "xdm:name": "Top Banner",
                "xdm:channel": "https://ns.adobe.com/xdm/channels/email"
            },
            "xdm:selections": [
                {
                    "xdm:id": "xcore:personalized-offer:e91ee850a0bb7d9",
                    "xdm:name": "Introduction to machine learning",
                    "xdm:characteristics": {
                        "duration": "14",
                        "level": "intermediate",
                        "format": "Syllable"
                    },
                    "https://ns.adobe.com/experience/decisioning/propositionsTotal": {
                        "xdm:value": 4948
                    },
                    "https://ns.adobe.com/experience/decisioning/propositionsProfile": {
                        "xdm:value": 2
                    }
                },
                {
                    "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4",
                    "xdm:name": "Summer Camp",
                    "xdm:characteristics": {
                        "cost": "$2400",
                        "inventoryId": "BORA04",
                        "country": "French Polynesia"
                    },
                    "https://ns.adobe.com/experience/decisioning/propositionsTotal": {
                        "xdm:value": 3813
                    },
                    "https://ns.adobe.com/experience/decisioning/propositionsProfile": {
                        "xdm:value": 1
                    }
                }
            ]
        },
        {
            "xdm:activity": {
                "xdm:id": "xcore:offer-activity:f203512e02542b5"
            },
            "xdm:fallback": {
                "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a"
            }
        }
    ]
}