xdm/docs/reference/adobe/experience/customerJourneyManagement/profile-counters-v2.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
{
    "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/customerJourneyManagement/profile-counters-v2",
    "title": "Profile Counters Extension",
    "description": "Holds a map of objects containing counter_value and expiryDate, keyed by counter_id.",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/profile"
    ],
    "definitions": {
        "profile-counters": {
            "properties": {
                "xdm:frequencyMap": {
                    "description": "A map from counter_id to objects containing counter_value, expiryDate",
                    "type": "object",
                    "meta:xdmType": "map",
                    "additionalProperties": {
                        "type": "object",
                        "properties": {
                            "xdm:value": {
                                "title": "Profile Counter Value",
                                "description": "Represents the latest value of the Profile Counter after being Incremented.",
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 9007199254740991
                            },
                            "xdm:expiryDate": {
                                "title": "Profile Counter Expiry",
                                "description": "Represents the TTL for the Profile Counter.",
                                "type": "string",
                                "format": "date-time"
                            }
                        },
                        "required": [
                            "xdm:value",
                            "xdm:expiryDate"
                        ]
                    }
                }
            },
            "required": [
                "xdm:frequencyMap"
            ]
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/profile-counters"
        }
    ],
    "required": [],
    "meta:status": "stable",
    "meta:titleId": "profilecounters##title##16505",
    "meta:descriptionId": "profilecounters##description##16505",
    "examples": [
        {
            "xdm:namespace": {
                "xdm:code": "ECID"
            },
            "xdm:id": "92312748749128",
            "xdm:frequencyMap": {
                "counter_id": {
                    "xdm:value": 100,
                    "xdm:expiryDate": "2021-10-22T09:02:15.541Z"
                }
            }
        },
        {
            "xdm:xid": "xid-92312748749128",
            "xdm:frequencyMap": {
                "counter_id": {
                    "xdm:value": 100,
                    "xdm:expiryDate": "2021-10-22T09:02:15.541Z"
                }
            }
        }
    ]
}