xdm/docs/reference/datatypes/comparisons.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
{
    "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/xdm/datatypes/comparisons",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Comparisons",
    "type": "object",
    "meta:extensible": true,
    "description": "Used for site comparisons, such as products, cards, rooms, flights, etc.",
    "definitions": {
        "comparisons": {
            "properties": {
                "xdm:comparisonAddition": {
                    "title": "Comparison Addition",
                    "type": "integer",
                    "description": "Tracked when an item is added to a comparison."
                },
                "xdm:comparisonCount": {
                    "title": "Comparison Count",
                    "type": "integer",
                    "description": "Count of the total number of items being compared."
                },
                "xdm:comparisonItems": {
                    "title": "Comparison List Items",
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "description": "An array of all item IDs/SKUs in the list of products.  "
                },
                "xdm:comparisonRemoval": {
                    "title": "Comparison Removal",
                    "type": "integer",
                    "description": "Tracked when an item is removed from a comparison."
                },
                "xdm:comparisonType": {
                    "title": "Comparison Type",
                    "type": "string",
                    "description": "Type of comparison tool in use."
                },
                "xdm:comparisonView": {
                    "title": "Comparison View",
                    "type": "integer",
                    "description": "Tracked when a comparison page is viewed."
                },
                "xdm:comparisonImpressions": {
                    "title": "Comparison Impressions",
                    "$ref": "https://ns.adobe.com/xdm/datatypes/impressions",
                    "description": "Extension of the impressions data type."
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/comparisons"
        }
    ],
    "meta:status": "experimental",
    "examples": [
        {}
    ]
}