xdm/docs/reference/adobe/experience/offer-management/offer.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
{
    "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",
    "meta:abstract": true,
    "meta:extensible": true,
    "type": "object",
    "title": "Offer (deprecated)",
    "description": "This is the base concept for offers that are used for personalization and those that serve as fallback choices when none of offers for personalization qualify at within the given context. (deprecated)",
    "definitions": {
        "offer": {
            "properties": {
                "@id": {
                    "type": "string",
                    "format": "uri-reference",
                    "title": "ID",
                    "description": "The unique identifier of the offer. It must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object.",
                    "meta:titleId": "offer##@id##title##32491",
                    "meta:descriptionId": "offer##@id##description##27951"
                },
                "xdm:name": {
                    "type": "string",
                    "title": "Name",
                    "description": "The offer's name. A human readable string to find one or more offers.",
                    "meta:titleId": "offer##xdm:name##title##6251",
                    "meta:descriptionId": "offer##xdm:name##description##33431"
                },
                "xdm:status": {
                    "type": "string",
                    "title": "Status",
                    "description": "Offer Status allows user workflows to be conducted with offers. The status may affect where an offer is visible or considered relevant. Status changes are driven by the clients or services that use offers.",
                    "enum": [
                        "draft",
                        "pending",
                        "rejected",
                        "approved",
                        "archived"
                    ],
                    "meta:enum": {
                        "draft": "Draft",
                        "pending": "Pending",
                        "rejected": "Rejected",
                        "approved": "Approved",
                        "archived": "Archived"
                    },
                    "meta:titleId": "offer##xdm:status##title##18431",
                    "meta:descriptionId": "offer##xdm:status##description##13911"
                },
                "xdm:tags": {
                    "type": "array",
                    "title": "Tags",
                    "description": "The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overall offer inventory to a topical sub set (category).",
                    "items": {
                        "type": "string",
                        "format": "uri",
                        "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/offer-management/tag",
                        "meta:descriptionId": "offer##items##description##4441"
                    },
                    "meta:titleId": "offer##xdm:tags##title##88891",
                    "meta:descriptionId": "offer##xdm:tags##description##25241"
                },
                "xdm:representations": {
                    "type": "array",
                    "items": {
                        "$ref": "https://ns.adobe.com/experience/offer-management/offer-representation"
                    },
                    "title": "Representations",
                    "description": "Offer representations for different content variants. A single offer can have multiple contents variants. An offer representation is the object that connects offers to content. Content is information that is directed towards an audience for consumption in a (digital) experience. Content is delivered through channels (or a particular medium). ",
                    "meta:titleId": "offer##xdm:representations##title##97361",
                    "meta:descriptionId": "offer##xdm:representations##description##23701"
                },
                "xdm:customMetadata": {
                    "type": "object",
                    "patternProperties": {
                        ".+": {
                            "type": "string"
                        }
                    },
                    "title": "Custom Properties",
                    "description": "Custom metadata is a key-value map that allows the end-users to attach properties to individual offer instances. Any string can be used as a key name, the values are also strings.",
                    "meta:titleId": "offer##xdm:customMetadata##title##53751",
                    "meta:descriptionId": "offer##xdm:customMetadata##description##59071"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/offer"
        },
        {
            "required": [
                "xdm:name",
                "xdm:status"
            ]
        }
    ],
    "meta:status": "deprecated",
    "meta:titleId": "offer##title##64401",
    "meta:descriptionId": "offer##description##96631",
    "examples": [
        {
            "@id": "xcore:personalized-offer:e526a1503bf29e9",
            "xdm:name": "Personalized Offer 1",
            "xdm:status": "approved",
            "xdm:representations": [
                {
                    "xdm:components": [
                        {
                            "xdm:text": "You can always get what you want!",
                            "@type": "https://ns.adobe.com/experience/offer-management/content-component-text",
                            "dc:format": "text/template"
                        }
                    ],
                    "xdm:channel": "https://ns.adobe.com/xdm/channels/email",
                    "xdm:placement": "xcore:offer-placement:e51944a87919861"
                }
            ],
            "xdm:tags": [
                "xcore:tag:e5196f1d9119862"
            ]
        }
    ]
}