xdm/docs/reference/datatypes/enduserids.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 2017 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/context/enduserids",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "End user IDs",
    "type": "object",
    "meta:extensible": true,
    "description": "The End User IDs schema is used to represent a federated identity of a visitor or known profile across a number of data sources.\n\nIt is an `object` that is using the `@id` of an XDM data source as keys.\nEach value consists of the (required) ID that is native to the data source, and (optional) metadata about the data source as well as (optional) confidence in the stitching.\n\nAdditionally, this schema can include a property that describes the data source that is responsible for identity stitching.\n",
    "minProperties": 1,
    "definitions": {
        "enduserids": {
            "properties": {
                "https://ns.adobe.com/experience/mcid": {
                    "title": "Adobe Marketing Cloud ID",
                    "$ref": "https://ns.adobe.com/xdm/context/identity",
                    "description": "A unique identifier from Adobe Marketing Cloud.",
                    "meta:titleId": "enduserids##https://ns.adobe.com/experience/mcid##title##64031",
                    "meta:descriptionId": "enduserids##https://ns.adobe.com/experience/mcid##description##26601"
                },
                "https://ns.adobe.com/experience/aaid": {
                    "title": "Adobe Analytics Cloud end user IDs",
                    "$ref": "https://ns.adobe.com/xdm/context/identity",
                    "description": "Adobe Analytics Cloud extension to end user IDs.",
                    "meta:titleId": "enduserids##https://ns.adobe.com/experience/aaid##title##70001",
                    "meta:descriptionId": "enduserids##https://ns.adobe.com/experience/aaid##description##24441"
                },
                "https://ns.adobe.com/experience/aacustomid": {
                    "title": "Adobe Analytics Cloud Custom end user IDs",
                    "$ref": "https://ns.adobe.com/xdm/context/identity",
                    "description": "An Adobe Analytics custom identifier passed in on a hit.",
                    "meta:titleId": "enduserids##https://ns.adobe.com/experience/aacustomid##title##37221",
                    "meta:descriptionId": "enduserids##https://ns.adobe.com/experience/aacustomid##description##4881"
                },
                "https://ns.adobe.com/experience/acid": {
                    "title": "Adobe Campaign end user IDs",
                    "$ref": "https://ns.adobe.com/xdm/context/identity",
                    "description": "Adobe Campaign extension to end user IDs.",
                    "meta:titleId": "enduserids##https://ns.adobe.com/experience/acid##title##90461",
                    "meta:descriptionId": "enduserids##https://ns.adobe.com/experience/acid##description##51781"
                },
                "https://ns.adobe.com/experience/tntid": {
                    "title": "Adobe Target end user IDs",
                    "$ref": "https://ns.adobe.com/xdm/context/identity",
                    "description": "Adobe Target extension to end user IDs.",
                    "meta:titleId": "enduserids##https://ns.adobe.com/experience/tntid##title##1081",
                    "meta:descriptionId": "enduserids##https://ns.adobe.com/experience/tntid##description##94431"
                },
                "https://ns.adobe.com/experience/adcloud": {
                    "title": "Adobe Advertising Cloud end user IDs",
                    "$ref": "https://ns.adobe.com/xdm/context/identity",
                    "description": "Adobe Advertising Cloud extension to end user IDs.",
                    "meta:titleId": "enduserids##https://ns.adobe.com/experience/adcloud##title##34081",
                    "meta:descriptionId": "enduserids##https://ns.adobe.com/experience/adcloud##description##63861"
                },
                "https://ns.adobe.com/experience/emailid": {
                    "title": "Email address IDs",
                    "$ref": "https://ns.adobe.com/xdm/context/identity",
                    "description": "Email addresses used as IDs.",
                    "meta:titleId": "enduserids##https://ns.adobe.com/experience/emailid##title##74951",
                    "meta:descriptionId": "enduserids##https://ns.adobe.com/experience/emailid##description##31311"
                },
                "https://ns.adobe.com/experience/phonenumberid": {
                    "title": "Phone number IDs",
                    "$ref": "https://ns.adobe.com/xdm/context/identity",
                    "description": "Phone numbers used as IDs.",
                    "meta:titleId": "enduserids##https://ns.adobe.com/experience/phonenumberid##title##36381",
                    "meta:descriptionId": "enduserids##https://ns.adobe.com/experience/phonenumberid##description##44741"
                }
            },
            "patternProperties": {
                ".+://.+": {
                    "description": "The identifier, including data source, foreign ID, and confidence. Note, `@id` must be identical to the property value.",
                    "type": "object",
                    "$ref": "https://ns.adobe.com/xdm/context/identity",
                    "meta:descriptionId": "enduserids##.+://.+##description##32591"
                }
            }
        }
    },
    "meta:keys": {
        "https://ns.adobe.com/experience/adcloud": "Adobe Advertising Cloud",
        "https://ns.adobe.com/experience/tntid": "Adobe Target",
        "https://ns.adobe.com/experience/acid": "Adobe Campaign",
        "https://ns.adobe.com/experience/aaid": "Adobe Analytics",
        "https://ns.adobe.com/experience/aacustomid": "Adobe Analytics custom",
        "https://ns.adobe.com/experience/mcid": "Marketing Cloud identity core service",
        "https://ns.adobe.com/experience/emailid": "Email address",
        "https://ns.adobe.com/experience/phonenumberid": "Phone number"
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/enduserids"
        }
    ],
    "meta:status": "stable",
    "meta:createdDate": "2020-08-10",
    "meta:titleId": "enduserids##title##7991",
    "meta:descriptionId": "enduserids##description##32421",
    "examples": [
        {
            "https://ns.adobe.com/experience/mcid": {
                "@id": "https://data.adobe.io/entities/identity/92312748749128",
                "xdm:namespace": {
                    "xdm:code": "ECID"
                }
            },
            "https://ns.adobe.com/experience/aaid": {
                "@id": "https://data.adobe.io/entities/identity/2394509340-30453470347",
                "xdm:namespace": {
                    "xdm:code": "AVID"
                }
            },
            "https://ns.adobe.com/experience/tntid": {
                "@id": "https://data.adobe.io/entities/identity/1233ce17-20e0-4a2c-8198-2a77fd60cf4d",
                "xdm:namespace": {
                    "xdm:code": "tnt0051"
                }
            }
        }
    ]
}