Issue-476 XDM schema definition for AdCloud Search surfer profiles

adobe · Sep 6, 2018 · 57a03d6 · 57a03d6
1 parent 067e31f
commit 57a03d6
Show file tree

Hide file tree

Showing 4 changed files with 207 additions and 0 deletions.
diff --git a/extensions/adobe/experience/adcloud/adcloud-search-profile.example.1.json b/extensions/adobe/experience/adcloud/adcloud-search-profile.example.1.json
@@ -0,0 +1,110 @@
+{
+  "xdm:identities": [
+    {
+      "xdm:id": "[email protected]",
+      "xdm:namespace": {
+        "xdm:code": "Email"
+      }
+    },
+    {
+      "xdm:id": "123-456",
+      "xdm:namespace": {
+        "xdm:code": "BB111"
+      }
+    }
+  ],
+  "xdm:person": {
+    "xdm:name": {
+      "xdm:givenName": "Jane",
+      "xdm:middleName": "F",
+      "xdm:surname": "Doe"
+    },
+    "xdm:birthMonth": 1,
+    "xdm:birthDay": 3,
+    "xdm:birthYear": 1996,
+    "xdm:gender": "female"
+  },
+  "xdm:workAddress": {
+    "@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:workEmail": {
+    "xdm:primary": false,
+    "xdm:address": "[email protected]",
+    "xdm:label": "John Smith",
+    "xdm:type": "work",
+    "xdm:status": "active"
+  },
+  "xdm:mobilePhone": {
+    "xdm:primary": true,
+    "xdm:number": "1-408-888-8888",
+    "xdm:status": "active"
+  },
+  "xdm:optInOut": {
+    "https://ns.adobe.com/xdm/channels/email": "pending",
+    "https://ns.adobe.com/xdm/channels/phone": "out",
+    "https://ns.adobe.com/xdm/channels/sms": "in",
+    "https://ns.adobe.com/xdm/channels/fax": "not_provided",
+    "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided",
+    "https://ns.adobe.com/xdm/channels/apns": "not_provided",
+    "xdm:globalOptout": false
+  },
+  "xdm:orgUnit": {
+    "@id": "https://data.adobe.io/org-apparals-men"
+  },
+  "xdm:geoUnit": {
+    "@id": "https://data.adobe.io/geo-france"
+  },
+  "xdm:segments": [
+    {
+      "xdm:segmentID": {
+        "@id": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9",
+        "xdm:namespace": {
+          "xdm:code": "AAM"
+        }
+      },
+      "xdm:version": "15",
+      "xdm:timestamp": "2018-04-26T15:52:25+00:00",
+      "xdm:validUntil": "2019-04-26T15:52:25+00:00",
+      "xdm:status": "existing"
+    },
+    {
+      "xdm:segmentID": {
+        "@id": "https://data.adobe.io/entities/identity/53cba6b2-a23b-454a-8069-fc41308f1c0f",
+        "xdm:namespace": {
+          "xdm:code": "AAM"
+        }
+      },
+      "xdm:version": "3",
+      "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00",
+      "xdm:validUntil": "2018-04-27T15:52:25+00:00",
+      "xdm:status": "realized"
+    }
+  ],
+  "xdm:synchronized-search-retargeting-entities": [
+    {
+      "xdm:retargeting-entity-id": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9",
+      "xdm:retargeting-entity-type": 3,
+      "xdm:timestamp": "2018-08-07T08:06:34.672Z",
+      "xdm:search-engine-id": 2,
+      "xdm:search-engine-data": "sample-conversion-id-123"
+    },
+    {
+      "xdm:retargeting-entity-id": "https://data.adobe.io/entities/identity/53cba6b2-a23b-454a-8069-fc41308f1c0f",
+      "xdm:retargeting-entity-type": 2,
+      "xdm:timestamp": "2018-08-09T08:06:34.672Z",
+      "xdm:search-engine-id": 1,
+      "xdm:search-engine-data": "sample-conversion-id-345"
+    }
+  ]
+}
diff --git a/extensions/adobe/experience/adcloud/adcloud-search-profile.schema.json b/extensions/adobe/experience/adcloud/adcloud-search-profile.schema.json
@@ -0,0 +1,39 @@
+{
+  "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/"
+  ],
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "https://ns.adobe.com/experience/adcloud/adcloud-search-profile",
+  "title": "Adobe AdCloud Search Profile Extension",
+  "type": "object",
+  "meta:extends": [
+    "https://ns.adobe.com/xdm/context/profile"
+  ],
+  "description": "Adobe AdCloud Search extension to Profile",
+  "definitions": {
+    "adcloud-search-profile": {
+      "properties": {
+        "synchronized-search-retargeting-entities": {
+          "title": "Search retargeting entities",
+          "type": "array",
+          "items": {
+            "$ref": "https://ns.adobe.com/experience/adcloud/synchronized-search-retargeting-entity"
+          },
+          "description": "List of Search retargeting entities"
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "https://ns.adobe.com/xdm/context/profile#/definitions/profile"
+    },
+    {
+      "$ref": "#/definitions/adcloud-search-profile"
+    }
+  ],
+  "meta:status": "experimental"
+}
diff --git a/extensions/adobe/experience/adcloud/synchronized-search-retargeting-entity.example.1.json b/extensions/adobe/experience/adcloud/synchronized-search-retargeting-entity.example.1.json
@@ -0,0 +1,7 @@
+{
+  "xdm:retargeting-entity-id": "https://data.adobe.io/entities/aam-segment/4238827",
+  "xdm:retargeting-entity-type": 3,
+  "xdm:timestamp": "2018-08-07T08:06:34.672Z",
+  "xdm:search-engine-id": 2,
+  "xdm:search-engine-data": "sample-conversion-id-123"
+}
diff --git a/extensions/adobe/experience/adcloud/synchronized-search-retargeting-entity.schema.json b/extensions/adobe/experience/adcloud/synchronized-search-retargeting-entity.schema.json
@@ -0,0 +1,51 @@
+{
+  "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/adcloud/synchronized-search-retargeting-entity",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "Synchronized Search Retargeting Entity",
+  "type": "object",
+  "description": "Details about AdCloud Search Retargeting Entity used for retargeting surfers on the Search channel.",
+  "definitions": {
+    "synchronized-search-retargeting-entity": {
+      "properties": {
+        "xdm:retargeting-entity-id": {
+          "title": "Retargeting entity ID",
+          "type": "string",
+          "description": "Id for the retargeting entity that would used to retarget the surfer."
+        },
+        "xdm:retargeting-entity-type": {
+          "title": "Retargeting entity type",
+          "type": "int",
+          "description": "Type of retargeting entity."
+        },
+        "xdm:timestamp": {
+          "title": "Timestamp",
+          "type": "string",
+          "format": "date-time",
+          "description": "The timestamp when the retargeting entity, e.g. aam-segment, was sycned to the search engine."
+        },
+        "xdm:search-engine-id": {
+          "title": "Search Engine ID",
+          "type": "int",
+          "description": "Internal mapping of search engines to IDs for Adcloud Search."
+        },
+        "xdm:search-engine-data": {
+          "title": "Search Engine Data",
+          "type": "string",
+          "description": "Conversion Id of the retargeting entity synced to search engine."
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/synchronized-search-retargeting-entity"
+    }
+  ],
+  "meta:status": "experimental"
+}