xdm/docs/reference/adobe/experience/decisioning/option.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
{
    "meta:license": [
        "Copyright 2021 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/"
    ],
    "$schema": "http://json-schema.org/draft-06/schema#",
    "$id": "https://ns.adobe.com/experience/decisioning/option",
    "meta:extends": [
        "https://ns.adobe.com/xdm/data/record"
    ],
    "type": "object",
    "title": "Decision Option",
    "meta:abstract": true,
    "meta:extensible": true,
    "description": "This class is used to capture minimum properties that are required to define the concept of a decision option. A decision option represents one of the possible selections or choices for a decision.",
    "definitions": {
        "option-details": {
            "properties": {
                "repo:etag": {
                    "title": "Decision Option ETag",
                    "type": "string",
                    "description": "The revision that the decision option object was at when the snapshot was taken.",
                    "meta:titleId": "option##repo:etag##title##84711",
                    "meta:descriptionId": "option##repo:etag##description##55841"
                },
                "https://ns.adobe.com/experience/decisioning/name": {
                    "type": "string",
                    "title": "Decision Option Name",
                    "description": "Option name. The name is displayed in various user interfaces.",
                    "meta:titleId": "option##https://ns.adobe.com/experience/decisioning/name##title##48511",
                    "meta:descriptionId": "option##https://ns.adobe.com/experience/decisioning/name##description##21061"
                },
                "https://ns.adobe.com/experience/decisioning/characteristics": {
                    "title": "Decision Option Characteristics",
                    "description": "Additional properties or attributes belonging to this particular decision option. Different instances can have different characteristics (keys in the map). The characteristics are name value pairs used to distinguish one decision option from others. Characteristics are used as values in content that represents this decision option and as features to analyze and optimize the performance of an option. When every instance has the same attribute or property, that aspect should be modeled as an extension schema that derives from decision option detail.",
                    "type": "object",
                    "meta:xdmType": "map",
                    "additionalProperties": {
                        "type": "string",
                        "description": "Value of the property.",
                        "meta:descriptionId": "option##additionalProperties##description##77521"
                    },
                    "meta:titleId": "option##https://ns.adobe.com/experience/decisioning/characteristics##title##16171",
                    "meta:descriptionId": "option##https://ns.adobe.com/experience/decisioning/characteristics##description##17151"
                }
            }
        },
        "option-snapshot-identifier": {
            "properties": {
                "https://ns.adobe.com/experience/decisioning/optionID": {
                    "title": "Decision Option Identifier",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "A unique identifier for the decision option.",
                    "meta:titleId": "option##https://ns.adobe.com/experience/decisioning/optionID##title##80321",
                    "meta:descriptionId": "option##https://ns.adobe.com/experience/decisioning/optionID##description##30731"
                },
                "repo:etag": {
                    "title": "Decision Option ETag",
                    "type": "string",
                    "description": "The revision that the decision option object was at when the snapshot was taken.",
                    "meta:titleId": "option##repo:etag##title##6041",
                    "meta:descriptionId": "option##repo:etag##description##95961"
                }
            }
        },
        "option-snapshot-tags": {
            "properties": {
                "https://ns.adobe.com/experience/decisioning/tags": {
                    "type": "array",
                    "title": "Decision Option Tags",
                    "description": "The set of tags associated with this option. The tags are used indicate catetoegies (dimensions) that the option belonged to at the time the proposition was made.",
                    "items": {
                        "type": "string",
                        "format": "uri-reference",
                        "description": "An identifier of a Tag object. The value is the @id of the Tag that is referenced. See Tag schema https://ns.adobe.com/experience/decisioning/tag",
                        "meta:descriptionId": "option##items##description##15171"
                    },
                    "meta:titleId": "option##https://ns.adobe.com/experience/decisioning/tags##title##11261",
                    "meta:descriptionId": "option##https://ns.adobe.com/experience/decisioning/tags##description##69841"
                }
            }
        },
        "option-snapshot-measures": {
            "properties": {
                "https://ns.adobe.com/experience/decisioning/propositionsTotal": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "The total number a particular option was proposed so far across all profiles.",
                    "meta:descriptionId": "option##https://ns.adobe.com/experience/decisioning/propositionsTotal##description##10741"
                },
                "https://ns.adobe.com/experience/decisioning/propositionsProfile": {
                    "$ref": "https://ns.adobe.com/xdm/data/measure",
                    "description": "The number of times a particular option was proposed so far to a particular profile. When this metric is present the record or time-series entity must include an IdentityMap the profile.",
                    "meta:descriptionId": "option##https://ns.adobe.com/experience/decisioning/propositionsProfile##description##22681"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/data/record"
        },
        {
            "$ref": "#/definitions/option-details"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "option##title##15921",
    "meta:descriptionId": "option##description##79831",
    "examples": [
        {
            "@id": "personalized-offer:e526a1503bf29e9",
            "https://ns.adobe.com/experience/decisioning/name": "Introduction to machine learning",
            "https://ns.adobe.com/experience/decisioning/characteristics": {
                "syllable": "ML001",
                "duration": "30",
                "durationUnit": "minutes",
                "level": "Beginner"
            }
        }
    ]
}