From f9f25a97054bb5a51fbfd840f7d1ec84923f0e10 Mon Sep 17 00:00:00 2001 From: jwen Date: Fri, 4 Sep 2020 13:04:01 -0700 Subject: [PATCH] Test 2 --- bin/pre-doc-gen.sh | 2 +- .../adcloud/advertisement.schema.json | 18 +- .../adcloud/advertisement.schema.md | 24 +- .../experience/adcloud/campaign.schema.json | 52 +- .../experience/adcloud/campaign.schema.md | 64 +-- .../proposition-detail.schema.json | 16 +- .../decisioning/proposition-detail.schema.md | 22 +- .../offer-representation.schema.json | 32 +- .../offer-representation.schema.md | 38 +- .../classes/experienceevent.schema.json | 478 ++++++++--------- .../classes/experienceevent.schema.md | 490 +++++++++--------- .../datatypes/application.schema.json | 10 +- .../reference/datatypes/application.schema.md | 12 +- .../datatypes/extensible.schema.json | 30 +- docs/reference/datatypes/extensible.schema.md | 36 +- docs/reference/datatypes/geo.schema.json | 14 +- docs/reference/datatypes/geo.schema.md | 20 +- .../media-timed-asset-reference.schema.json | 22 +- .../media-timed-asset-reference.schema.md | 28 +- .../datatypes/person-name.schema.json | 12 +- .../reference/datatypes/person-name.schema.md | 18 +- .../mixins/shared/identitymap.schema.json | 18 +- .../mixins/shared/identitymap.schema.md | 18 +- 23 files changed, 737 insertions(+), 737 deletions(-) diff --git a/bin/pre-doc-gen.sh b/bin/pre-doc-gen.sh index 785c11943d..03d8dcf2a6 100755 --- a/bin/pre-doc-gen.sh +++ b/bin/pre-doc-gen.sh @@ -1,4 +1,4 @@ mkdir -p docs/reference (rm -rf docsource; mkdir docsource) -cp -r schemas/* components/* docsource +cp -r schemas/* components/* extensions/* docsource node ./bin/doc-fix.js diff --git a/docs/reference/adobe/experience/adcloud/advertisement.schema.json b/docs/reference/adobe/experience/adcloud/advertisement.schema.json index 37d196e746..ef343dd648 100644 --- a/docs/reference/adobe/experience/adcloud/advertisement.schema.json +++ b/docs/reference/adobe/experience/adcloud/advertisement.schema.json @@ -132,15 +132,6 @@ "xdm:adUnitType": "HTML5", "xdm:promotedAssetId": "4116761052" }, - { - "xdm:creativeID": "301404063528", - "xdm:keywordID": "147741280", - "xdm:audienceID": "257600311580", - "xdm:adGroupID": "32345812783", - "xdm:campaignID": "663049855", - "xdm:networkType": "search", - "xdm:matchType": "broad" - }, { "@id": "14", "dsp:adKey": "yyyy029YLCDvseo8QhTE", @@ -153,6 +144,15 @@ "dsp:placementIds": [ "1" ] + }, + { + "xdm:creativeID": "301404063528", + "xdm:keywordID": "147741280", + "xdm:audienceID": "257600311580", + "xdm:adGroupID": "32345812783", + "xdm:campaignID": "663049855", + "xdm:networkType": "search", + "xdm:matchType": "broad" } ] } \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/advertisement.schema.md b/docs/reference/adobe/experience/adcloud/advertisement.schema.md index 4b86652a9a..2e173d1052 100644 --- a/docs/reference/adobe/experience/adcloud/advertisement.schema.md +++ b/docs/reference/adobe/experience/adcloud/advertisement.schema.md @@ -23,18 +23,6 @@ Adobe Advertising Cloud Ad Details. } ``` -```json -{ - "xdm:creativeID": "301404063528", - "xdm:keywordID": "147741280", - "xdm:audienceID": "257600311580", - "xdm:adGroupID": "32345812783", - "xdm:campaignID": "663049855", - "xdm:networkType": "search", - "xdm:matchType": "broad" -} -``` - ```json { "@id": "14", @@ -51,6 +39,18 @@ Adobe Advertising Cloud Ad Details. } ``` +```json +{ + "xdm:creativeID": "301404063528", + "xdm:keywordID": "147741280", + "xdm:audienceID": "257600311580", + "xdm:adGroupID": "32345812783", + "xdm:campaignID": "663049855", + "xdm:networkType": "search", + "xdm:matchType": "broad" +} +``` + # Adobe Advertising Cloud Ad Details Properties diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.json b/docs/reference/adobe/experience/adcloud/campaign.schema.json index 600f118a48..5ecd936adc 100644 --- a/docs/reference/adobe/experience/adcloud/campaign.schema.json +++ b/docs/reference/adobe/experience/adcloud/campaign.schema.json @@ -72,32 +72,6 @@ } ], "examples": [ - { - "xdm:accountId": "123456", - "xdm:dspId": "2", - "xdm:campaignId": "987654", - "xdm:placementId": "7656467", - "xdm:packageId": "98766172", - "xdm:advertiserId": "87612391", - "xdm:experimentId": "9812987", - "xdm:sampleGroupId": "8676378", - "xdm:currency": "USD" - }, - { - "@id": "12", - "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor", - "dsp:campaignName": "News At Cisco", - "dsp:campaignStatus": "Active", - "dsp:timezone": "America/New_York", - "dsp:type": "Media", - "dsp:userId": 495991, - "dsp:accountId": "1", - "dsp:advertiserId": "3", - "dsp:campaignStartTime": "2019-01-09 00:00:00", - "dsp:campaignEndTime": "2019-01-11 00:00:00", - "repo:createDate": "2019-04-26T14:00:00+00:00", - "repo:modifyDate": "2019-04-26T14:00:00+00:00" - }, { "xdm:id": "100001061", "xdm:campaignId": "10001234", @@ -112,6 +86,17 @@ "repo:createDate": "2019-04-26T14:00:00+00:00", "repo:modifyDate": "2019-04-26T14:00:00+00:00" }, + { + "xdm:accountId": "123456", + "xdm:dspId": "2", + "xdm:campaignId": "987654", + "xdm:placementId": "7656467", + "xdm:packageId": "98766172", + "xdm:advertiserId": "87612391", + "xdm:experimentId": "9812987", + "xdm:sampleGroupId": "8676378", + "xdm:currency": "USD" + }, { "@id": "100001061", "searchads:campaignId": "10001234", @@ -126,6 +111,21 @@ "searchads.CampaignObjective": "visit_web", "repo:createDate": "2019-04-26T14:00:00+00:00", "repo:modifyDate": "2019-04-26T14:00:00+00:00" + }, + { + "@id": "12", + "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor", + "dsp:campaignName": "News At Cisco", + "dsp:campaignStatus": "Active", + "dsp:timezone": "America/New_York", + "dsp:type": "Media", + "dsp:userId": 495991, + "dsp:accountId": "1", + "dsp:advertiserId": "3", + "dsp:campaignStartTime": "2019-01-09 00:00:00", + "dsp:campaignEndTime": "2019-01-11 00:00:00", + "repo:createDate": "2019-04-26T14:00:00+00:00", + "repo:modifyDate": "2019-04-26T14:00:00+00:00" } ] } \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.md b/docs/reference/adobe/experience/adcloud/campaign.schema.md index 85d842b7e3..66a82c1671 100644 --- a/docs/reference/adobe/experience/adcloud/campaign.schema.md +++ b/docs/reference/adobe/experience/adcloud/campaign.schema.md @@ -13,38 +13,6 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package, ## Ad Campaign Detail Examples -```json -{ - "xdm:accountId": "123456", - "xdm:dspId": "2", - "xdm:campaignId": "987654", - "xdm:placementId": "7656467", - "xdm:packageId": "98766172", - "xdm:advertiserId": "87612391", - "xdm:experimentId": "9812987", - "xdm:sampleGroupId": "8676378", - "xdm:currency": "USD" -} -``` - -```json -{ - "@id": "12", - "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor", - "dsp:campaignName": "News At Cisco", - "dsp:campaignStatus": "Active", - "dsp:timezone": "America/New_York", - "dsp:type": "Media", - "dsp:userId": 495991, - "dsp:accountId": "1", - "dsp:advertiserId": "3", - "dsp:campaignStartTime": "2019-01-09 00:00:00", - "dsp:campaignEndTime": "2019-01-11 00:00:00", - "repo:createDate": "2019-04-26T14:00:00+00:00", - "repo:modifyDate": "2019-04-26T14:00:00+00:00" -} -``` - ```json { "xdm:id": "100001061", @@ -62,6 +30,20 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package, } ``` +```json +{ + "xdm:accountId": "123456", + "xdm:dspId": "2", + "xdm:campaignId": "987654", + "xdm:placementId": "7656467", + "xdm:packageId": "98766172", + "xdm:advertiserId": "87612391", + "xdm:experimentId": "9812987", + "xdm:sampleGroupId": "8676378", + "xdm:currency": "USD" +} +``` + ```json { "@id": "100001061", @@ -80,6 +62,24 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package, } ``` +```json +{ + "@id": "12", + "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor", + "dsp:campaignName": "News At Cisco", + "dsp:campaignStatus": "Active", + "dsp:timezone": "America/New_York", + "dsp:type": "Media", + "dsp:userId": 495991, + "dsp:accountId": "1", + "dsp:advertiserId": "3", + "dsp:campaignStartTime": "2019-01-09 00:00:00", + "dsp:campaignEndTime": "2019-01-11 00:00:00", + "repo:createDate": "2019-04-26T14:00:00+00:00", + "repo:modifyDate": "2019-04-26T14:00:00+00:00" +} +``` + # Ad Campaign Detail Properties diff --git a/docs/reference/adobe/experience/decisioning/proposition-detail.schema.json b/docs/reference/adobe/experience/decisioning/proposition-detail.schema.json index d789e7f67a..01daa06745 100644 --- a/docs/reference/adobe/experience/decisioning/proposition-detail.schema.json +++ b/docs/reference/adobe/experience/decisioning/proposition-detail.schema.json @@ -59,14 +59,6 @@ } ], "examples": [ - { - "xdm:activity": { - "xdm:id": "xcore:offer-activity:f203512e02542b5" - }, - "xdm:fallback": { - "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a" - } - }, { "xdm:activity": { "xdm:id": "xcore:offer-activity:ebc48132c26ccfc", @@ -112,6 +104,14 @@ } } ] + }, + { + "xdm:activity": { + "xdm:id": "xcore:offer-activity:f203512e02542b5" + }, + "xdm:fallback": { + "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a" + } } ] } \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/proposition-detail.schema.md b/docs/reference/adobe/experience/decisioning/proposition-detail.schema.md index 9cf344b595..35d4d7af08 100644 --- a/docs/reference/adobe/experience/decisioning/proposition-detail.schema.md +++ b/docs/reference/adobe/experience/decisioning/proposition-detail.schema.md @@ -21,17 +21,6 @@ A decision proposition detail is used to capture the output of a decisioning act ## Decision Proposition Detail Examples -```json -{ - "xdm:activity": { - "xdm:id": "xcore:offer-activity:f203512e02542b5" - }, - "xdm:fallback": { - "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a" - } -} -``` - ```json { "xdm:activity": { @@ -81,6 +70,17 @@ A decision proposition detail is used to capture the output of a decisioning act } ``` +```json +{ + "xdm:activity": { + "xdm:id": "xcore:offer-activity:f203512e02542b5" + }, + "xdm:fallback": { + "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a" + } +} +``` + # Decision Proposition Detail Properties diff --git a/docs/reference/adobe/experience/offer-management/offer-representation.schema.json b/docs/reference/adobe/experience/offer-management/offer-representation.schema.json index a9af74d244..6736eb0c4c 100644 --- a/docs/reference/adobe/experience/offer-management/offer-representation.schema.json +++ b/docs/reference/adobe/experience/offer-management/offer-representation.schema.json @@ -137,22 +137,6 @@ } ], "examples": [ - { - "xdm:components": [ - { - "@type": "https://ns.adobe.com/experience/offer-management/content-component-html", - "dc:format": "text/html", - "dc:language": [ - "de" - ], - "repo:name": "widget_quickbooking.html", - "repo:id": "urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc", - "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc"" - } - ], - "xdm:placement": "uri:xcore:placement-0001", - "xdm:channel": "https://ns.adobe.com/xdm/channels/email" - }, { "xdm:components": [ { @@ -217,6 +201,22 @@ ], "xdm:placement": "uri:xcore:placement-0001", "xdm:channel": "https://ns.adobe.com/xdm/channels/email" + }, + { + "xdm:components": [ + { + "@type": "https://ns.adobe.com/experience/offer-management/content-component-html", + "dc:format": "text/html", + "dc:language": [ + "de" + ], + "repo:name": "widget_quickbooking.html", + "repo:id": "urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc", + "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc"" + } + ], + "xdm:placement": "uri:xcore:placement-0001", + "xdm:channel": "https://ns.adobe.com/xdm/channels/email" } ] } \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/offer-representation.schema.md b/docs/reference/adobe/experience/offer-management/offer-representation.schema.md index 54ade408f5..480069fabe 100644 --- a/docs/reference/adobe/experience/offer-management/offer-representation.schema.md +++ b/docs/reference/adobe/experience/offer-management/offer-representation.schema.md @@ -13,25 +13,6 @@ Offer representation. ## Representation Examples -```json -{ - "xdm:components": [ - { - "@type": "https://ns.adobe.com/experience/offer-management/content-component-html", - "dc:format": "text/html", - "dc:language": [ - "de" - ], - "repo:name": "widget_quickbooking.html", - "repo:id": "urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc", - "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc"" - } - ], - "xdm:placement": "uri:xcore:placement-0001", - "xdm:channel": "https://ns.adobe.com/xdm/channels/email" -} -``` - ```json { "xdm:components": [ @@ -103,6 +84,25 @@ Offer representation. } ``` +```json +{ + "xdm:components": [ + { + "@type": "https://ns.adobe.com/experience/offer-management/content-component-html", + "dc:format": "text/html", + "dc:language": [ + "de" + ], + "repo:name": "widget_quickbooking.html", + "repo:id": "urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc", + "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc"" + } + ], + "xdm:placement": "uri:xcore:placement-0001", + "xdm:channel": "https://ns.adobe.com/xdm/channels/email" +} +``` + # Representation Properties diff --git a/docs/reference/classes/experienceevent.schema.json b/docs/reference/classes/experienceevent.schema.json index 46d37bb04c..e397d0ec69 100644 --- a/docs/reference/classes/experienceevent.schema.json +++ b/docs/reference/classes/experienceevent.schema.json @@ -47,6 +47,245 @@ ], "meta:status": "stable", "examples": [ + { + "@id": "https://data.adobe.io/experienceid-2345678", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:eventMergeId": "9fb4e78d-b0bf-4d99-b987-cb37abdbcd15", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "92312748749128" + } + ], + "AVID": [ + { + "xdm:id": "2394509340-30453470347" + } + ] + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:locationContext": { + "xdm:geo": { + "xdm:countryCode": "US", + "xdm:stateProvince": "CA", + "xdm:city": "Emeryville", + "xdm:dmaid": "99" + } + }, + "xdm:web": { + "xdm:webPageView": { + "xdm:URL": "https://www.example.com" + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.examplereferrer.com/", + "xdm:domain": "examplereferrer.com" + } + }, + "xdm:device": { + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6" + }, + "xdm:advertising": { + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } + } + }, + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "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": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + }, + "xdm:profileStitch": [ + { + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } + } + ], + "xdm:segmentMemberships": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } + } + ] + }, { "@id": "https://data.adobe.io/experienceid-23456782", "xdm:dataSource": { @@ -203,87 +442,6 @@ } } }, - { - "@id": "https://data.adobe.io/experienceid-2345678", - "xdm:dataSource": { - "@id": "https://data.adobe.io/datasources/datasource-123", - "xdm:code": "DataSourceIntegrationCode-123" - }, - "xdm:timestamp": "2017-09-26T15:52:25+00:00", - "xdm:eventMergeId": "9fb4e78d-b0bf-4d99-b987-cb37abdbcd15", - "xdm:identityMap": { - "ECID": [ - { - "xdm:id": "92312748749128" - } - ], - "AVID": [ - { - "xdm:id": "2394509340-30453470347" - } - ] - }, - "xdm:environment": { - "xdm:type": "browser", - "xdm:browserDetails": { - "xdm:name": "Chrome", - "xdm:version": "63.0.3239", - "xdm:acceptLanguage": "en", - "xdm:cookiesEnabled": true, - "xdm:viewportHeight": 900, - "xdm:viewportWidth": 1680 - }, - "xdm:operatingSystem": "MAC OS", - "xdm:operatingSystemVersion": "10.13", - "xdm:connectionType": "cable" - }, - "xdm:locationContext": { - "xdm:geo": { - "xdm:countryCode": "US", - "xdm:stateProvince": "CA", - "xdm:city": "Emeryville", - "xdm:dmaid": "99" - } - }, - "xdm:web": { - "xdm:webPageView": { - "xdm:URL": "https://www.example.com" - }, - "xdm:webReferrer": { - "xdm:URL": "https://www.examplereferrer.com/", - "xdm:domain": "examplereferrer.com" - } - }, - "xdm:device": { - "xdm:type": "mobile", - "xdm:manufacturer": "Apple", - "xdm:model": "iPhone 6" - }, - "xdm:advertising": { - "xdm:adViewability": { - "xdm:adUnitDepth": 0, - "xdm:viewportHeight": 1250, - "xdm:viewportWidth": 1600, - "xdm:adHeight": 250, - "xdm:adWidth": 300, - "xdm:playerVolume": 85, - "xdm:measurementEligible": true, - "xdm:implementationDetails": { - "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", - "xdm:version": "1" - }, - "xdm:viewable": true, - "xdm:activeWindow": true, - "xdm:percentViewable": 89, - "xdm:viewableFirstQuartile": { - "xdm:value": 1 - } - }, - "xdm:firstQuartiles": { - "xdm:value": 1 - } - } - }, { "@id": "https://data.adobe.io/experienceid-123457", "xdm:timestamp": "2017-09-26T15:52:25+00:00", @@ -487,164 +645,6 @@ } } }, - { - "@id": "https://data.adobe.io/experienceid-123456", - "xdm:dataSource": { - "@id": "https://data.adobe.io/datasources/datasource-123", - "xdm:code": "DataSourceIntegrationCode-123" - }, - "xdm:timestamp": "2017-09-26T15:52:25+00:00", - "xdm:identityMap": { - "https://data.adobe.io/entities/namespace/4": [ - { - "xdm:id": "92312748749128" - } - ], - "https://data.adobe.io/entities/namespace/10": [ - { - "xdm:id": "2394509340-30453470347" - } - ], - "https://data.adobe.io/entities/namespace/9": [ - { - "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" - } - ] - }, - "xdm:channel": { - "@id": "https://ns.adobe.com/xdm/channels/apns", - "@type": "https://ns.adobe.com/xdm/channel-types/mobile" - }, - "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": 900, - "xdm:viewportWidth": 1680 - }, - "xdm:operatingSystem": "MAC OS", - "xdm:operatingSystemVersion": "10.13", - "xdm:connectionType": "cable" - }, - "xdm:productListItems": [ - { - "xdm:SKU": "1002352692", - "xdm:lineItemId": "12345678", - "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", - "xdm:currencyCode": "USD", - "xdm:quantity": 1, - "xdm:priceTotal": 159 - } - ], - "xdm:commerce": { - "xdm:order": { - "xdm:purchaseID": "a8g784hjq1mnp3", - "xdm:purchaseOrderNumber": "123456", - "xdm:payments": [ - { - "xdm:transactionID": "transactid-a111", - "xdm:paymentAmount": 59, - "xdm:paymentType": "credit_card", - "xdm:currencyCode": "USD" - }, - { - "xdm:transactionId": "transactid-a222", - "xdm:paymentAmount": 100, - "xdm:paymentType": "gift_card", - "xdm:currencyCode": "USD" - } - ], - "xdm:currencyCode": "USD", - "xdm:priceTotal": 159 - }, - "xdm:purchases": { - "xdm:value": 1 - } - }, - "xdm:placeContext": { - "xdm:localTime": "2017-09-26T15:52:25+13:00", - "xdm:geo": { - "@id": "https://data.adobe.io/entities/geo/tokyo", - "xdm:countryCode": "JP", - "xdm:stateProvince": "JP-13", - "xdm:city": "Tōkyō", - "xdm:postalCode": "141-0032", - "schema:latitude": 35.6185, - "schema:longitude": 139.73237 - } - }, - "xdm:web": { - "xdm:webPageDetails": { - "xdm:siteSection": "Shopping Cart", - "xdm:server": "example.com", - "xdm:name": "Purchase Confirmation", - "xdm:URL": "https://www.example.com/orderConf", - "xdm:errorPage": false, - "xdm:homePage": false, - "xdm:pageViews": { - "xdm:value": 1 - } - }, - "xdm:webReferrer": { - "xdm:URL": "https://www.example.com/checkout", - "xdm:referrerType": "internal" - } - }, - "xdm:marketing": { - "xdm:trackingCode": "marketingcampaign111" - }, - "xdm:profileStitch": [ - { - "xdm:profileStitchID": { - "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", - "xdm:namespace": { - "xdm:code": "AAM" - } - }, - "xdm:version": "1.0", - "xdm:identityMap": { - "ECID": [ - { - "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" - }, - { - "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" - }, - { - "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" - } - ] - } - } - ], - "xdm:segmentMemberships": [ - { - "xdm:segmentID": { - "@id": "https://data.adobe.io/entities/identity/92312748749128", - "xdm:namespace": { - "xdm:code": "AAM" - } - }, - "xdm:profileStitchID": { - "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", - "xdm:namespace": { - "xdm:code": "AAM" - }, - "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", - "xdm:version": "1.0", - "xdm:validUntil": "2017-12-26T15:52:25+00:00", - "xdm:status": "realized" - } - } - ] - }, { "@id": "https://data.adobe.io/experienceid-123458", "xdm:timestamp": "2017-09-26T15:52:25+00:00", diff --git a/docs/reference/classes/experienceevent.schema.md b/docs/reference/classes/experienceevent.schema.md index 3406b29bb7..138e0cbc56 100644 --- a/docs/reference/classes/experienceevent.schema.md +++ b/docs/reference/classes/experienceevent.schema.md @@ -20,6 +20,251 @@ An ExperienceEvent is a fact record of what occurred, including the point in tim ## XDM ExperienceEvent Examples +```json +{ + "@id": "https://data.adobe.io/experienceid-2345678", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:eventMergeId": "9fb4e78d-b0bf-4d99-b987-cb37abdbcd15", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "92312748749128" + } + ], + "AVID": [ + { + "xdm:id": "2394509340-30453470347" + } + ] + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:locationContext": { + "xdm:geo": { + "xdm:countryCode": "US", + "xdm:stateProvince": "CA", + "xdm:city": "Emeryville", + "xdm:dmaid": "99" + } + }, + "xdm:web": { + "xdm:webPageView": { + "xdm:URL": "https://www.example.com" + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.examplereferrer.com/", + "xdm:domain": "examplereferrer.com" + } + }, + "xdm:device": { + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6" + }, + "xdm:advertising": { + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } + } +} +``` + +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "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": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + }, + "xdm:profileStitch": [ + { + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } + } + ], + "xdm:segmentMemberships": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } + } + ] +} +``` + ```json { "@id": "https://data.adobe.io/experienceid-23456782", @@ -179,90 +424,6 @@ An ExperienceEvent is a fact record of what occurred, including the point in tim } ``` -```json -{ - "@id": "https://data.adobe.io/experienceid-2345678", - "xdm:dataSource": { - "@id": "https://data.adobe.io/datasources/datasource-123", - "xdm:code": "DataSourceIntegrationCode-123" - }, - "xdm:timestamp": "2017-09-26T15:52:25+00:00", - "xdm:eventMergeId": "9fb4e78d-b0bf-4d99-b987-cb37abdbcd15", - "xdm:identityMap": { - "ECID": [ - { - "xdm:id": "92312748749128" - } - ], - "AVID": [ - { - "xdm:id": "2394509340-30453470347" - } - ] - }, - "xdm:environment": { - "xdm:type": "browser", - "xdm:browserDetails": { - "xdm:name": "Chrome", - "xdm:version": "63.0.3239", - "xdm:acceptLanguage": "en", - "xdm:cookiesEnabled": true, - "xdm:viewportHeight": 900, - "xdm:viewportWidth": 1680 - }, - "xdm:operatingSystem": "MAC OS", - "xdm:operatingSystemVersion": "10.13", - "xdm:connectionType": "cable" - }, - "xdm:locationContext": { - "xdm:geo": { - "xdm:countryCode": "US", - "xdm:stateProvince": "CA", - "xdm:city": "Emeryville", - "xdm:dmaid": "99" - } - }, - "xdm:web": { - "xdm:webPageView": { - "xdm:URL": "https://www.example.com" - }, - "xdm:webReferrer": { - "xdm:URL": "https://www.examplereferrer.com/", - "xdm:domain": "examplereferrer.com" - } - }, - "xdm:device": { - "xdm:type": "mobile", - "xdm:manufacturer": "Apple", - "xdm:model": "iPhone 6" - }, - "xdm:advertising": { - "xdm:adViewability": { - "xdm:adUnitDepth": 0, - "xdm:viewportHeight": 1250, - "xdm:viewportWidth": 1600, - "xdm:adHeight": 250, - "xdm:adWidth": 300, - "xdm:playerVolume": 85, - "xdm:measurementEligible": true, - "xdm:implementationDetails": { - "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", - "xdm:version": "1" - }, - "xdm:viewable": true, - "xdm:activeWindow": true, - "xdm:percentViewable": 89, - "xdm:viewableFirstQuartile": { - "xdm:value": 1 - } - }, - "xdm:firstQuartiles": { - "xdm:value": 1 - } - } -} -``` - ```json { "@id": "https://data.adobe.io/experienceid-123457", @@ -469,167 +630,6 @@ An ExperienceEvent is a fact record of what occurred, including the point in tim } ``` -```json -{ - "@id": "https://data.adobe.io/experienceid-123456", - "xdm:dataSource": { - "@id": "https://data.adobe.io/datasources/datasource-123", - "xdm:code": "DataSourceIntegrationCode-123" - }, - "xdm:timestamp": "2017-09-26T15:52:25+00:00", - "xdm:identityMap": { - "https://data.adobe.io/entities/namespace/4": [ - { - "xdm:id": "92312748749128" - } - ], - "https://data.adobe.io/entities/namespace/10": [ - { - "xdm:id": "2394509340-30453470347" - } - ], - "https://data.adobe.io/entities/namespace/9": [ - { - "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" - } - ] - }, - "xdm:channel": { - "@id": "https://ns.adobe.com/xdm/channels/apns", - "@type": "https://ns.adobe.com/xdm/channel-types/mobile" - }, - "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": 900, - "xdm:viewportWidth": 1680 - }, - "xdm:operatingSystem": "MAC OS", - "xdm:operatingSystemVersion": "10.13", - "xdm:connectionType": "cable" - }, - "xdm:productListItems": [ - { - "xdm:SKU": "1002352692", - "xdm:lineItemId": "12345678", - "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", - "xdm:currencyCode": "USD", - "xdm:quantity": 1, - "xdm:priceTotal": 159 - } - ], - "xdm:commerce": { - "xdm:order": { - "xdm:purchaseID": "a8g784hjq1mnp3", - "xdm:purchaseOrderNumber": "123456", - "xdm:payments": [ - { - "xdm:transactionID": "transactid-a111", - "xdm:paymentAmount": 59, - "xdm:paymentType": "credit_card", - "xdm:currencyCode": "USD" - }, - { - "xdm:transactionId": "transactid-a222", - "xdm:paymentAmount": 100, - "xdm:paymentType": "gift_card", - "xdm:currencyCode": "USD" - } - ], - "xdm:currencyCode": "USD", - "xdm:priceTotal": 159 - }, - "xdm:purchases": { - "xdm:value": 1 - } - }, - "xdm:placeContext": { - "xdm:localTime": "2017-09-26T15:52:25+13:00", - "xdm:geo": { - "@id": "https://data.adobe.io/entities/geo/tokyo", - "xdm:countryCode": "JP", - "xdm:stateProvince": "JP-13", - "xdm:city": "Tōkyō", - "xdm:postalCode": "141-0032", - "schema:latitude": 35.6185, - "schema:longitude": 139.73237 - } - }, - "xdm:web": { - "xdm:webPageDetails": { - "xdm:siteSection": "Shopping Cart", - "xdm:server": "example.com", - "xdm:name": "Purchase Confirmation", - "xdm:URL": "https://www.example.com/orderConf", - "xdm:errorPage": false, - "xdm:homePage": false, - "xdm:pageViews": { - "xdm:value": 1 - } - }, - "xdm:webReferrer": { - "xdm:URL": "https://www.example.com/checkout", - "xdm:referrerType": "internal" - } - }, - "xdm:marketing": { - "xdm:trackingCode": "marketingcampaign111" - }, - "xdm:profileStitch": [ - { - "xdm:profileStitchID": { - "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", - "xdm:namespace": { - "xdm:code": "AAM" - } - }, - "xdm:version": "1.0", - "xdm:identityMap": { - "ECID": [ - { - "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" - }, - { - "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" - }, - { - "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" - } - ] - } - } - ], - "xdm:segmentMemberships": [ - { - "xdm:segmentID": { - "@id": "https://data.adobe.io/entities/identity/92312748749128", - "xdm:namespace": { - "xdm:code": "AAM" - } - }, - "xdm:profileStitchID": { - "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", - "xdm:namespace": { - "xdm:code": "AAM" - }, - "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", - "xdm:version": "1.0", - "xdm:validUntil": "2017-12-26T15:52:25+00:00", - "xdm:status": "realized" - } - } - ] -} -``` - ```json { "@id": "https://data.adobe.io/experienceid-123458", diff --git a/docs/reference/datatypes/application.schema.json b/docs/reference/datatypes/application.schema.json index 176d00ed18..7dfacb7dff 100644 --- a/docs/reference/datatypes/application.schema.json +++ b/docs/reference/datatypes/application.schema.json @@ -84,11 +84,6 @@ ], "meta:status": "stable", "examples": [ - { - "xdm:id": "A123", - "xdm:name": "Myapp", - "xdm:version": "1.0.1" - }, { "xdm:id": "A123", "xdm:name": "Myapp", @@ -97,6 +92,11 @@ "xdm:value": 1 }, "xdm:userPerspective": "foreground" + }, + { + "xdm:id": "A123", + "xdm:name": "Myapp", + "xdm:version": "1.0.1" } ] } \ No newline at end of file diff --git a/docs/reference/datatypes/application.schema.md b/docs/reference/datatypes/application.schema.md index 4450d4ffb0..cf4d8752b9 100644 --- a/docs/reference/datatypes/application.schema.md +++ b/docs/reference/datatypes/application.schema.md @@ -23,7 +23,11 @@ Details related to the application generated interactions. Application refers to { "xdm:id": "A123", "xdm:name": "Myapp", - "xdm:version": "1.0.1" + "xdm:version": "1.0.1", + "xdm:launches": { + "xdm:value": 1 + }, + "xdm:userPerspective": "foreground" } ``` @@ -31,11 +35,7 @@ Details related to the application generated interactions. Application refers to { "xdm:id": "A123", "xdm:name": "Myapp", - "xdm:version": "1.0.1", - "xdm:launches": { - "xdm:value": 1 - }, - "xdm:userPerspective": "foreground" + "xdm:version": "1.0.1" } ``` diff --git a/docs/reference/datatypes/extensible.schema.json b/docs/reference/datatypes/extensible.schema.json index d94460554b..19b6d44c35 100644 --- a/docs/reference/datatypes/extensible.schema.json +++ b/docs/reference/datatypes/extensible.schema.json @@ -304,6 +304,21 @@ ], "meta:status": "stable", "examples": [ + { + "https://ns.example.com/asset_name": "custom_asset_1", + "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", + "xdm:createDate": "2017-09-26T15:52:25+00:00", + "repo:createDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryCreatedBy": "lars", + "xdm:modifyDate": "2017-09-26T15:52:25+00:00", + "repo:modifyDate": "2017-09-26T15:52:25+00:00", + "xdm:repository_lastModifiedBy": "2017-09-26T15:52:25+00:00", + "repo:version": "15", + "dc:title": "This is an example", + "repo:size": 1632418, + "xdm:path": "/here", + "repo:etag": "15" + }, { "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", "xdm:createDate": "2017-09-26T15:52:25+00:00", @@ -362,21 +377,6 @@ "repo:size": 1632418, "xdm:path": "here", "repo:etag": "15" - }, - { - "https://ns.example.com/asset_name": "custom_asset_1", - "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", - "xdm:createDate": "2017-09-26T15:52:25+00:00", - "repo:createDate": "2017-09-26T15:52:25+00:00", - "xdm:repositoryCreatedBy": "lars", - "xdm:modifyDate": "2017-09-26T15:52:25+00:00", - "repo:modifyDate": "2017-09-26T15:52:25+00:00", - "xdm:repository_lastModifiedBy": "2017-09-26T15:52:25+00:00", - "repo:version": "15", - "dc:title": "This is an example", - "repo:size": 1632418, - "xdm:path": "/here", - "repo:etag": "15" } ] } \ No newline at end of file diff --git a/docs/reference/datatypes/extensible.schema.md b/docs/reference/datatypes/extensible.schema.md index 7ab1e19620..cb7298abcd 100644 --- a/docs/reference/datatypes/extensible.schema.md +++ b/docs/reference/datatypes/extensible.schema.md @@ -25,6 +25,24 @@ Replace `#/definitions/…` with the correct path to the `definitions` object in ## Extensibility base schema Examples +```json +{ + "https://ns.example.com/asset_name": "custom_asset_1", + "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", + "xdm:createDate": "2017-09-26T15:52:25+00:00", + "repo:createDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryCreatedBy": "lars", + "xdm:modifyDate": "2017-09-26T15:52:25+00:00", + "repo:modifyDate": "2017-09-26T15:52:25+00:00", + "xdm:repository_lastModifiedBy": "2017-09-26T15:52:25+00:00", + "repo:version": "15", + "dc:title": "This is an example", + "repo:size": 1632418, + "xdm:path": "/here", + "repo:etag": "15" +} +``` + ```json { "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", @@ -90,21 +108,3 @@ Replace `#/definitions/…` with the correct path to the `definitions` object in } ``` -```json -{ - "https://ns.example.com/asset_name": "custom_asset_1", - "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", - "xdm:createDate": "2017-09-26T15:52:25+00:00", - "repo:createDate": "2017-09-26T15:52:25+00:00", - "xdm:repositoryCreatedBy": "lars", - "xdm:modifyDate": "2017-09-26T15:52:25+00:00", - "repo:modifyDate": "2017-09-26T15:52:25+00:00", - "xdm:repository_lastModifiedBy": "2017-09-26T15:52:25+00:00", - "repo:version": "15", - "dc:title": "This is an example", - "repo:size": 1632418, - "xdm:path": "/here", - "repo:etag": "15" -} -``` - diff --git a/docs/reference/datatypes/geo.schema.json b/docs/reference/datatypes/geo.schema.json index 6e097cfb2b..64a3d2f095 100644 --- a/docs/reference/datatypes/geo.schema.json +++ b/docs/reference/datatypes/geo.schema.json @@ -67,13 +67,6 @@ ], "meta:status": "stable", "examples": [ - { - "@id": "https://data.adobe.io/entities/geo/potsdam", - "xdm:countryCode": "DE", - "xdm:stateProvince": "DE-BB", - "xdm:city": "Potsdam", - "xdm:postalCode": "14482" - }, { "@id": "https://data.adobe.io/entities/geo/tokyo", "xdm:countryCode": "JP", @@ -82,6 +75,13 @@ "xdm:postalCode": "141-0032", "schema:latitude": 35.6185, "schema:longitude": 139.73237 + }, + { + "@id": "https://data.adobe.io/entities/geo/potsdam", + "xdm:countryCode": "DE", + "xdm:stateProvince": "DE-BB", + "xdm:city": "Potsdam", + "xdm:postalCode": "14482" } ] } \ No newline at end of file diff --git a/docs/reference/datatypes/geo.schema.md b/docs/reference/datatypes/geo.schema.md index 61238c29e9..e9c1900cb1 100644 --- a/docs/reference/datatypes/geo.schema.md +++ b/docs/reference/datatypes/geo.schema.md @@ -18,16 +18,6 @@ The geographic related data where an event was observed. ## Geo Examples -```json -{ - "@id": "https://data.adobe.io/entities/geo/potsdam", - "xdm:countryCode": "DE", - "xdm:stateProvince": "DE-BB", - "xdm:city": "Potsdam", - "xdm:postalCode": "14482" -} -``` - ```json { "@id": "https://data.adobe.io/entities/geo/tokyo", @@ -40,6 +30,16 @@ The geographic related data where an event was observed. } ``` +```json +{ + "@id": "https://data.adobe.io/entities/geo/potsdam", + "xdm:countryCode": "DE", + "xdm:stateProvince": "DE-BB", + "xdm:city": "Potsdam", + "xdm:postalCode": "14482" +} +``` + # Geo Properties diff --git a/docs/reference/datatypes/media-timed-asset-reference.schema.json b/docs/reference/datatypes/media-timed-asset-reference.schema.json index 6cbe38c8f9..198b5adac4 100644 --- a/docs/reference/datatypes/media-timed-asset-reference.schema.json +++ b/docs/reference/datatypes/media-timed-asset-reference.schema.json @@ -149,17 +149,6 @@ } ], "examples": [ - { - "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234431", - "dc:title": "Stairway to Heaven", - "xdm:audio": { - "dc:creator": "Jimmy Page", - "xdm:artist": "Led Zeppelin", - "xdm:album": "Led Zeppelin IV" - }, - "xmpDM:duration": 482, - "xdm:streamType": "audio" - }, { "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", "dc:title": "Floki Begs Helga for Freedom", @@ -195,6 +184,17 @@ ], "xdm:firstAirDate": "2016-01-05", "xmpDM:releaseDate": "2016-01-25" + }, + { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234431", + "dc:title": "Stairway to Heaven", + "xdm:audio": { + "dc:creator": "Jimmy Page", + "xdm:artist": "Led Zeppelin", + "xdm:album": "Led Zeppelin IV" + }, + "xmpDM:duration": 482, + "xdm:streamType": "audio" } ] } \ No newline at end of file diff --git a/docs/reference/datatypes/media-timed-asset-reference.schema.md b/docs/reference/datatypes/media-timed-asset-reference.schema.md index eec19901c3..5c6ac1be8e 100644 --- a/docs/reference/datatypes/media-timed-asset-reference.schema.md +++ b/docs/reference/datatypes/media-timed-asset-reference.schema.md @@ -23,20 +23,6 @@ Asset information about the main content that was played, but present on all ads ## Timed media primary asset reference Examples -```json -{ - "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234431", - "dc:title": "Stairway to Heaven", - "xdm:audio": { - "dc:creator": "Jimmy Page", - "xdm:artist": "Led Zeppelin", - "xdm:album": "Led Zeppelin IV" - }, - "xmpDM:duration": 482, - "xdm:streamType": "audio" -} -``` - ```json { "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", @@ -76,6 +62,20 @@ Asset information about the main content that was played, but present on all ads } ``` +```json +{ + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234431", + "dc:title": "Stairway to Heaven", + "xdm:audio": { + "dc:creator": "Jimmy Page", + "xdm:artist": "Led Zeppelin", + "xdm:album": "Led Zeppelin IV" + }, + "xmpDM:duration": 482, + "xdm:streamType": "audio" +} +``` + # Timed media primary asset reference Properties diff --git a/docs/reference/datatypes/person-name.schema.json b/docs/reference/datatypes/person-name.schema.json index 8530407ecf..f4de961c75 100644 --- a/docs/reference/datatypes/person-name.schema.json +++ b/docs/reference/datatypes/person-name.schema.json @@ -57,12 +57,6 @@ ], "meta:status": "stable", "examples": [ - { - "xdm:firstName": "John", - "xdm:middleName": "S", - "xdm:lastName": "Doe", - "xdm:fullName": "John S. Doe" - }, { "xdm:firstName": "张", "xdm:lastName": "三", @@ -72,6 +66,12 @@ "xdm:firstName": "فلانة", "xdm:lastName": "الفلانية", "xdm:fullName": "فلانة الفلانية" + }, + { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" } ] } \ No newline at end of file diff --git a/docs/reference/datatypes/person-name.schema.md b/docs/reference/datatypes/person-name.schema.md index b34fb79a67..2094e5ffce 100644 --- a/docs/reference/datatypes/person-name.schema.md +++ b/docs/reference/datatypes/person-name.schema.md @@ -21,15 +21,6 @@ In addition, a number of optional properties are made available that can be used ## Person name Examples -```json -{ - "xdm:firstName": "John", - "xdm:middleName": "S", - "xdm:lastName": "Doe", - "xdm:fullName": "John S. Doe" -} -``` - ```json { "xdm:firstName": "张", @@ -46,6 +37,15 @@ In addition, a number of optional properties are made available that can be used } ``` +```json +{ + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" +} +``` + # Person name Properties diff --git a/docs/reference/mixins/shared/identitymap.schema.json b/docs/reference/mixins/shared/identitymap.schema.json index b583e05919..0ada61f8e5 100644 --- a/docs/reference/mixins/shared/identitymap.schema.json +++ b/docs/reference/mixins/shared/identitymap.schema.json @@ -41,7 +41,7 @@ "meta:status": "stable", "examples": [ { - "EMAIL": [ + "https://data.adobe.io/entities/namespace/4": [ { "xdm:id": "92312748749128" }, @@ -49,15 +49,20 @@ "xdm:id": "92312748749239" } ], - "CRM": [ + "https://data.adobe.io/entities/namespace/10": [ { "xdm:id": "2394509340-30453470347", "xdm:authenticatedState": "authenticated" } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } ] }, { - "https://data.adobe.io/entities/namespace/4": [ + "EMAIL": [ { "xdm:id": "92312748749128" }, @@ -65,16 +70,11 @@ "xdm:id": "92312748749239" } ], - "https://data.adobe.io/entities/namespace/10": [ + "CRM": [ { "xdm:id": "2394509340-30453470347", "xdm:authenticatedState": "authenticated" } - ], - "https://data.adobe.io/entities/namespace/9": [ - { - "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" - } ] } ] diff --git a/docs/reference/mixins/shared/identitymap.schema.md b/docs/reference/mixins/shared/identitymap.schema.md index a8a7f0ac5f..8281f85520 100644 --- a/docs/reference/mixins/shared/identitymap.schema.md +++ b/docs/reference/mixins/shared/identitymap.schema.md @@ -15,7 +15,7 @@ Defines a map containing a set of end user identities, keyed on either namespace ```json { - "EMAIL": [ + "https://data.adobe.io/entities/namespace/4": [ { "xdm:id": "92312748749128" }, @@ -23,18 +23,23 @@ Defines a map containing a set of end user identities, keyed on either namespace "xdm:id": "92312748749239" } ], - "CRM": [ + "https://data.adobe.io/entities/namespace/10": [ { "xdm:id": "2394509340-30453470347", "xdm:authenticatedState": "authenticated" } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } ] } ``` ```json { - "https://data.adobe.io/entities/namespace/4": [ + "EMAIL": [ { "xdm:id": "92312748749128" }, @@ -42,16 +47,11 @@ Defines a map containing a set of end user identities, keyed on either namespace "xdm:id": "92312748749239" } ], - "https://data.adobe.io/entities/namespace/10": [ + "CRM": [ { "xdm:id": "2394509340-30453470347", "xdm:authenticatedState": "authenticated" } - ], - "https://data.adobe.io/entities/namespace/9": [ - { - "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" - } ] } ```