DCR Denmark Video Cloud API - Revision history

MichelFodjo at 08:29, 24 November 2022

2022-11-24T08:29:40Z

← Older revision		Revision as of 08:29, 24 November 2022
Line 140:		Line 140:
	payload = {		payload = {
	"devInfo": {		"devInfo": {
	"devId": "AD-ID",		"devId": "SHA-256 value of the Device ID",
	"apn": "AppName",		"apn": "AppName",
	"apv": "1.0",		"apv": "1.0",
Line 184:		Line 184:
	\|-		\|-
	! Keys !! Description !! Values !! Required		! Keys !! Description !! Values !! Required
	\|-		\|-style="background-color:#d0f6f8;"
	\| devId \|\| unique ID ~~to identify~~ user (e.g. Advertising ID, Roku Device ID) \|\| custom \|\| ✓		\| devId \|\| unique Device ID of a user device (e.g. SHA-256 hashed value of i.e. Advertising ID, Roku Device ID). Please verify your implemented SHA-256 by passing "00000000-0000-0000-0000-000000000000" which should return "12b9377cbe7e5c94e8a70d9d23929523d14afa954793130f8a3959c7b849aca8" \|\| custom \|\| ✓
	\|-		\|-
	\| apn \|\| app name \|\| custom \|\| ✓		\| apn \|\| app name \|\| custom \|\| ✓
Line 201:		Line 201:
	// create devInfo object		// create devInfo object
	"devInfo": {		"devInfo": {
	"devId": "AD-ID",		"devId": "SHA-256 value of the Device ID",
	"apn": "AppName",		"apn": "AppName",
	"apv": "1.0",		"apv": "1.0",
Line 505:		Line 505:
	payload = {		payload = {
	"devInfo": {		"devInfo": {
	"devId": "AD-ID",		"devId": "SHA-256 value of the Device ID",
	"apn": "AppName",		"apn": "AppName",
	"apv": "1.0",		"apv": "1.0",

MichelFodjo: /* Disclose Nielsen Privacy Statement */

2022-08-04T13:03:25Z

Disclose Nielsen Privacy Statement

← Older revision		Revision as of 13:03, 4 August 2022
Line 614:		Line 614:
	In order to disclose Nielsen measurement privacy statement, please include the following items in your privacy policy:		In order to disclose Nielsen measurement privacy statement, please include the following items in your privacy policy:
	* A notice that the player includes third party measurement software that allows users to contribute to market research.		* A notice that the player includes third party measurement software that allows users to contribute to market research.
	* A link to the Nielsen Digital Measurement Privacy Policy located at https://~~sites.~~nielsen.com/~~priv~~/~~browser~~/dk/da~~/DigitalMeasurement.html~~ .		* A link to the Nielsen Digital Measurement Privacy Policy located at https://nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=da .

	== Testing ==		== Testing ==

LaMarHolmes: /* Interruption Scenarios */

2022-03-14T19:55:29Z

Interruption Scenarios

← Older revision		Revision as of 19:55, 14 March 2022
Line 488:		Line 488:
	*App Crash or Exit		*App Crash or Exit

	~~When playback is interrupted, the app needs to send delete immediately.~~		'''Note:''' A session will automatically timeout after 30 minutes of inactivity.

	~~Once playback resumes, a new session will need to be created with a unique session ID. All of the required metadata and events will need to be sent.~~

	'''Note:''' ~~The~~ session will automatically timeout after 30 minutes of inactivity.

	=== Example Request ===		=== Example Request ===

LaMarHolmes: /* Event Types */

2022-03-14T19:54:39Z

Event Types

← Older revision		Revision as of 19:54, 14 March 2022
Line 359:		Line 359:

	\|-		\|-
	\| <code>"complete"</code> \|\| The complete event must be sent when ~~the playback of a content is terminated (i.e.~~ full playback of content completed ~~or switching to another content and therefore ending the current stream playback)~~. Before calling the complete event, a final playhead update with the final position is required to be sent to receive full duration credit. For Live streams, a complete event must be sent at program boundaries.		\| <code>"complete"</code> \|\| The complete event must be sent when full playback of the content has completed . Before calling the complete event, a final playhead update with the final position is required to be sent to receive full duration credit. For Live streams, a complete event must be sent at program boundaries.
	\|-		\|-
	\| <code>"delete"</code> \|\| The delete event is ~~optional and can be~~ sent when the viewing session is terminated (typically on App close). A new session ID must be generated after sending a delete event. Delete should not be sent on app interruptions or foreground/background events. All creditable duration will be summarized for all asset types when delete occurs (content and ads).		\| <code>"delete"</code> \|\| The delete event is sent when the viewing session is terminated (typically on App close). A new session ID must be generated after sending a delete event. Delete should not be sent on app interruptions or foreground/background events. All creditable duration will be summarized for all asset types when delete occurs (content and ads).
	\|}		\|}

MichelFodjo: /* Disclose Nielsen Privacy Statement */

2022-02-10T08:57:15Z

Disclose Nielsen Privacy Statement

← Older revision		Revision as of 08:57, 10 February 2022
Line 617:		Line 617:

	In order to disclose Nielsen measurement privacy statement, please include the following items in your privacy policy:		In order to disclose Nielsen measurement privacy statement, please include the following items in your privacy policy:
	* A notice that the player includes third party measurement software that allows users to contribute to market research ~~with anonymous data~~.		* A notice that the player includes third party measurement software that allows users to contribute to market research.
	* A link to the Nielsen Digital Measurement Privacy Policy located at https://sites.nielsen.com/priv/browser/dk/da/DigitalMeasurement.html .		* A link to the Nielsen Digital Measurement Privacy Policy located at https://sites.nielsen.com/priv/browser/dk/da/DigitalMeasurement.html .

MichelFodjo: /* Event Types */

2022-01-28T13:12:54Z

Event Types

← Older revision		Revision as of 13:12, 28 January 2022
Line 359:		Line 359:

	\|-		\|-
	\| <code>"complete"</code> \|\| The complete event must be sent when the content ~~has~~ completed ~~full~~ playback. Before calling the complete event, a final playhead update with the final position is required to be sent to receive full duration credit. For Live streams, a complete event must be sent at program boundaries.		\| <code>"complete"</code> \|\| The complete event must be sent when the playback of a content is terminated (i.e. full playback of content completed or switching to another content and therefore ending the current stream playback). Before calling the complete event, a final playhead update with the final position is required to be sent to receive full duration credit. For Live streams, a complete event must be sent at program boundaries.
	\|-		\|-
	\| <code>"delete"</code> \|\| The delete event is optional and can be sent when the viewing session is terminated (typically on App close). A new session ID must be generated after sending a delete event. Delete should not be sent on app interruptions or foreground/background events. All creditable duration will be summarized for all asset types when delete occurs (content and ads).		\| <code>"delete"</code> \|\| The delete event is optional and can be sent when the viewing session is terminated (typically on App close). A new session ID must be generated after sending a delete event. Delete should not be sent on app interruptions or foreground/background events. All creditable duration will be summarized for all asset types when delete occurs (content and ads).

MichelFodjo: /* URL Structure */

2021-11-24T15:29:44Z

URL Structure

← Older revision		Revision as of 15:29, 24 November 2021
Line 29:		Line 29:

	*<code>[endpoint]</code>: location of data collection environment		*<code>[endpoint]</code>: location of data collection environment
	*<code>[appid]</code>: provided App ID		*<code>[appid]</code>: provided App ID.
			** '''Note: P prefix must be removed before adding it to the URL'''
			** Example App ID with P prefix: "PDF20695-XXXX-XXXX-XXXX-3E334133D917"
			** <code>https://sc-eucert.nmrodam.com/nmapi/v2/DF20695-XXXX-XXXX-XXXX-3E334133D917/[sessionID]/a?b=[payload]</code>
	*<code>[sessionID]</code>: unique value for each user session		*<code>[sessionID]</code>: unique value for each user session
	*<code>[payload]</code>: metadata and events		*<code>[payload]</code>: metadata and events

FaraazAli: /* Create Session ID */

2021-10-29T11:30:30Z

Create Session ID

@@ Line 65: / Line 65: @@
 ====Create Session ID====
-A unique Session ID <code>[sessionID]</code> must be created upon app launch and provided in the URL. This will allow measurement to occur for the entire duration that a user is within the app.
+A unique Session ID <code>[sessionID]</code> must be created upon app launch and provided in the URL. This will allow the measurement to occur for the entire duration that a user is within the app.
-A Session ID needs to be completely unique so it is recommended to use a version 4 UUID or another method of your choosing to guarantee there are no repeats, also see  [[#Review the Reference Implementation for VoD and Live Streams|Reference Implementation for VoD and Live Streams]] for your reference and use.
+A Session ID needs to be completely unique so it is recommended to use our generation method example provided below to create unique alpha-numerical 29 characters + 10 characters UTC timestamp, to guarantee there are no repeats, also see  [[#Review the Reference Implementation for VoD and Live Streams|Reference Implementation for VoD and Live Streams]] for your reference and use.
-Upon exiting the app, the session will need to be terminated using the delete event. Sessions will automatically expire after 30 minutes of cloud inactivity.
+Session ID example: '''LsTYTmZQPwdchsNZkdtJp9lErjgAp1632729088'''
 ====Send EMM Ping====

MichelFodjo: /* Example Request */

2021-09-27T07:56:07Z

Example Request

← Older revision		Revision as of 07:56, 27 September 2021
Line 469:		Line 469:
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	// 1. Create Session ID		// 1. Create Session ID
	sessionID = ~~dfc7dc6a-66a7-4705-9fba-adaaf7e3d5e0~~ // Example sessionID created using a UUID Generator		sessionID = LsTYTmZQPwdchsNZkdtJp9lErjgAp1632729088 // Example sessionID created using a UUID Generator

	// 2. Define URL Structure with App ID and Session ID		// 2. Define URL Structure with App ID and Session ID

MichelFodjo at 16:14, 22 September 2021

2021-09-22T16:14:31Z

← Older revision		Revision as of 16:14, 22 September 2021
Line 130:		Line 130:
	"stationId": "TESTXXYYSSWWLL",		"stationId": "TESTXXYYSSWWLL",
	"islivestn": "y",		"islivestn": "y",
	"~~pbstarttime~~": "1631098029"		"pbstarttm": "1631098029"
	},		},
	"ad": {		"ad": {
Line 233:		Line 233:
	✓		✓
	\|-style="background-color:#d0f6f8;"		\|-style="background-color:#d0f6f8;"
	\|~~pbstarttime~~ \|\| Playback Start Time (UTC): Unix timestamp in seconds matching the broadcast time for Content and Ad when a user starts and joins a live stream (seconds since Jan-1-1970 UTC)		\|pbstarttm \|\| Playback Start Time (UTC): Unix timestamp in seconds matching the broadcast time for Content and Ad when a user starts and joins a live stream (seconds since Jan-1-1970 UTC)
	\|\|		\|\|
	i.e. "1631098029" for live stream and ""(empty string) for a VoD.		i.e. "1631098029" for live stream and ""(empty string) for a VoD.
Line 262:		Line 262:
	"stationId": "TESTXXYYSSWWLL",		"stationId": "TESTXXYYSSWWLL",
	"islivestn": "y",		"islivestn": "y",
	"~~pbstarttime~~": "1631098029"		"pbstarttm": "1631098029"
	}</syntaxhighlight>		}</syntaxhighlight>

Line 499:		Line 499:
	"stationId": "TESTXXYYSSWWLL",		"stationId": "TESTXXYYSSWWLL",
	"islivestn": "y",		"islivestn": "y",
	"~~pbstarttime~~": "1631098029",		"pbstarttm": "1631098029",
	},		},
	"ad": {		"ad": {