diff --git a/CHANGELOG.md b/CHANGELOG.md index 4698549c9..e593794ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,34 @@ # Changelog +## Release 0.9.6 + +[Released on September 28, 2018](https://github.com/adobe/xdm/releases/tag/v0.9.6) + +Fixed Issues + +* XDM schema definition for AdCloud Search surfer profiles in AdCloud extension + * PR #477 XDM schema definition for AdCloud Search surfer profiles +* Fix lint checks against extensions + * PR #485 Fix lint checks against extensions +* Define Logical Data Types for XDM + * PR #495 First draft of data type description +* Add the Supplemental Data Identifier field to the Adobe Target extension + * PR #509 Add the Supplemental Data Identifier field to the Adobe Target extension +* Define a Map Data Type for XDM + * PR #511 Define "map" XDM type +* XDM requires many ID's under experience event schema to be length > 20 ... + * PR #524 Removing minLength constraint on measure ids + +Merged Pull Requests + +* #467 Fixed typo in transactionID +* #492 Journey AI Fatigue and Score schemas +* #504 Correct profile stitching +* #505 Added "eventID" depreciated "businessReason" in Campaign ExperienceEvent extension. +* #506 Updating titles so that they no longer collide +* #513 PR 504 - Updates to make changes additive +* #515 improve name for email fatigue scores in experience event + ## Release 0.9.5 [Released on August 31, 2018](https://github.com/adobe/xdm/releases/tag/v0.9.5) diff --git a/README.md b/README.md index 19a45dd4d..a2091dc80 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This repository contains the source code for the formal specification of the XDM ## Current Version -XDM is at version `0.9.3`. +XDM is at version `0.9.6`. You can find more about our versioning in [docs/introduction.md](docs/introduction.md#versioning) diff --git a/docs/introduction.md b/docs/introduction.md index 2e52d142c..c7f03b827 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -2,7 +2,7 @@ xdm:navOrder: 1 --- -# Experience Data Model (XDM) Version 0.9.5 +# Experience Data Model (XDM) Version 0.9.6 ## Introduction diff --git a/docs/reference/README.md b/docs/reference/README.md index 6efaa87bb..a9b51b03a 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -4,6 +4,16 @@ +## /content/ + +* [Component Container](./content/component-container.schema.md) – `https://ns.adobe.com/xdm/content/component-container` (Experimental) +* [Componentized Page](./content/componentized-page.schema.md) – `https://ns.adobe.com/xdm/content/componentized-page` (Experimental) +* [Content](./content/content.schema.md) – `https://ns.adobe.com/xdm/content/content` (Experimental) +* [Content Repository](./content/repository.schema.md) – `https://ns.adobe.com/xdm/content/repository` (Experimental) +* [Page Component](./content/page-component.schema.md) – `https://ns.adobe.com/xdm/content/page-component` (Experimental) +* [Product](./content/product.schema.md) – `https://ns.adobe.com/xdm/context/product` (Experimental) +* [Product List Item](./content/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` (Experimental) + ## /assets/ * [Aggregated Asset](./assets/aggregated-asset.schema.md) – `https://ns.adobe.com/xdm/assets/aggregated-asset` (Experimental) @@ -20,16 +30,6 @@ * [Simple Rectangular Area](./assets/rectangular.schema.md) – `https://ns.adobe.com/xdm/assets/rectangular` (Stabilizing) * [Video](./assets/video.schema.md) – `https://ns.adobe.com/xdm/assets/video` (Experimental) -## /content/ - -* [Component Container](./content/component-container.schema.md) – `https://ns.adobe.com/xdm/content/component-container` (Experimental) -* [Componentized Page](./content/componentized-page.schema.md) – `https://ns.adobe.com/xdm/content/componentized-page` (Experimental) -* [Content](./content/content.schema.md) – `https://ns.adobe.com/xdm/content/content` (Experimental) -* [Content Repository](./content/repository.schema.md) – `https://ns.adobe.com/xdm/content/repository` (Experimental) -* [Page Component](./content/page-component.schema.md) – `https://ns.adobe.com/xdm/content/page-component` (Experimental) -* [Product](./content/product.schema.md) – `https://ns.adobe.com/xdm/context/product` (Experimental) -* [Product List Item](./content/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` (Experimental) - ## /common/ * [Address](./common/address.schema.md) – `https://ns.adobe.com/xdm/common/address` (Stabilizing) @@ -45,29 +45,6 @@ * [Page](./common/page.schema.md) – `https://ns.adobe.com/xdm/common/page` (Experimental) * [Principal](./common/principal.schema.md) – `https://ns.adobe.com/xdm/common/principal` (Experimental) -## /channels/ - -* [ADM](./channels/adm.schema.md) – `https://ns.adobe.com/xdm/channels/adm` (Experimental) -* [APNS](./channels/apns.schema.md) – `https://ns.adobe.com/xdm/channels/apns` (Experimental) -* [Application](./channels/application.schema.md) – `https://ns.adobe.com/xdm/channels/application` (Experimental) -* [Baidu](./channels/baidu.schema.md) – `https://ns.adobe.com/xdm/channels/baidu` (Experimental) -* [Direct Mail](./channels/direct-mail.schema.md) – `https://ns.adobe.com/xdm/channels/direct-mail` (Experimental) -* [E-Mail](./channels/agency.schema.md) – `https://ns.adobe.com/xdm/channels/agency` (Experimental) -* [E-Mail](./channels/email.schema.md) – `https://ns.adobe.com/xdm/channels/email` (Experimental) -* [Experience Channel](./channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` (Experimental) -* [Facebook News Feed](./channels/facebook-feed.schema.md) – `https://ns.adobe.com/xdm/channels/facebook-feed` (Experimental) -* [Fax](./channels/fax.schema.md) – `https://ns.adobe.com/xdm/channels/fax` (Experimental) -* [GCM](./channels/gcm.schema.md) – `https://ns.adobe.com/xdm/channels/gcm` (Experimental) -* [LINE](./channels/line.schema.md) – `https://ns.adobe.com/xdm/channels/line` (Experimental) -* [MPNS](./channels/mpns.schema.md) – `https://ns.adobe.com/xdm/channels/mpns` (Experimental) -* [Phone](./channels/phone.schema.md) – `https://ns.adobe.com/xdm/channels/phone` (Experimental) -* [SMS](./channels/sms.schema.md) – `https://ns.adobe.com/xdm/channels/sms` (Experimental) -* [Twitter Feed](./channels/twitter-feed.schema.md) – `https://ns.adobe.com/xdm/channels/twitter-feed` (Experimental) -* [WNS](./channels/wns.schema.md) – `https://ns.adobe.com/xdm/channels/wns` (Experimental) -* [WeChat](./channels/wechat.schema.md) – `https://ns.adobe.com/xdm/channels/wechat` (Experimental) -* [Web](./channels/mobile-app.schema.md) – `https://ns.adobe.com/xdm/channels/mobile-app` (Experimental) -* [Web](./channels/web.schema.md) – `https://ns.adobe.com/xdm/channels/web` (Experimental) - ## /context/ * [Ad Asset Reference](./context/advertising-timed-asset-reference.schema.md) – `https://ns.adobe.com/xdm/context/advertising-timed-asset-reference` (Experimental) @@ -195,12 +172,56 @@ * [viewable-midpoints](./data/viewablemidpoints.schema.md) – `https://ns.adobe.com/xdm/data/viewablemidpoints` (Stabilizing) * [viewable-third-quartiles](./data/viewablethirdquartiles.schema.md) – `https://ns.adobe.com/xdm/data/viewablethirdquartiles` (Stabilizing) +## /channels/ + +* [ADM](./channels/adm.schema.md) – `https://ns.adobe.com/xdm/channels/adm` (Experimental) +* [APNS](./channels/apns.schema.md) – `https://ns.adobe.com/xdm/channels/apns` (Experimental) +* [Application](./channels/application.schema.md) – `https://ns.adobe.com/xdm/channels/application` (Experimental) +* [Baidu](./channels/baidu.schema.md) – `https://ns.adobe.com/xdm/channels/baidu` (Experimental) +* [Direct Mail](./channels/direct-mail.schema.md) – `https://ns.adobe.com/xdm/channels/direct-mail` (Experimental) +* [E-Mail](./channels/agency.schema.md) – `https://ns.adobe.com/xdm/channels/agency` (Experimental) +* [E-Mail](./channels/email.schema.md) – `https://ns.adobe.com/xdm/channels/email` (Experimental) +* [Experience Channel](./channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` (Experimental) +* [Facebook News Feed](./channels/facebook-feed.schema.md) – `https://ns.adobe.com/xdm/channels/facebook-feed` (Experimental) +* [Fax](./channels/fax.schema.md) – `https://ns.adobe.com/xdm/channels/fax` (Experimental) +* [GCM](./channels/gcm.schema.md) – `https://ns.adobe.com/xdm/channels/gcm` (Experimental) +* [LINE](./channels/line.schema.md) – `https://ns.adobe.com/xdm/channels/line` (Experimental) +* [MPNS](./channels/mpns.schema.md) – `https://ns.adobe.com/xdm/channels/mpns` (Experimental) +* [Phone](./channels/phone.schema.md) – `https://ns.adobe.com/xdm/channels/phone` (Experimental) +* [SMS](./channels/sms.schema.md) – `https://ns.adobe.com/xdm/channels/sms` (Experimental) +* [Twitter Feed](./channels/twitter-feed.schema.md) – `https://ns.adobe.com/xdm/channels/twitter-feed` (Experimental) +* [WNS](./channels/wns.schema.md) – `https://ns.adobe.com/xdm/channels/wns` (Experimental) +* [WeChat](./channels/wechat.schema.md) – `https://ns.adobe.com/xdm/channels/wechat` (Experimental) +* [Web](./channels/mobile-app.schema.md) – `https://ns.adobe.com/xdm/channels/mobile-app` (Experimental) +* [Web](./channels/web.schema.md) – `https://ns.adobe.com/xdm/channels/web` (Experimental) + ## /content/repository-policies/ * [At-Rest Encryption](./content/repository-policies/encryption.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/encryption` (Experimental) * [Storage Quota](./content/repository-policies/quota.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/quota` (Experimental) * [Versioning](./content/repository-policies/versioning.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/versioning` (Experimental) +## /common/descriptors/ + +* [Item Selector](./common/descriptors/itemselector.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/itemselector` (Experimental) +* [Relationship Descriptor](./common/descriptors/relationshipdescriptor.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor` (Experimental) +* [Schema Descriptor](./common/descriptors/schemadescriptor.schema.md) – `https://ns.adobe.com/xdm/common/desciptors/schemadescriptor` (Experimental) + +## /common/event/ + +* [Created Event](./common/event/created.schema.md) – `https://ns.adobe.com/xdm/common/event/created` (Experimental) +* [Deleted Event](./common/event/deleted.schema.md) – `https://ns.adobe.com/xdm/common/event/deleted` (Experimental) +* [Emitted Event](./common/event/emitted.schema.md) – `https://ns.adobe.com/xdm/common/event/emitted` (Experimental) +* [Published Event](./common/event/published.schema.md) – `https://ns.adobe.com/xdm/common/event/published` (Experimental) +* [Rejected Event](./common/event/rejected.schema.md) – `https://ns.adobe.com/xdm/common/event/rejected` (Experimental) +* [Unpublished Event](./common/event/unpublished.schema.md) – `https://ns.adobe.com/xdm/common/event/unpublished` (Experimental) +* [Updated Event](./common/event/updated.schema.md) – `https://ns.adobe.com/xdm/common/event/updated` (Experimental) + +## /external/hal/ + +* [HAL Link](./external/hal/hal-link.schema.md) – `https://ns.adobe.com/xdm/external/hal/link` (Experimental) +* [HAL Resource](./external/hal/hal.schema.md) – `https://ns.adobe.com/xdm/external/hal/resource` (Experimental) + ## /external/activity-streams-2/ * [Activity](./external/activity-streams-2/activity.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/activity` (Experimental) @@ -215,17 +236,6 @@ * [Object](./external/activity-streams-2/object.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/object` (Experimental) * [RDF Language Tagged String](./external/activity-streams-2/rdf-langstring.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring` (Experimental) -## /external/hal/ - -* [HAL Link](./external/hal/hal-link.schema.md) – `https://ns.adobe.com/xdm/external/hal/link` (Experimental) -* [HAL Resource](./external/hal/hal.schema.md) – `https://ns.adobe.com/xdm/external/hal/resource` (Experimental) - -## /external/schema/ - -* [Geo Circle](./external/schema/geocircle.schema.md) – `http://schema.org/GeoCircle` (Experimental) -* [Geo Coordinates](./external/schema/geocoordinates.schema.md) – `http://schema.org/GeoCoordinates` (Experimental) -* [Geo Shape](./external/schema/geoshape.schema.md) – `http://schema.org/GeoShape` (Experimental) - ## /external/iptc/ * [Creator](./external/iptc/creator.schema.md) – `http://www.iptc.org/creator` (Experimental) @@ -244,19 +254,9 @@ * [Effective Privileges](./external/repo/effectiveprivileges.schema.md) – `https://ns.adobe.com/xdm/external/repo/effectiveprivileges` (Experimental) * [Sub-Directory](./external/repo/sub-directory.schema.md) – `http://ns.adobe.com/adobecloud/core/1.0/sub-directory` (Experimental) -## /common/descriptors/ - -* [Item Selector](./common/descriptors/itemselector.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/itemselector` (Experimental) -* [Relationship Descriptor](./common/descriptors/relationshipdescriptor.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor` (Experimental) -* [Schema Descriptor](./common/descriptors/schemadescriptor.schema.md) – `https://ns.adobe.com/xdm/common/desciptors/schemadescriptor` (Experimental) - -## /common/event/ +## /external/schema/ -* [Created Event](./common/event/created.schema.md) – `https://ns.adobe.com/xdm/common/event/created` (Experimental) -* [Deleted Event](./common/event/deleted.schema.md) – `https://ns.adobe.com/xdm/common/event/deleted` (Experimental) -* [Emitted Event](./common/event/emitted.schema.md) – `https://ns.adobe.com/xdm/common/event/emitted` (Experimental) -* [Published Event](./common/event/published.schema.md) – `https://ns.adobe.com/xdm/common/event/published` (Experimental) -* [Rejected Event](./common/event/rejected.schema.md) – `https://ns.adobe.com/xdm/common/event/rejected` (Experimental) -* [Unpublished Event](./common/event/unpublished.schema.md) – `https://ns.adobe.com/xdm/common/event/unpublished` (Experimental) -* [Updated Event](./common/event/updated.schema.md) – `https://ns.adobe.com/xdm/common/event/updated` (Experimental) +* [Geo Circle](./external/schema/geocircle.schema.md) – `http://schema.org/GeoCircle` (Experimental) +* [Geo Coordinates](./external/schema/geocoordinates.schema.md) – `http://schema.org/GeoCoordinates` (Experimental) +* [Geo Shape](./external/schema/geoshape.schema.md) – `http://schema.org/GeoShape` (Experimental) diff --git a/docs/reference/common/descriptors/itemselector.schema.json b/docs/reference/common/descriptors/itemselector.schema.json index aaed1d953..4b95966e4 100644 --- a/docs/reference/common/descriptors/itemselector.schema.json +++ b/docs/reference/common/descriptors/itemselector.schema.json @@ -78,16 +78,16 @@ "meta:status": "experimental", "examples": [ { - "xdm:id": "https://example.com/objects/12345" + "xdm:type": "https://ns.adobe.com/experience/mcid" }, { "xdm:index": 0 }, { - "xdm:schema": "https://ns.adobe.com/xdm/context/identity" + "xdm:id": "https://example.com/objects/12345" }, { - "xdm:type": "https://ns.adobe.com/experience/mcid" + "xdm:schema": "https://ns.adobe.com/xdm/context/identity" } ] } \ No newline at end of file diff --git a/docs/reference/common/descriptors/itemselector.schema.md b/docs/reference/common/descriptors/itemselector.schema.md index 4e6de0e18..d015f476f 100644 --- a/docs/reference/common/descriptors/itemselector.schema.md +++ b/docs/reference/common/descriptors/itemselector.schema.md @@ -18,7 +18,7 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI. ```json { - "xdm:id": "https://example.com/objects/12345" + "xdm:type": "https://ns.adobe.com/experience/mcid" } ``` @@ -30,13 +30,13 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI. ```json { - "xdm:schema": "https://ns.adobe.com/xdm/context/identity" + "xdm:id": "https://example.com/objects/12345" } ``` ```json { - "xdm:type": "https://ns.adobe.com/experience/mcid" + "xdm:schema": "https://ns.adobe.com/xdm/context/identity" } ``` diff --git a/docs/reference/common/eventenvelope.schema.json b/docs/reference/common/eventenvelope.schema.json index a405d5e51..91db4c04b 100644 --- a/docs/reference/common/eventenvelope.schema.json +++ b/docs/reference/common/eventenvelope.schema.json @@ -41,29 +41,6 @@ ], "meta:status": "experimental", "examples": [ - { - "@type": "https://ns.adobe.com/xdm/common/event/created", - "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", - "activitystreams:published": "2016-07-16T19:20:30+01:00", - "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", - "activitystreams:to": { - "@type": "https://ns.adobe.com/adobecloudplatform/ims/user", - "@id": "D13A1E7053E46A220A4C86E1@AdobeID" - }, - "activitystreams:generator": { - "@type": "https://ns.adobe.com/xdm/content/repository", - "xdm:root": "https://cc-api-storage-stage.adobe.io/" - }, - "activitystreams:actor": { - "@type": "https://ns.adobe.com/adobecloudplatform/ims/user", - "@id": "D13A1E7053E46A220A4C86E1@AdobeID" - }, - "activitystreams:object": { - "@type": "https://ns.adobe.com/xdm/assets/asset", - "repo:id": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185", - "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185" - } - }, { "@type": "https://ns.adobe.com/xdm/common/event/created", "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", @@ -92,7 +69,7 @@ } }, { - "@type": "https://ns.adobe.com/xdm/common/event/unpublished", + "@type": "https://ns.adobe.com/xdm/common/event/published", "xdm:objectType": "https://ns.adobe.com/xdm/content/componentized-page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", @@ -143,7 +120,30 @@ } }, { - "@type": "https://ns.adobe.com/xdm/common/event/published", + "@type": "https://ns.adobe.com/xdm/common/event/created", + "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", + "activitystreams:published": "2016-07-16T19:20:30+01:00", + "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "activitystreams:to": { + "@type": "https://ns.adobe.com/adobecloudplatform/ims/user", + "@id": "D13A1E7053E46A220A4C86E1@AdobeID" + }, + "activitystreams:generator": { + "@type": "https://ns.adobe.com/xdm/content/repository", + "xdm:root": "https://cc-api-storage-stage.adobe.io/" + }, + "activitystreams:actor": { + "@type": "https://ns.adobe.com/adobecloudplatform/ims/user", + "@id": "D13A1E7053E46A220A4C86E1@AdobeID" + }, + "activitystreams:object": { + "@type": "https://ns.adobe.com/xdm/assets/asset", + "repo:id": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185", + "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185" + } + }, + { + "@type": "https://ns.adobe.com/xdm/common/event/unpublished", "xdm:objectType": "https://ns.adobe.com/xdm/content/componentized-page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", diff --git a/docs/reference/common/eventenvelope.schema.md b/docs/reference/common/eventenvelope.schema.md index 41fac1c63..fd743879a 100644 --- a/docs/reference/common/eventenvelope.schema.md +++ b/docs/reference/common/eventenvelope.schema.md @@ -19,32 +19,6 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream ## EventEnvelope Examples -```json -{ - "@type": "https://ns.adobe.com/xdm/common/event/created", - "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", - "activitystreams:published": "2016-07-16T19:20:30+01:00", - "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", - "activitystreams:to": { - "@type": "https://ns.adobe.com/adobecloudplatform/ims/user", - "@id": "D13A1E7053E46A220A4C86E1@AdobeID" - }, - "activitystreams:generator": { - "@type": "https://ns.adobe.com/xdm/content/repository", - "xdm:root": "https://cc-api-storage-stage.adobe.io/" - }, - "activitystreams:actor": { - "@type": "https://ns.adobe.com/adobecloudplatform/ims/user", - "@id": "D13A1E7053E46A220A4C86E1@AdobeID" - }, - "activitystreams:object": { - "@type": "https://ns.adobe.com/xdm/assets/asset", - "repo:id": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185", - "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185" - } -} -``` - ```json { "@type": "https://ns.adobe.com/xdm/common/event/created", @@ -77,7 +51,7 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream ```json { - "@type": "https://ns.adobe.com/xdm/common/event/unpublished", + "@type": "https://ns.adobe.com/xdm/common/event/published", "xdm:objectType": "https://ns.adobe.com/xdm/content/componentized-page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", @@ -134,7 +108,33 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream ```json { - "@type": "https://ns.adobe.com/xdm/common/event/published", + "@type": "https://ns.adobe.com/xdm/common/event/created", + "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", + "activitystreams:published": "2016-07-16T19:20:30+01:00", + "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "activitystreams:to": { + "@type": "https://ns.adobe.com/adobecloudplatform/ims/user", + "@id": "D13A1E7053E46A220A4C86E1@AdobeID" + }, + "activitystreams:generator": { + "@type": "https://ns.adobe.com/xdm/content/repository", + "xdm:root": "https://cc-api-storage-stage.adobe.io/" + }, + "activitystreams:actor": { + "@type": "https://ns.adobe.com/adobecloudplatform/ims/user", + "@id": "D13A1E7053E46A220A4C86E1@AdobeID" + }, + "activitystreams:object": { + "@type": "https://ns.adobe.com/xdm/assets/asset", + "repo:id": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185", + "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185" + } +} +``` + +```json +{ + "@type": "https://ns.adobe.com/xdm/common/event/unpublished", "xdm:objectType": "https://ns.adobe.com/xdm/content/componentized-page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", diff --git a/docs/reference/common/extensible.schema.json b/docs/reference/common/extensible.schema.json index b4a347e1f..b403c13b5 100644 --- a/docs/reference/common/extensible.schema.json +++ b/docs/reference/common/extensible.schema.json @@ -258,13 +258,14 @@ "meta:status": "stabilizing", "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:createdDate": "2017-09-26T15:52:25+00:00", "xdm:repositoryCreatedBy": "lars", "xdm:modifyDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", - "xdm:repositoryLastModifiedBy": "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, @@ -272,14 +273,13 @@ "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:createdDate": "2017-09-26T15:52:25+00:00", "xdm:repositoryCreatedBy": "lars", "xdm:modifyDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", - "xdm:repository_lastModifiedBy": "2017-09-26T15:52:25+00:00", + "xdm:repositoryLastModifiedBy": "2017-09-26T15:52:25+00:00", "repo:version": "15", "dc:title": "This is an example", "repo:size": 1632418, diff --git a/docs/reference/common/extensible.schema.md b/docs/reference/common/extensible.schema.md index e2b1ec7a4..33cfc534e 100644 --- a/docs/reference/common/extensible.schema.md +++ b/docs/reference/common/extensible.schema.md @@ -27,13 +27,14 @@ 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:createdDate": "2017-09-26T15:52:25+00:00", "xdm:repositoryCreatedBy": "lars", "xdm:modifyDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", - "xdm:repositoryLastModifiedBy": "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, @@ -44,14 +45,13 @@ 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:createdDate": "2017-09-26T15:52:25+00:00", "xdm:repositoryCreatedBy": "lars", "xdm:modifyDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", - "xdm:repository_lastModifiedBy": "2017-09-26T15:52:25+00:00", + "xdm:repositoryLastModifiedBy": "2017-09-26T15:52:25+00:00", "repo:version": "15", "dc:title": "This is an example", "repo:size": 1632418, diff --git a/docs/reference/context/experienceevent.schema.json b/docs/reference/context/experienceevent.schema.json index a3363f94c..20669dee2 100644 --- a/docs/reference/context/experienceevent.schema.json +++ b/docs/reference/context/experienceevent.schema.json @@ -151,6 +151,159 @@ ], "meta:status": "stabilizing", "examples": [ + { + "@id": "https://data.adobe.io/experienceid-123457", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:endUserIDs": { + "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" + } + } + }, + "xdm:environment": { + "xdm:browserDetails": { + "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" + }, + "xdm:ipV4": "97.27.143.5" + }, + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TV14", + "iptc4xmpExt:RatingSourceLink": "http://www.tvguidelines.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "ESPN" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchespn", + "xdm:broadcastChannel": "WatchESPN", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "nbcu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:QOE": { + "xdm:errors": { + "xdm:value": 0 + }, + "xdm:buffers": { + "xdm:value": 4 + }, + "xdm:bufferTime": { + "xdm:value": 5 + }, + "xdm:stalls": { + "xdm:value": 0 + }, + "xdm:stallTime": { + "xdm:value": 0 + }, + "xdm:bitrateChanges": { + "xdm:value": 0 + }, + "xdm:bitrateAverage": { + "xdm:value": 320 + }, + "xdm:droppedFrames": { + "xdm:value": 2 + }, + "xdm:timeToStart": { + "xdm:value": 3 + }, + "xdm:mediaSdkErrors": "300,500.300.200", + "xdm:playerSdkErrors": "custom.error.code", + "xdm:externalSdkErrors": "100-5,11.12" + } + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 0 + }, + "xdm:timePlayed": { + "xdm:value": 80 + }, + "xdm:federated": { + "xdm:value": 0 + }, + "xdm:starts": { + "xdm:value": 1 + }, + "xdm:mediaSegmentView": { + "xdm:value": 1 + }, + "xdm:dropBeforeStart": { + "xdm:value": 0 + }, + "xdm:totalTimePlayed": { + "xdm:value": 190 + }, + "xdm:progress10": { + "xdm:value": 1 + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + }, + "xdm:midpoints": { + "xdm:value": 1 + }, + "xdm:thirdQuartiles": { + "xdm:value": 1 + }, + "xdm:progress95": { + "xdm:value": 0 + }, + "xdm:resumes": { + "xdm:value": 0 + }, + "xdm:pauses": { + "xdm:value": 0 + }, + "xdm:pauseTime": { + "xdm:value": 0 + } + } + } + }, { "@id": "https://data.adobe.io/experienceid-23456782", "xdm:dataSource": { @@ -309,6 +462,83 @@ } } }, + { + "@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:endUserIDs": { + "https://ns.adobe.com/experience/mcid": { + "xdm:id": "92312748749128", + "xdm:namespace": { + "@id": "https://data.adobe.io/entities/namespace/4", + "xdm:code": "ECID" + } + } + }, + "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": { @@ -578,159 +808,6 @@ } } }, - { - "@id": "https://data.adobe.io/experienceid-123457", - "xdm:timestamp": "2017-09-26T15:52:25+00:00", - "xdm:endUserIDs": { - "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" - } - } - }, - "xdm:environment": { - "xdm:browserDetails": { - "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" - }, - "xdm:ipV4": "97.27.143.5" - }, - "xdm:media": { - "xdm:mediaTimed": { - "xdm:primaryAssetReference": { - "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", - "dc:title": "Floki Begs Helga for Freedom", - "xmpDM:duration": 87, - "iptc4xmpExt:Series": { - "iptc4xmpExt:Name": "nba_highlights", - "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" - }, - "xdm:showType": "episode", - "xdm:streamFormat": "long", - "iptc4xmpExt:Season": { - "iptc4xmpExt:Number": 1 - }, - "iptc4xmpExt:Episode": { - "iptc4xmpExt:Number": 1 - }, - "iptc4xmpExt:Genre": [ - "sports" - ], - "iptc4xmpExt:Rating": [ - { - "iptc4xmpExt:RatingValue": "TV14", - "iptc4xmpExt:RatingSourceLink": "http://www.tvguidelines.org/ratings.htm" - } - ], - "iptc4xmpExt:Creator": [ - { - "iptc4xmpExt:Name": "ESPN" - } - ] - }, - "xdm:primaryAssetViewDetails": { - "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", - "xdm:playerName": "watchespn", - "xdm:broadcastChannel": "WatchESPN", - "xdm:broadcastContentType": "VOD", - "xdm:streamFormat": "short", - "xdm:playerSDKVersion": { - "xdm:version": "1.0.8" - }, - "xdm:broadcastNetwork": "nbcu", - "xdm:adLoadType": "2", - "xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", - "xdm:sessionTimeout": 1800, - "xdm:QOE": { - "xdm:errors": { - "xdm:value": 0 - }, - "xdm:buffers": { - "xdm:value": 4 - }, - "xdm:bufferTime": { - "xdm:value": 5 - }, - "xdm:stalls": { - "xdm:value": 0 - }, - "xdm:stallTime": { - "xdm:value": 0 - }, - "xdm:bitrateChanges": { - "xdm:value": 0 - }, - "xdm:bitrateAverage": { - "xdm:value": 320 - }, - "xdm:droppedFrames": { - "xdm:value": 2 - }, - "xdm:timeToStart": { - "xdm:value": 3 - }, - "xdm:mediaSdkErrors": "300,500.300.200", - "xdm:playerSdkErrors": "custom.error.code", - "xdm:externalSdkErrors": "100-5,11.12" - } - }, - "xdm:impressions": { - "xdm:value": 1 - }, - "xdm:completes": { - "xdm:value": 0 - }, - "xdm:timePlayed": { - "xdm:value": 80 - }, - "xdm:federated": { - "xdm:value": 0 - }, - "xdm:starts": { - "xdm:value": 1 - }, - "xdm:mediaSegmentView": { - "xdm:value": 1 - }, - "xdm:dropBeforeStart": { - "xdm:value": 0 - }, - "xdm:totalTimePlayed": { - "xdm:value": 190 - }, - "xdm:progress10": { - "xdm:value": 1 - }, - "xdm:firstQuartiles": { - "xdm:value": 1 - }, - "xdm:midpoints": { - "xdm:value": 1 - }, - "xdm:thirdQuartiles": { - "xdm:value": 1 - }, - "xdm:progress95": { - "xdm:value": 0 - }, - "xdm:resumes": { - "xdm:value": 0 - }, - "xdm:pauses": { - "xdm:value": 0 - }, - "xdm:pauseTime": { - "xdm:value": 0 - } - } - } - }, { "@id": "https://data.adobe.io/experienceid-123459", "xdm:timestamp": "2017-09-26T15:52:25+00:00", @@ -826,83 +903,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:endUserIDs": { - "https://ns.adobe.com/experience/mcid": { - "xdm:id": "92312748749128", - "xdm:namespace": { - "@id": "https://data.adobe.io/entities/namespace/4", - "xdm:code": "ECID" - } - } - }, - "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 - } - } } ] } \ No newline at end of file diff --git a/docs/reference/context/experienceevent.schema.md b/docs/reference/context/experienceevent.schema.md index 80d728dac..5e18e5e7b 100644 --- a/docs/reference/context/experienceevent.schema.md +++ b/docs/reference/context/experienceevent.schema.md @@ -33,6 +33,162 @@ The core ExperienceEvent XDM is used to capture observations that are altering o ## ExperienceEvent Examples +```json +{ + "@id": "https://data.adobe.io/experienceid-123457", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:endUserIDs": { + "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" + } + } + }, + "xdm:environment": { + "xdm:browserDetails": { + "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" + }, + "xdm:ipV4": "97.27.143.5" + }, + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TV14", + "iptc4xmpExt:RatingSourceLink": "http://www.tvguidelines.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "ESPN" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchespn", + "xdm:broadcastChannel": "WatchESPN", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "nbcu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:QOE": { + "xdm:errors": { + "xdm:value": 0 + }, + "xdm:buffers": { + "xdm:value": 4 + }, + "xdm:bufferTime": { + "xdm:value": 5 + }, + "xdm:stalls": { + "xdm:value": 0 + }, + "xdm:stallTime": { + "xdm:value": 0 + }, + "xdm:bitrateChanges": { + "xdm:value": 0 + }, + "xdm:bitrateAverage": { + "xdm:value": 320 + }, + "xdm:droppedFrames": { + "xdm:value": 2 + }, + "xdm:timeToStart": { + "xdm:value": 3 + }, + "xdm:mediaSdkErrors": "300,500.300.200", + "xdm:playerSdkErrors": "custom.error.code", + "xdm:externalSdkErrors": "100-5,11.12" + } + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 0 + }, + "xdm:timePlayed": { + "xdm:value": 80 + }, + "xdm:federated": { + "xdm:value": 0 + }, + "xdm:starts": { + "xdm:value": 1 + }, + "xdm:mediaSegmentView": { + "xdm:value": 1 + }, + "xdm:dropBeforeStart": { + "xdm:value": 0 + }, + "xdm:totalTimePlayed": { + "xdm:value": 190 + }, + "xdm:progress10": { + "xdm:value": 1 + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + }, + "xdm:midpoints": { + "xdm:value": 1 + }, + "xdm:thirdQuartiles": { + "xdm:value": 1 + }, + "xdm:progress95": { + "xdm:value": 0 + }, + "xdm:resumes": { + "xdm:value": 0 + }, + "xdm:pauses": { + "xdm:value": 0 + }, + "xdm:pauseTime": { + "xdm:value": 0 + } + } + } +} +``` + ```json { "@id": "https://data.adobe.io/experienceid-23456782", @@ -194,6 +350,86 @@ The core ExperienceEvent XDM is used to capture observations that are altering o } ``` +```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:endUserIDs": { + "https://ns.adobe.com/experience/mcid": { + "xdm:id": "92312748749128", + "xdm:namespace": { + "@id": "https://data.adobe.io/entities/namespace/4", + "xdm:code": "ECID" + } + } + }, + "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", @@ -469,162 +705,6 @@ The core ExperienceEvent XDM is used to capture observations that are altering o } ``` -```json -{ - "@id": "https://data.adobe.io/experienceid-123457", - "xdm:timestamp": "2017-09-26T15:52:25+00:00", - "xdm:endUserIDs": { - "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" - } - } - }, - "xdm:environment": { - "xdm:browserDetails": { - "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" - }, - "xdm:ipV4": "97.27.143.5" - }, - "xdm:media": { - "xdm:mediaTimed": { - "xdm:primaryAssetReference": { - "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", - "dc:title": "Floki Begs Helga for Freedom", - "xmpDM:duration": 87, - "iptc4xmpExt:Series": { - "iptc4xmpExt:Name": "nba_highlights", - "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" - }, - "xdm:showType": "episode", - "xdm:streamFormat": "long", - "iptc4xmpExt:Season": { - "iptc4xmpExt:Number": 1 - }, - "iptc4xmpExt:Episode": { - "iptc4xmpExt:Number": 1 - }, - "iptc4xmpExt:Genre": [ - "sports" - ], - "iptc4xmpExt:Rating": [ - { - "iptc4xmpExt:RatingValue": "TV14", - "iptc4xmpExt:RatingSourceLink": "http://www.tvguidelines.org/ratings.htm" - } - ], - "iptc4xmpExt:Creator": [ - { - "iptc4xmpExt:Name": "ESPN" - } - ] - }, - "xdm:primaryAssetViewDetails": { - "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", - "xdm:playerName": "watchespn", - "xdm:broadcastChannel": "WatchESPN", - "xdm:broadcastContentType": "VOD", - "xdm:streamFormat": "short", - "xdm:playerSDKVersion": { - "xdm:version": "1.0.8" - }, - "xdm:broadcastNetwork": "nbcu", - "xdm:adLoadType": "2", - "xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", - "xdm:sessionTimeout": 1800, - "xdm:QOE": { - "xdm:errors": { - "xdm:value": 0 - }, - "xdm:buffers": { - "xdm:value": 4 - }, - "xdm:bufferTime": { - "xdm:value": 5 - }, - "xdm:stalls": { - "xdm:value": 0 - }, - "xdm:stallTime": { - "xdm:value": 0 - }, - "xdm:bitrateChanges": { - "xdm:value": 0 - }, - "xdm:bitrateAverage": { - "xdm:value": 320 - }, - "xdm:droppedFrames": { - "xdm:value": 2 - }, - "xdm:timeToStart": { - "xdm:value": 3 - }, - "xdm:mediaSdkErrors": "300,500.300.200", - "xdm:playerSdkErrors": "custom.error.code", - "xdm:externalSdkErrors": "100-5,11.12" - } - }, - "xdm:impressions": { - "xdm:value": 1 - }, - "xdm:completes": { - "xdm:value": 0 - }, - "xdm:timePlayed": { - "xdm:value": 80 - }, - "xdm:federated": { - "xdm:value": 0 - }, - "xdm:starts": { - "xdm:value": 1 - }, - "xdm:mediaSegmentView": { - "xdm:value": 1 - }, - "xdm:dropBeforeStart": { - "xdm:value": 0 - }, - "xdm:totalTimePlayed": { - "xdm:value": 190 - }, - "xdm:progress10": { - "xdm:value": 1 - }, - "xdm:firstQuartiles": { - "xdm:value": 1 - }, - "xdm:midpoints": { - "xdm:value": 1 - }, - "xdm:thirdQuartiles": { - "xdm:value": 1 - }, - "xdm:progress95": { - "xdm:value": 0 - }, - "xdm:resumes": { - "xdm:value": 0 - }, - "xdm:pauses": { - "xdm:value": 0 - }, - "xdm:pauseTime": { - "xdm:value": 0 - } - } - } -} -``` - ```json { "@id": "https://data.adobe.io/experienceid-123459", @@ -724,86 +804,6 @@ The core ExperienceEvent XDM is used to capture observations that are altering o } ``` -```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:endUserIDs": { - "https://ns.adobe.com/experience/mcid": { - "xdm:id": "92312748749128", - "xdm:namespace": { - "@id": "https://data.adobe.io/entities/namespace/4", - "xdm:code": "ECID" - } - } - }, - "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 - } - } -} -``` - # ExperienceEvent Properties diff --git a/docs/reference/context/person.schema.json b/docs/reference/context/person.schema.json index a23faaffd..f5dcc0e96 100644 --- a/docs/reference/context/person.schema.json +++ b/docs/reference/context/person.schema.json @@ -96,7 +96,7 @@ "xdm:lastName": "Doe", "xdm:fullName": "Jane F. Doe" }, - "xdm:birthDate": "1996-01-03" + "xdm:birthDayAndMonth": "01-03" }, { "xdm:name": { @@ -105,7 +105,7 @@ "xdm:lastName": "Doe", "xdm:fullName": "Jane F. Doe" }, - "xdm:birthDayAndMonth": "01-03" + "xdm:birthDate": "1996-01-03" } ] } \ No newline at end of file diff --git a/docs/reference/context/person.schema.md b/docs/reference/context/person.schema.md index ecabdc4fa..b2d321295 100644 --- a/docs/reference/context/person.schema.md +++ b/docs/reference/context/person.schema.md @@ -28,7 +28,7 @@ An individual person. May represent a person acting in various roles, such as a "xdm:lastName": "Doe", "xdm:fullName": "Jane F. Doe" }, - "xdm:birthDate": "1996-01-03" + "xdm:birthDayAndMonth": "01-03" } ``` @@ -40,7 +40,7 @@ An individual person. May represent a person acting in various roles, such as a "xdm:lastName": "Doe", "xdm:fullName": "Jane F. Doe" }, - "xdm:birthDayAndMonth": "01-03" + "xdm:birthDate": "1996-01-03" } ``` diff --git a/docs/reference/external/hal/hal.schema.json b/docs/reference/external/hal/hal.schema.json index 325140cda..43a6232c6 100644 --- a/docs/reference/external/hal/hal.schema.json +++ b/docs/reference/external/hal/hal.schema.json @@ -304,22 +304,6 @@ "status": "shipped", "total": 10.2 }, - { - "_links": { - "self": { - "href": "/orders/523" - }, - "warehouse": { - "href": "/warehouse/56" - }, - "invoice": { - "href": "/invoices/873" - } - }, - "currency": "USD", - "status": "shipped", - "total": 10.2 - }, { "_links": { "self": { @@ -364,6 +348,22 @@ "currency": "USD", "status": "shipped", "total": 10.2 + }, + { + "_links": { + "self": { + "href": "/orders/523" + }, + "warehouse": { + "href": "/warehouse/56" + }, + "invoice": { + "href": "/invoices/873" + } + }, + "currency": "USD", + "status": "shipped", + "total": 10.2 } ] } \ No newline at end of file diff --git a/docs/reference/external/hal/hal.schema.md b/docs/reference/external/hal/hal.schema.md index 26cfd20be..edb0fb8fd 100644 --- a/docs/reference/external/hal/hal.schema.md +++ b/docs/reference/external/hal/hal.schema.md @@ -47,25 +47,6 @@ This external schema definition allows adding HAL expressions into an existing s } ``` -```json -{ - "_links": { - "self": { - "href": "/orders/523" - }, - "warehouse": { - "href": "/warehouse/56" - }, - "invoice": { - "href": "/invoices/873" - } - }, - "currency": "USD", - "status": "shipped", - "total": 10.2 -} -``` - ```json { "_links": { @@ -114,6 +95,25 @@ This external schema definition allows adding HAL expressions into an existing s } ``` +```json +{ + "_links": { + "self": { + "href": "/orders/523" + }, + "warehouse": { + "href": "/warehouse/56" + }, + "invoice": { + "href": "/invoices/873" + } + }, + "currency": "USD", + "status": "shipped", + "total": 10.2 +} +``` + # HAL Resource Properties diff --git a/docs/reference/external/repo/directory.schema.json b/docs/reference/external/repo/directory.schema.json index a7360b6fc..30816b753 100644 --- a/docs/reference/external/repo/directory.schema.json +++ b/docs/reference/external/repo/directory.schema.json @@ -77,6 +77,12 @@ "templated": true } }, + "_page": { + "orderBy": "id", + "start": "123", + "next": "789", + "count": 100 + }, "repo:createdDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", "repo:path": "/", @@ -96,12 +102,6 @@ "templated": true } }, - "_page": { - "orderBy": "id", - "start": "123", - "next": "789", - "count": 100 - }, "repo:createdDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", "repo:path": "/", diff --git a/docs/reference/external/repo/directory.schema.md b/docs/reference/external/repo/directory.schema.md index d9a93ef2c..cd6ad693d 100644 --- a/docs/reference/external/repo/directory.schema.md +++ b/docs/reference/external/repo/directory.schema.md @@ -32,6 +32,12 @@ A directory in Adobe Cloud Platform. "templated": true } }, + "_page": { + "orderBy": "id", + "start": "123", + "next": "789", + "count": 100 + }, "repo:createdDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", "repo:path": "/", @@ -54,12 +60,6 @@ A directory in Adobe Cloud Platform. "templated": true } }, - "_page": { - "orderBy": "id", - "start": "123", - "next": "789", - "count": 100 - }, "repo:createdDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", "repo:path": "/", diff --git a/package.json b/package.json index d01e3ac8f..d8146c002 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "xdm", - "version": "0.9.5", + "version": "0.9.6", "description": "Experience Data Models", "main": "", "config": {