Issue-476 XDM schema definition for AdCloud Search surfer profiles #477

abhinnaagarwal-adobe · 2018-08-17T08:38:34Z

Please link to the issue #…
#476

kstreeter · 2018-08-30T15:20:00Z

I didn't get any response to my review comments on this one. It needs some work in terms of naming conventions. I am pushing this out of 0.9.5.

abhinnaagarwal-adobe · 2018-08-30T16:44:45Z

@kstreeter I dont see any review comments here, Where can I find the comments ?

kstreeter · 2018-08-21T23:01:40Z

extensions/adobe/experience/adcloud/synchronized-search-retargeting-entity.schema.json

+  "definitions": {
+    "synchronized-search-retargeting-entity": {
+      "properties": {
+        "xdm:retargeting-entity-id": {


…mplement review comments, follow camelCase for naming fields, refactor names

abhinnaagarwal-adobe · 2018-09-06T11:36:19Z

@kstreeter Kindly review the changes, I have implemented camelCasing for all fields. Also, I have refactored some field names.

kstreeter · 2018-09-13T16:32:16Z

extensions/adobe/experience/adcloud/adcloudremarketingprofile.example.1.json

+      "xdm:status": "realized"
+    }
+  ],
+  "xdm:syncedremarketingaudiences": [


Where is this property defined? I think this is the profile schema, but I didn't see any changes to the ad cloud profile in the PR.

also, this should be camelCase

This property got missed somehow in the commit. It was supposed to be present in adcloud remarketing profile.

…mplement review comments-2, fix missing field for syncedRemarketingList in adcloud profile, update field description for partner data

abhinnaagarwal-adobe · 2018-09-21T04:14:23Z

@kstreeter Kindly review the changes. I have implemented the review comments. Thanks.

Updated field "xdm:id" to "xdm:segmentID" to match the example and make it consistent with the same field in the segment schema

…ud-Search-surfer-profiles

make linter happy

kstreeter · 2018-09-24T20:46:35Z

Hey @abhinnaagarwal-adobe, I made one fix to make the schema definition of segment ID match the example. Please let me know if this isn't what you intended. Otherwise this one looks ready to merge.

abhinnaagarwal-adobe · 2018-09-25T05:48:32Z

@kstreeter Thanks for the approval.

cdegroot-adobe · 2018-09-25T18:48:58Z

extensions/adobe/experience/adcloud/partnerdata.schema.json

+  "definitions": {
+    "partnerdata": {
+      "properties": {
+        "xdm:id": {


You cannot redefine the type of "xdm:id". It is already defined as a string https://github.com/adobe/xdm/blob/master/schemas/context/identity.schema.json

Please convert this to a string or define a different property.

converted to string

cdegroot-adobe · 2018-09-25T18:49:23Z

extensions/adobe/experience/adcloud/partnerdata.example.1.json

@@ -0,0 +1,4 @@
+{
+  "xdm:id": 2,


see comment on the schema for this.

cdegroot-adobe · 2018-09-25T18:49:31Z

extensions/adobe/experience/adcloud/adcloudremarketingprofile.example.1.json

+      "xdm:timestamp": "2018-08-07T08:06:34.672Z",
+      "xdm:partnerDetails": [
+        {
+          "xdm:id": 2,


see comment on the schema for this.

cdegroot-adobe · 2018-09-25T18:49:40Z

extensions/adobe/experience/adcloud/adcloudremarketingprofile.example.1.json

+      "xdm:timestamp": "2018-08-07T08:06:34.672Z",
+      "xdm:partnerDetails": [
+        {
+          "xdm:id": 2,


see comment on the schema for this.

cdegroot-adobe · 2018-09-25T18:51:14Z

extensions/adobe/experience/adcloud/adcloudremarketingprofile.schema.json

+            "$ref":
+              "https://ns.adobe.com/experience/adcloud/syncedremarketingaudience"
+          },
+          "description": "List of Search retargeting entities"


This is description is not helping me understand the actual way to use this, can it be improved please?

cdegroot-adobe · 2018-09-25T18:52:41Z

extensions/adobe/experience/adcloud/partnerdata.schema.json

+          "description":
+            "Internal mapping of search/marketing platforms/partners to IDs for Adcloud Search."
+        },
+        "xdm:data": {


Is this some sort of packed/complex multi value data value?

Yes, We are planning to use it to store data such as conversion id/ conversion label that adCloud Search partner such as Google or Facebook will return. The conversion id is a unique identifier that is linked to a segment id. Also, we can use the same segment to create audiences on multiple partner platforms, hence this data-structure

cdegroot-adobe

I have two concerns about this PR. I am not ready to approve.

This seems like a straightforward audience assertion. Which we already have a segments[] property for. Why is this a new definition. Can you please review with @harleensahni to see if this can be integrated with the current definitions.
There is a redefinition of the type of "xdm:id". It needs to be a string, or a different property.

…mplement review comments-3, Make partner id as string

abhinnaagarwal-adobe · 2018-09-26T05:45:02Z

@cdegroot-adobe I have implemented the review comments. Kindly review the changes.

We want to store details about a retargeting entity supported by RLSA server. This is used to retarget surfers across different search platforms. The retargeting entity data (segment data) is synced to search engines, and RLSA server needs to keep a record on what has been synced to avoid resyncing. The search engine will return a unique identifier for the synced entity for eg conversion id label etc, which has to be stored in the surfer profile. Also, we can use the same retargeting entity to create audiences on multiple partner platforms.

We could have used payload values in segment membership to store the data, if the payload values would support an arbitrary map where we can store all the data related to the segment

harleensahni · 2018-09-26T18:00:02Z

extensions/adobe/experience/adcloud/syncedremarketingaudiences.schema.json

+  "definitions": {
+    "syncedremarketingaudience": {
+      "properties": {
+        "xdm:segmentID": {


Why not use SegmentIdentity here as the type?

harleensahni · 2018-09-26T18:13:54Z

extensions/adobe/experience/adcloud/syncedremarketingaudiences.example.1.json

+{
+  "xdm:segmentId": "https://data.adobe.io/entities/aam-segment/4238827",
+  "xdm:segmentType": 3,
+  "xdm:timestamp": "2018-08-07T08:06:34.672Z",


This timestamp might be better in partner details to signify when the sync happened with the partner since it could have happened for one and not the other

harleensahni · 2018-09-26T18:15:20Z

extensions/adobe/experience/adcloud/syncedremarketingaudiences.example.1.json

+  "xdm:partnerDetails": [
+    {
+      "xdm:id": "2",
+      "xdm:data": "sample-conversion-id-123"


the xdm:data seems like it should live elsewhere since this mapping between segment in AAM to external system like google for facebook is always the same from one AAM segment to one FB or Google Segment and divorced from the concept of when semgent was synced for an individual user

You could structure this with partner details using segmemnt membership to store synced timestamp in the payload, but would need to repeat for each partner

harleensahni · 2018-09-26T18:22:46Z

We should find someplace to place the mapping from a segment in our systems (like AAM) to the segment id in another system like Google's for Facebooks. This feels like it belongs somewhere where se store segment definitions, and not segment memberships. The timestamps for when a segment for a user was synced with Google or Facebook seems like it could be a part of segment membership payload.
Perhaps we can create a new segment schema for mapping of segment identity to other segment identity xdm/schemas/context/segmentidentity.schema.json

harleensahni · 2018-09-26T18:24:21Z

Reviewed, comments left. Comments do not need to be addressed since I do not have adequate background on the project, and this is internal to AdCloud. I think if AdCloud can change this schema later without it being a breaking change for any other team (which should definitely be the case since it's there own extension -- if that's not a case that raises serious questions about the purpose of extension), it's fine to proceed.

cdegroot-adobe

My clarifications have been answered. I approve, thank you team.

kstreeter · 2018-09-27T17:39:22Z

Hey all, I filed #520 to track Harleen's suggestions. We don't actually have a model for segment definitions in XDM yet, so we can't do this now but we should address when a segment model is created.

…ud-Search-surfer-profiles

kstreeter added this to the 0.9.5 milestone Aug 23, 2018

kstreeter modified the milestones: 0.9.5, 1.0 Aug 30, 2018

kstreeter reviewed Sep 5, 2018

View reviewed changes

Issue-476 XDM schema definition for AdCloud Search surfer profiles

57a03d6

abhinnaagarwal-adobe force-pushed the Issue-476--XDM-schema-definition-for-AdCloud-Search-surfer-profiles branch from 3c997f9 to 57a03d6 Compare September 6, 2018 05:46

Issue-476 XDM schema definition for AdCloud Search surfer profiles, i…

217b49e

…mplement review comments, follow camelCase for naming fields, refactor names

kstreeter modified the milestones: 1.0, 0.9.6 Sep 13, 2018

kstreeter requested changes Sep 20, 2018

View reviewed changes

Issue-476 XDM schema definition for AdCloud Search surfer profiles, i…

51c8625

…mplement review comments-2, fix missing field for syncedRemarketingList in adcloud profile, update field description for partner data

kstreeter added 3 commits September 24, 2018 13:36

Update syncedremarketingaudiences.schema.json

b29bee2

Updated field "xdm:id" to "xdm:segmentID" to match the example and make it consistent with the same field in the segment schema

Update adcloudremarketingprofile.example.1.json

31a9acd

Updated field "xdm:id" to "xdm:segmentID" to match the example and make it consistent with the same field in the segment schema

Merge branch 'master' into Issue-476--XDM-schema-definition-for-AdClo…

ef88b8d

…ud-Search-surfer-profiles

kstreeter approved these changes Sep 24, 2018

View reviewed changes

kstreeter added 3 commits September 24, 2018 13:40

Update partnerdata.schema.json

d9aa109

make linter happy

Update adcloudremarketingprofile.schema.json

9431db0

make linter happy

Update adcloudremarketingprofile.schema.json

0d51712

cdegroot-adobe reviewed Sep 25, 2018

View reviewed changes

cdegroot-adobe suggested changes Sep 25, 2018

View reviewed changes

Issue-476 XDM schema definition for AdCloud Search surfer profiles, i…

1bea625

…mplement review comments-3, Make partner id as string

harleensahni reviewed Sep 26, 2018

View reviewed changes

cdegroot-adobe approved these changes Sep 27, 2018

View reviewed changes

kstreeter mentioned this pull request Sep 27, 2018

Segment definition needs to include mapping to equivalent definition from external partners #520

Open

Merge branch 'master' into Issue-476--XDM-schema-definition-for-AdClo…

6a11578

…ud-Search-surfer-profiles

kstreeter merged commit 6c36878 into adobe:master Sep 27, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue-476 XDM schema definition for AdCloud Search surfer profiles #477

Issue-476 XDM schema definition for AdCloud Search surfer profiles #477

abhinnaagarwal-adobe commented Aug 17, 2018

kstreeter commented Aug 30, 2018

abhinnaagarwal-adobe commented Aug 30, 2018

kstreeter Aug 21, 2018

abhinnaagarwal-adobe commented Sep 6, 2018 •

edited

Loading

kstreeter Sep 13, 2018

kstreeter Sep 13, 2018

abhinnaagarwal-adobe Sep 21, 2018

abhinnaagarwal-adobe Sep 21, 2018

abhinnaagarwal-adobe commented Sep 21, 2018

kstreeter commented Sep 24, 2018

abhinnaagarwal-adobe commented Sep 25, 2018

cdegroot-adobe Sep 25, 2018

abhinnaagarwal-adobe Sep 26, 2018

cdegroot-adobe Sep 25, 2018

cdegroot-adobe Sep 25, 2018

cdegroot-adobe Sep 25, 2018

cdegroot-adobe Sep 25, 2018

cdegroot-adobe Sep 25, 2018

abhinnaagarwal-adobe Sep 26, 2018

cdegroot-adobe left a comment

abhinnaagarwal-adobe commented Sep 26, 2018 •

edited

Loading

harleensahni Sep 26, 2018

harleensahni Sep 26, 2018

harleensahni Sep 26, 2018

harleensahni Sep 26, 2018

harleensahni commented Sep 26, 2018

harleensahni commented Sep 26, 2018

cdegroot-adobe left a comment

kstreeter commented Sep 27, 2018

Issue-476 XDM schema definition for AdCloud Search surfer profiles #477

Issue-476 XDM schema definition for AdCloud Search surfer profiles #477

Conversation

abhinnaagarwal-adobe commented Aug 17, 2018

kstreeter commented Aug 30, 2018

abhinnaagarwal-adobe commented Aug 30, 2018

Choose a reason for hiding this comment

abhinnaagarwal-adobe commented Sep 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abhinnaagarwal-adobe commented Sep 21, 2018

kstreeter commented Sep 24, 2018

abhinnaagarwal-adobe commented Sep 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cdegroot-adobe left a comment

Choose a reason for hiding this comment

abhinnaagarwal-adobe commented Sep 26, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harleensahni commented Sep 26, 2018

harleensahni commented Sep 26, 2018

cdegroot-adobe left a comment

Choose a reason for hiding this comment

kstreeter commented Sep 27, 2018

abhinnaagarwal-adobe commented Sep 6, 2018 •

edited

Loading

abhinnaagarwal-adobe commented Sep 26, 2018 •

edited

Loading