Skip to content

Commit

Permalink
Implemented the data/timeseries schema
Browse files Browse the repository at this point in the history
Added the eventType field.
  • Loading branch information
chrisdegroot committed Dec 12, 2018
1 parent 2492255 commit a146ce1
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 0 deletions.
5 changes: 5 additions & 0 deletions schemas/data/time-series.example.1.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"@id": "https://data.adobe.io/experienceid-123456",
"xdm:timestamp": "2017-09-26T15:52:25+00:00",
"xdm:eventType": "advertising.impressions"
}
71 changes: 71 additions & 0 deletions schemas/data/time-series.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"meta:license": [
"Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
"This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
"you may not use this file except in compliance with the License. You may obtain a copy",
"of the License at https://creativecommons.org/licenses/by/4.0/"
],
"$id": "https://ns.adobe.com/xdm/data/time-series",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Time-series Class Schema",
"type": "object",
"meta:extensible": true,
"meta:abstract": true,
"description":
"Time-series technical class schema. Used to indicate the behaviour of time partitioned data semantics when composed into other Classes and Schemas.",
"definitions": {
"time-series": {
"properties": {
"@id": {
"title": "Identifier",
"type": "string",
"format": "uri-reference",
"description": "A unique identifier for the time-series event."
},
"xdm:timestamp": {
"title": "Timestamp",
"type": "string",
"format": "date-time",
"description": "The time when an event or observation occurred."
},
"xdm:eventType": {
"title": "Event Type",
"type": "string",
"description": "The primary event type for this timeseries record.",
"meta:enum": {
"advertising.completes": "Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead.",
"advertising.timePlayed": "Describes the amount of time spent by a user on a specific timed media asset.",
"advertising.federated": "Indicates if an experience event was created through data federation (data sharing between customers).",
"advertising.clicks": "Click(s) actions on an advertisement.",
"advertising.conversions": "A customer pre-defined action(s) which triggers an event for performance evaluation.",
"advertising.firstQuartiles": "A digital video ad has played through 25% of its duration at normal speed.",
"advertising.impressions": "Impression(s) of an advertisement to an end user with the potential of being viewed.",
"advertising.midpoints": "A digital video ad has played through 50% of its duration at normal speed.",
"advertising.starts": "A digital video ad has started playing.",
"advertising.thirdQuartiles": "A digital video ad has played through 75% of its duration at normal speed.",
"web.webpagedetails.pageViews": "View(s) of a webpage has occurred.",
"web.webinteraction.linkClicks": "Click of a web-link has occurred.",
"commerce.checkouts": "An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order.",
"commerce.productListAdds": "Addition of a product to the product list. Example a product is added to a shopping cart.",
"commerce.productListOpens": "Initializations of a new product list. Example a shopping cart is created.",
"commerce.productListRemovals": "Removal(s) of a product entry from a product list. Example a product is removed from a shopping cart.",
"commerce.productListReopens": "A product list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity.",
"commerce.productListViews": "View(s) of a product-list has occurred.",
"commerce.productViews": "View(s) of a product have occurred.",
"commerce.purchases": "An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced.",
"commerce.saveForLaters": "Product list is saved for future use. Example a product wish list."
}
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/time-series"
},
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
}
],
"meta:status": "experimental"
}

0 comments on commit a146ce1

Please sign in to comment.