xdm/docs/reference/adobe/experience/offer-management/offer-activity.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 2018 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/offer-management/offer-activity",
    "type": "object",
    "title": "Activity",
    "description": "An offer activity is used to control the decisioning process. It specifies the filter applied to the total inventory to narrow down offers by topic/category, the placement to narrow down the inventory to those offers that technically fit into the reserved space for the offer and specifies a fall back option should the combined constraints disqualify all available personalization offers. (deprecated)",
    "meta:extends": [
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/experience/decisioning/activity",
        "https://ns.adobe.com/experience/decisioning/criteria"
    ],
    "meta:abstract": false,
    "meta:extensible": true,
    "definitions": {
        "offer-activity": {
            "properties": {
                "@id": {
                    "type": "string",
                    "format": "uri-reference",
                    "title": "ID",
                    "description": "The unique identifier of the offer activity. This @id must be unique across for objects that are not semantically the same, otherwise it is interpreted as referring to the same object. ",
                    "meta:titleId": "offer-activity##@id##title##38471",
                    "meta:descriptionId": "offer-activity##@id##description##39111"
                },
                "xdm:name": {
                    "meta:status": "deprecated",
                    "type": "string",
                    "title": "Name",
                    "description": "Activity name. The name is displayed in various user interfaces.",
                    "meta:titleId": "offer-activity##xdm:name##title##65541",
                    "meta:descriptionId": "offer-activity##xdm:name##description##28371"
                },
                "xdm:status": {
                    "meta:status": "deprecated",
                    "type": "string",
                    "title": "Status",
                    "description": "Activity Status",
                    "enum": [
                        "draft",
                        "live",
                        "complete",
                        "archived"
                    ],
                    "meta:enum": {
                        "draft": "Draft",
                        "live": "Live",
                        "complete": "Complete",
                        "archived": "Archived"
                    },
                    "meta:titleId": "offer-activity##xdm:status##title##32561",
                    "meta:descriptionId": "offer-activity##xdm:status##description##99051"
                },
                "xdm:startDate": {
                    "meta:status": "deprecated",
                    "type": "string",
                    "format": "date-time",
                    "title": "Start Date",
                    "description": "Activity Start Date",
                    "meta:titleId": "offer-activity##xdm:startDate##title##38151",
                    "meta:descriptionId": "offer-activity##xdm:startDate##description##89631"
                },
                "xdm:endDate": {
                    "meta:status": "deprecated",
                    "type": "string",
                    "format": "date-time",
                    "title": "End Date",
                    "description": "Activity End Date",
                    "meta:titleId": "offer-activity##xdm:endDate##title##99021",
                    "meta:descriptionId": "offer-activity##xdm:endDate##description##2821"
                },
                "xdm:placement": {
                    "meta:status": "deprecated",
                    "type": "string",
                    "format": "uri",
                    "title": "Offer Placement",
                    "description": "The reference to an offer placement instance. Offer placements are used by offer activities to limit the offer selection to those offers that have a representation that complies with the offer placement restrictions. The value is the URI (@id) of the offer placement that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-placement",
                    "meta:titleId": "offer-activity##xdm:placement##title##59431",
                    "meta:descriptionId": "offer-activity##xdm:placement##description##72121"
                },
                "xdm:filter": {
                    "meta:status": "deprecated",
                    "type": "string",
                    "format": "uri",
                    "title": "Offer Filter",
                    "description": "The reference to a filter that is applied to the inventory when a decisioning is made the context of this activity. The value is the URI (@id) of the offer filter that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-filter",
                    "meta:titleId": "offer-activity##xdm:filter##title##59871",
                    "meta:descriptionId": "offer-activity##xdm:filter##description##59331"
                },
                "xdm:fallback": {
                    "meta:status": "deprecated",
                    "type": "string",
                    "format": "uri",
                    "title": "Fallback Offer",
                    "description": "The reference to a fallback offer that is used when decisioning in the context of this activity does not qualify any of the offers specified in the fallback offer. The value is the URI (@id) of the fallback offer that is referenced.  See schema https://ns.adobe.com/experience/offer-management/fallback-offer",
                    "meta:titleId": "offer-activity##xdm:fallback##title##37051",
                    "meta:descriptionId": "offer-activity##xdm:fallback##description##55241"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/data/record"
        },
        {
            "$ref": "https://ns.adobe.com/experience/decisioning/activity"
        },
        {
            "$ref": "https://ns.adobe.com/experience/decisioning/criteria"
        },
        {
            "$ref": "#/definitions/offer-activity"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "offer-activity##title##41321",
    "meta:descriptionId": "offer-activity##description##81331"
}