xdm/docs/reference/adobe/experience/decisioning/scope-details.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
{
    "meta:license": [
        "Copyright 2020 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/scope-details",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Decision Scope Details",
    "type": "object",
    "meta:extensible": true,
    "description": "Decision scope details capture properties that existed to narrow the scope of the decision to a location (the \"Where\"), a the business activity (the \"Why\") and the provider of the decision (\"By Whom\"). The location (the \"Where\") is expressed with the concept of a Placement.",
    "definitions": {
        "proposition-scope-details-datatype": {
            "properties": {
                "xdm:id": {
                    "type": "string",
                    "title": "Decision Scope Identifier",
                    "description": "The unique identifier of the decision scope. For a given decision request a scope narrows the decision process along multiple dimensions. The scope is referencable by its identifier.",
                    "meta:titleId": "scope-details##xdm:id##title##97931",
                    "meta:descriptionId": "scope-details##xdm:id##description##121"
                },
                "xdm:decisionProvider": {
                    "type": "string",
                    "title": "Decision Provider",
                    "description": "The provider that was asked to make the decision. This dimension is used when mutliple services can make decisions for the same placement or activity.",
                    "meta:titleId": "scope-details##xdm:decisionProvider##title##52551",
                    "meta:descriptionId": "scope-details##xdm:decisionProvider##description##24291"
                },
                "xdm:placement": {
                    "$ref": "https://ns.adobe.com/experience/decisioning/placement-detail",
                    "title": "Placement Detail for the Scope",
                    "description": "The placement that was a requested as part of this decision scope. A scope will include a specification of the location or surface where the option will be presented. The placement narrows the options that can be proposed to those that can be represented or rendered in that place.",
                    "meta:titleId": "scope-details##xdm:placement##title##42481",
                    "meta:descriptionId": "scope-details##xdm:placement##description##54001"
                },
                "xdm:activity": {
                    "$ref": "https://ns.adobe.com/experience/decisioning/activity-detail",
                    "title": "Activity Detail for the Scope",
                    "description": "The activity that was a requested or chosen for this decision scope. Some scopes will prescribe the exact activity (why and how) that makes the decision, other scopes will use a dynamic strategy determine which activity is used. Those scopes will list executionDetails for steps that were performed during decision-making.",
                    "meta:titleId": "scope-details##xdm:activity##title##26571",
                    "meta:descriptionId": "scope-details##xdm:activity##description##781"
                },
                "xdm:correlationID": {
                    "type": "string",
                    "title": "Correlation Identifier",
                    "description": "The campaign, journey, or other object to which this activity can be correlated. This string will often be further classified in the reporting engine."
                },
                "xdm:interactionMeasurements": {
                    "type": "array",
                    "items": {
                        "$ref": "https://ns.adobe.com/experience/decisioning/interaction-measurement"
                    },
                    "title": "Interaction Measurements used in this Scope",
                    "description": "The interaction measurements determine how inteaction event properties are interpreted (mapped) into outcomes for the propositions. Outcomes could be measured as the number of successes or failures or by a quantitative metric. An outcome can have a nominal value (e.g. success/failure), ordinal (rating value gathered) or numerical value (e.g. a measurable quantity).",
                    "meta:titleId": "scope-details##xdm:interactionMeasurements##title##14221",
                    "meta:descriptionId": "scope-details##xdm:interactionMeasurements##description##28081"
                },
                "xdm:strategies": {
                    "type": "array",
                    "items": {
                        "$ref": "https://ns.adobe.com/experience/decisioning/strategy-details"
                    },
                    "title": "Strategy Step Details",
                    "description": "The steps that were executed when the decision was made.",
                    "meta:titleId": "scope-details##xdm:strategies##title##18771",
                    "meta:descriptionId": "scope-details##xdm:strategies##description##97311"
                },
                "xdm:experience": {
                    "title": "Selected Experience Option",
                    "description": "The experience that was selected when the decision was made.",
                    "$ref": "#/definitions/experience-option-details",
                    "meta:titleId": "scope-details##xdm:experience##title##59941",
                    "meta:descriptionId": "scope-details##xdm:experience##description##86341"
                },
                "xdm:characteristics": {
                    "title": "Scope Details Characteristics",
                    "description": "Additional properties or attributes belonging to this particular scope details.",
                    "type": "object",
                    "meta:xdmType": "map",
                    "additionalProperties": {
                        "type": "string",
                        "description": "Value of the property."
                    }
                }
            }
        },
        "experience-option-details": {
            "properties": {
                "xdm:id": {
                    "type": "string",
                    "format": "uri-reference",
                    "title": "Experience Identifier",
                    "description": "A unique identifier for the decision option.",
                    "meta:titleId": "scope-details##xdm:id##title##47581",
                    "meta:descriptionId": "scope-details##xdm:id##description##32311"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/proposition-scope-details-datatype"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "scope-details##title##59341",
    "meta:descriptionId": "scope-details##description##13321",
    "examples": [
        {
            "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": "auto-optimize",
                    "xdm:trafficType": "noncontextual"
                }
            ]
        },
        {
            "xdm:id": "3cc33a7e-13ca-4b19-b25d-c816eff9a70a",
            "xdm:correlationID": "20c2587dcb1e85f52d070e12dd52e815",
            "xdm:strategies": [
                {
                    "xdm:step": "experimentation",
                    "xdm:strategyID": "16ASJZ2DWmusQjtxucYats",
                    "xdm:treatmentID": "0"
                }
            ]
        }
    ]
}