xdm/docs/reference/adobe/experience/decisioning/decisionevent.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
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
177
178
179
180
181
182
{
    "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/decisionevent",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Decision Event",
    "type": "object",
    "meta:abstract": true,
    "meta:extensible": true,
    "meta:extends": [
        "https://ns.adobe.com/xdm/data/time-series",
        "https://ns.adobe.com/xdm/context/identitymap",
        "https://ns.adobe.com/experience/decisioning/proposition",
        "https://ns.adobe.com/experience/decisioning/proposition-details"
    ],
    "description": "A decision event is used to capture observations about the outcome and context of a decision activity. The decision event captures information about how the decision made, when it was occurring, what options were proposed (chosen) and what contextual state existed that either influenced the decision or could be observed during the decision process. The decision event also captures the proposition ID, a globally unique identifier that can be used to correlate the decision to other events. DecisionEvents are not only relatable to Experience Events that impacted a decision but also to ExperienceEvents that are a direct response to a proposition. It is the expectation that applications reference the proposition ID in every experience event that was influenced by the propositions. A user profile's proposition-response history is maintained with these proposition IDs.",
    "definitions": {
        "decisionevent": {
            "properties": {
                "https://ns.adobe.com/experience/decisioning/propositions": {
                    "title": "Proposition Details",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/proposition-details"
                    },
                    "description": "Details about the results of the decision. An array providing the output of a single decision event, one proposition per activity parameter in the request.",
                    "meta:titleId": "decisionevent##https://ns.adobe.com/experience/decisioning/propositions##title##95301",
                    "meta:descriptionId": "decisionevent##https://ns.adobe.com/experience/decisioning/propositions##description##63441"
                }
            }
        },
        "proposition-details": {
            "properties": {
                "xdm:items": {
                    "title": "Decision Options' Snapshot",
                    "description": "Snapshot of the options that were selected by this proposition. The objects contain 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.",
                    "type": "array",
                    "items": {
                        "$ref": "https://ns.adobe.com/experience/decisioning/option-detail"
                    },
                    "minItems": 1,
                    "uniqueItems": true,
                    "meta:titleId": "decisionevent##xdm:items##title##30091",
                    "meta:descriptionId": "decisionevent##xdm:items##description##64411"
                },
                "xdm:scopeDetails": {
                    "$ref": "https://ns.adobe.com/experience/decisioning/scope-details",
                    "title": "Decision Scope Snapshot",
                    "description": "A snapshot of properties from the decision scope. This is the state of the scope entity that was used in the decision requst.",
                    "meta:titleId": "decisionevent##xdm:scopeDetails##title##8281",
                    "meta:descriptionId": "decisionevent##xdm:scopeDetails##description##6731"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/data/time-series"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/identitymap"
        },
        {
            "$ref": "https://ns.adobe.com/experience/decisioning/proposition"
        },
        {
            "$ref": "https://ns.adobe.com/experience/decisioning/proposition-details"
        },
        {
            "$ref": "#/definitions/decisionevent"
        },
        {
            "required": [
                "@id",
                "xdm:timestamp",
                "https://ns.adobe.com/experience/decisioning/propositionID"
            ]
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "decisionevent##title##70291",
    "meta:descriptionId": "decisionevent##description##55261",
    "examples": [
        {
            "@id": "https://data.adobe.io/entities/propositions/3cc33a7e-13ca-4b19-b25d-c816eff9a70a",
            "xdm:timestamp": "2019-01-26T15:52:25+00:00",
            "xdm:identityMap": {
                "ECID": [
                    {
                        "xdm:id": "33441528584054496761339722935948080609"
                    }
                ]
            },
            "https://ns.adobe.com/experience/decisioning/propositionID": "3cc33a7e-13ca-4b19-b25d-c816eff9a70a",
            "https://ns.adobe.com/experience/decisioning/propositions": [
                {
                    "xdm:items": [
                        {
                            "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4",
                            "repo:etag": "5",
                            "xdm:score": 83,
                            "xdm:propositionsTotal": {
                                "xdm:value": 948
                            }
                        },
                        {
                            "xdm:id": "xcore:personalized-offer:e91ee850a0bb7d9",
                            "repo:etag": "3",
                            "xdm:score": 12,
                            "xdm:propositionsTotal": {
                                "xdm:value": 221
                            }
                        }
                    ],
                    "xdm:scopeDetails": {
                        "xdm:id": "home-page-banner",
                        "xdm:placement": {
                            "xdm:id": "xcore:offer-placement:c652463157c2aa1",
                            "repo:etag": "4",
                            "xdm:name": "Home Page Banner"
                        },
                        "xdm:activity": {
                            "xdm:id": "xcore:offer-activity:ebc48132c26ccfc",
                            "repo:etag": "8",
                            "xdm:name": "Spring 21 Campaign Web"
                        },
                        "xdm:strategies": [
                            {
                                "xdm:step": "eligibility",
                                "xdm:strategyID": "xcore:eligibility-rule:e5244c22eff29e8",
                                "xdm:algorithmID": "pql-rule",
                                "xdm:trafficType": "contextual"
                            },
                            {
                                "xdm:step": "ranking",
                                "xdm:strategyID": "ranking-strategy:7251468357c2236",
                                "xdm:algorithmID": "ts",
                                "xdm:trafficType": "noncontextual"
                            }
                        ]
                    }
                },
                {
                    "xdm:items": [
                        {
                            "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a",
                            "repo:etag": "5"
                        }
                    ],
                    "xdm:scopeDetails": {
                        "xdm:id": "home-page-side-bar",
                        "xdm:placement": {
                            "xdm:id": "xcore:offer-placement:6111463157c2221",
                            "repo:etag": "6"
                        },
                        "xdm:activity": {
                            "xdm:id": "xcore:offer-activity:fd55d033fea4b82",
                            "repo:etag": "14"
                        },
                        "xdm:strategies": [
                            {
                                "xdm:step": "eligibility",
                                "xdm:strategyID": "xcore:eligibility-rule:f65212b6b3c0b01",
                                "xdm:algorithmID": "pql-rule",
                                "xdm:trafficType": "contextual"
                            }
                        ]
                    }
                }
            ],
            "https://ns.adobe.com/adobecloudplatform/ims/organizationID": "0D8E32C65A8A91520A494008@AdobeOrg",
            "https://ns.adobe.com/experience/decisioning/containerID": "c75afa32-371f-4895-8f43-b853dd9fe740"
        }
    ]
}