xdm/docs/reference/adobe/experience/campaign/profile-snapshot.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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
{
    "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/campaign/profile-snapshot",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Adobe Campaign Profile Snapshot",
    "type": "object",
    "description": "Adobe Campaign Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.",
    "definitions": {
        "profile-snapshot": {
            "properties": {
                "xdm:person": {
                    "title": "Person",
                    "$ref": "https://ns.adobe.com/xdm/context/person",
                    "description": "An individual actor, contact, or owner.",
                    "meta:titleId": "profile-snapshot##xdm:person##title##92071",
                    "meta:descriptionId": "profile-snapshot##xdm:person##description##77591"
                },
                "xdm:directMarketingAddress": {
                    "title": "Direct Marketing Address",
                    "$ref": "https://ns.adobe.com/xdm/context/directmarketing-address",
                    "description": "Direct Marketing postal address.",
                    "meta:titleId": "profile-snapshot##xdm:directMarketingAddress##title##14181",
                    "meta:descriptionId": "profile-snapshot##xdm:directMarketingAddress##description##50151"
                },
                "xdm:directMarketingEmail": {
                    "title": "Direct Marketing Email",
                    "$ref": "https://ns.adobe.com/xdm/context/directmarketing-emailaddress",
                    "description": "Direct Marketing email address.",
                    "meta:titleId": "profile-snapshot##xdm:directMarketingEmail##title##71211",
                    "meta:descriptionId": "profile-snapshot##xdm:directMarketingEmail##description##44491"
                },
                "xdm:directMarketingPhone": {
                    "title": "Direct Marketing Phone",
                    "$ref": "https://ns.adobe.com/xdm/context/directmarketing-phonenumber",
                    "description": "Direct Marketing phone number.",
                    "meta:titleId": "profile-snapshot##xdm:directMarketingPhone##title##85161",
                    "meta:descriptionId": "profile-snapshot##xdm:directMarketingPhone##description##76961"
                },
                "xdm:pushNotificationTokens": {
                    "title": "Push Notification Tokens",
                    "type": "array",
                    "description": "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts.",
                    "items": {
                        "$ref": "https://ns.adobe.com/xdm/context/pushnotificationtoken"
                    },
                    "meta:titleId": "profile-snapshot##xdm:pushNotificationTokens##title##89531",
                    "meta:descriptionId": "profile-snapshot##xdm:pushNotificationTokens##description##89271"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/profile-snapshot"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "profile-snapshot##title##58281",
    "meta:descriptionId": "profile-snapshot##description##64561",
    "examples": [
        {
            "xdm:person": {
                "xdm:name": {
                    "xdm:firstName": "Jane",
                    "xdm:middleName": "F",
                    "xdm:lastName": "Doe",
                    "xdm:fullName": "Jane F. Doe"
                },
                "xdm:birthDayAndMonth": "01-03",
                "xdm:gender": "female"
            },
            "xdm:directMarketingPhone": {
                "xdm:primary": true,
                "xdm:number": "1-408-888-8888",
                "xdm:status": "active",
                "xdm:errorCount": 0
            },
            "xdm:directMarketingAddress": {
                "@id": "https://data.adobe.io/entities/address/123",
                "xdm:primary": false,
                "xdm:street1": "345 Park Ave",
                "xdm:city": "San Jose",
                "xdm:stateProvince": "US-CA",
                "xdm:postalCode": "95110",
                "xdm:country": "United States",
                "xdm:countryCode": "US",
                "schema:latitude": 37.3382,
                "schema:longitude": 121.8863,
                "xdm:status": "active",
                "xdm:lastVerifiedDate": "2018-01-02",
                "xdm:errorCount": 0,
                "xdm:quality": "Fully-recognized street"
            },
            "xdm:directMarketingEmail": {
                "xdm:primary": false,
                "xdm:address": "jsmith@xyzinc.com",
                "xdm:label": "John Smith",
                "xdm:type": "work",
                "xdm:status": "active",
                "xdm:errorCount": 0
            },
            "xdm:pushNotificationTokens": [
                {
                    "xdm:token": "ABC123DEFG",
                    "xdm:registrationDate": "2017-09-26T15:52:25+00:00",
                    "xdm:environment": {
                        "xdm:type": "browser",
                        "xdm:browserDetails": {
                            "xdm:name": "Chrome",
                            "xdm:version": "63.0.3239",
                            "xdm:acceptLanguage": "en",
                            "xdm:cookiesEnabled": true,
                            "xdm:javaScriptEnabled": true,
                            "xdm:javaScriptVersion": "1.8.5",
                            "xdm:javaEnabled": true,
                            "xdm:javaVersion": "Java SE 8",
                            "xdm:viewportHeight": 600,
                            "xdm:viewportWidth": 300
                        },
                        "xdm:operatingSystem": "iOS",
                        "xdm:operatingSystemVersion": "11.2.1",
                        "xdm:connectionType": "mobile"
                    },
                    "xdm:device": {
                        "xdm:typeId": "TypeIdentifier-111",
                        "xdm:typeIdService": "deviceAtlas",
                        "xdm:type": "mobile",
                        "xdm:manufacturer": "Apple",
                        "xdm:model": "iPhone 6",
                        "xdm:modelNumber": "A1586",
                        "xdm:screenHeight": 667,
                        "xdm:screenWidth": 375,
                        "xdm:colorDepth": 16777216
                    },
                    "xdm:application": {
                        "xdm:id": "Abc123",
                        "xdm:name": "facebook",
                        "xdm:version": "153.0"
                    },
                    "xdm:channel": {
                        "@id": "https://ns.adobe.com/xdm/channels/facebook-feed",
                        "@type": "https://ns.adobe.com/xdm/channel-types/social"
                    }
                }
            ]
        }
    ]
}