xdm/docs/reference/adobe/experience/offer-management/offer-activity-detail.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
{
    "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/"
    ],
    "$id": "https://ns.adobe.com/experience/offer-management/offer-activity-detail",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Offer Activity Detail",
    "type": "object",
    "meta:abstract": true,
    "meta:extensible": true,
    "meta:extends": [
        "https://ns.adobe.com/experience/decisioning/activity-detail"
    ],
    "description": "Offer activity detail is used to capture the attributes of an offer activity in a proposition or response.",
    "definitions": {
        "offer-activity-detail": {
            "properties": {
                "xdm:placement": {
                    "title": "Offer Placement",
                    "type": "string",
                    "format": "uri-reference",
                    "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-detail##xdm:placement##title##73731",
                    "meta:descriptionId": "offer-activity-detail##xdm:placement##description##4771"
                },
                "xdm:filter": {
                    "title": "Offer Filter",
                    "type": "string",
                    "format": "uri-reference",
                    "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-detail##xdm:filter##title##33541",
                    "meta:descriptionId": "offer-activity-detail##xdm:filter##description##16631"
                },
                "xdm:fallback": {
                    "title": "Fallback Offer",
                    "type": "string",
                    "format": "uri-reference",
                    "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-detail##xdm:fallback##title##55691",
                    "meta:descriptionId": "offer-activity-detail##xdm:fallback##description##53731"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/offer-activity-detail"
        },
        {
            "$ref": "https://ns.adobe.com/experience/decisioning/activity-detail"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "offer-activity-detail##title##42771",
    "meta:descriptionId": "offer-activity-detail##description##27421",
    "examples": [
        {
            "xdm:id": "xcore:offer-activity:f66f792de3c0ba9",
            "xdm:name": "Email - Next Best Offer",
            "xdm:placement": "xcore:offer-placement:f6524d27c2d6edd",
            "xdm:filter": "xcore:offer-filter:f66f792de3c0ba9",
            "xdm:fallback": "xcore:fallback-offer:f6529b31b3c0ba6"
        }
    ]
}