DCR Sweden Video Browser SDK - Revision history

MichelFodjo: /* Start the Measurement */

2025-03-12T11:31:24Z

Start the Measurement

← Older revision		Revision as of 11:31, 12 March 2025
Line 147:		Line 147:
	\|-		\|-
	\| "loadMetadata" \|\| content/ad metadata object \|\| Needs to be called at the beginning of each asset		\| "loadMetadata" \|\| content/ad metadata object \|\| Needs to be called at the beginning of each asset
	\|-		\|-<pre style="background-color:#d0f6f8">
			</pre>
	\| "setPlayheadPosition" \|\| playhead position as integer<br/>		\| "setPlayheadPosition" \|\| playhead position as integer<br/>
	~~<pre style="background-color:#d0f6f8">~~
	~~</pre>~~
	* VOD: current position in seconds for Content and Ad. Pass whole number that increments only by 1 like 0,1,2,3... <br/>		* VOD: current position in seconds for Content and Ad. Pass whole number that increments only by 1 like 0,1,2,3... <br/>
	* Live: Unix timestamp matching the broadcast time for Content and Ad (seconds since Jan-1-1970 UTC). Pass whole number that increments only by 1 like 1631098029,1631098030,1631098031,1631098032,... <br/>		* Live: Unix timestamp matching the broadcast time for Content and Ad (seconds since Jan-1-1970 UTC). Pass whole number that increments only by 1 like 1631098029,1631098030,1631098031,1631098032,... <br/>

MichelFodjo: /* Start the Measurement */ Update "setPlayheadPosition" like for Denmark

2025-03-12T11:23:12Z

Start the Measurement: Update "setPlayheadPosition" like for Denmark

← Older revision		Revision as of 11:23, 12 March 2025
Line 149:		Line 149:
	\|-		\|-
	\| "setPlayheadPosition" \|\| playhead position as integer<br/>		\| "setPlayheadPosition" \|\| playhead position as integer<br/>
	VOD: current position in seconds <br/>		<pre style="background-color:#d0f6f8">
	Live: ~~current~~ Unix timestamp (seconds since 01-01-1970 UTC) <br/>		</pre>
			* VOD: current position in seconds for Content and Ad. Pass whole number that increments only by 1 like 0,1,2,3... <br/>
			* Live: Unix timestamp matching the broadcast time for Content and Ad (seconds since Jan-1-1970 UTC). Pass whole number that increments only by 1 like 1631098029,1631098030,1631098031,1631098032,... <br/>
	\|\|		\|\|
	Pass playhead position every second during playback		Pass playhead position every second during playback

MichelFodjo: /* Privacy and Opt-Out */ adding new opt-in/opt-out links shared by Zeljko

2024-08-28T16:33:12Z

Privacy and Opt-Out: adding new opt-in/opt-out links shared by Zeljko

← Older revision		Revision as of 16:33, 28 August 2024
Line 300:		Line 300:
	On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.		On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.
	<br />		<br />
	* Once users have opted out via this [https://priv.imrworldwide.com/priv/browser/cookie-policy~~-se-sv~~.html?optout=1/ link], their browser cookies will contain the value '''TOTAL_OPTOUT'''. This will prevent a redirect to our data provider from occurring		* Once users have opted out via this [https://priv-policy.imrworldwide.com/priv/browser/cookie-policy.html?optout=1 link], their browser cookies will contain the value '''TOTAL_OPTOUT'''. This will prevent a redirect to our data provider from occurring
	* Users can opt back in via this [https://priv.imrworldwide.com/priv/browser/cookie-policy~~-reset-se-sv~~.html?optout=0/ link]. When a user selects that link, their opt-out cookie will be deleted and they will be able to be measured moving forward.		* Users can opt back in via this [https://priv-policy.imrworldwide.com/priv/browser/cookie-policy.html?optout=0 link]. When a user selects that link, their opt-out cookie will be deleted and they will be able to be measured moving forward.
	<br>		<br>
	The following paragraph is a template for a Privacy Statement.		The following paragraph is a template for a Privacy Statement.

FaraazAli at 09:25, 16 September 2022

2022-09-16T09:25:15Z

← Older revision		Revision as of 09:25, 16 September 2022
Line 26:		Line 26:

	=== Add Static Queue Snippet ===		=== Add Static Queue Snippet ===
	The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK ~~seamlessly~~.		The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will seamlessly transition from directing to the queue to the SDK.
	<br>		<br>

Line 82:		Line 82:
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
	\|hem_unknown \|\| Hashed email using SHA512. This email is used by MMS reach model. (required if login feature) \|\| <syntaxhighlight lang="javascript">		\|hem_unknown \|\| Hashed email using SHA512. This email is used by the MMS reach model. (required if login feature) \|\| <syntaxhighlight lang="javascript">
	{hem_unknown: "924899b875ea6767ab790bd2f4852345fcfec5d203c49be8e8..."}		{hem_unknown: "924899b875ea6767ab790bd2f4852345fcfec5d203c49be8e8..."}
	</syntaxhighlight>		</syntaxhighlight>
Line 110:		Line 110:
	Before starting any measurement of an asset(Content or Ad) with the created SDK Instance, you need to create an asset metadata object in order to identify the asset.		Before starting any measurement of an asset(Content or Ad) with the created SDK Instance, you need to create an asset metadata object in order to identify the asset.
	There are two types of asset metadata:		There are two types of asset metadata:
	*~~content~~: identify a video		*Content: identify a video
	*ad: identify each ad		*ad: identify each ad

	The metadata received for each asset is used for classification and reporting.		The metadata received for each asset is used for classification and reporting.

	Metadata ~~are~~ passed through key-values using the Nielsen reserved keys. You will need to set up content and ad objects with the required Nielsen keys as shown in the sample code below.		Metadata is passed through key-values using the Nielsen reserved keys. You will need to set up content and ad objects with the required Nielsen keys, as shown in the sample code below.

	==== Create Content Metadata ====		==== Create Content Metadata ====
	Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.		Content metadata should remain constant throughout the entirety of an episode/clip, including when ads play.
	<br>		<br>
	Please see the [[Sweden_SDK_Metadata\|Metadata link]] for the ~~full~~ list of content metadata.		Please see the [[Sweden_SDK_Metadata\|Metadata link]] for the complete list of content metadata.
	<br/><br>		<br/><br>

Line 136:		Line 136:

	=== Start the Measurement ===		=== Start the Measurement ===
	Nielsen APIs calls are made by calling the function ggPM("event", parameter, ...) with "event" Parameter indicating the SDK API.		Nielsen APIs calls are made by calling the function ggPM("event", parameter, ...) with the "event" Parameter indicating the SDK API.
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	nSdkInstance.ggPM("event", parameter, ...);		nSdkInstance.ggPM("event", parameter, ...);
Line 279:		Line 279:
	* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.		* For Ad Pods, events must be called for each individual Ad. Each Ad playhead position should begin at ‘0’ when ad starts.

	* When content has resumed following an ad break, the playhead position update must continue where previous content segment left off. The playhead position should be passed as a rounded number with no decimals.		* When content has resumed following an ad break, the playhead position update must continue where the previous content segment left off. The playhead position should be passed as a rounded number with no decimals.
	</blockquote>		</blockquote>

Line 292:		Line 292:

	== Privacy and Opt-Out ==		== Privacy and Opt-Out ==
	The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. ~~A user~~ can opt-out if they ~~would~~ prefer not to participate in any Nielsen online measurement research. To implement the User Opt-Out option, include the following two items in your privacy policy.		The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. Users can opt out if they prefer not to participate in any Nielsen online measurement research. To implement the User Opt-Out option, include the following two items in your privacy policy.
	*A notice that the player (or page in relation to static measurement) includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).		*A notice that the player (or page in relation to static measurement) includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
	*A link to the Nielsen Digital Measurement Privacy Policy at https://www.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=sv (or for English: https://nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=en-se)		*A link to the Nielsen Digital Measurement Privacy Policy at https://www.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=sv (or for English: https://nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=en-se)
Line 305:		Line 305:
	The following paragraph is a template for a Privacy Statement.		The following paragraph is a template for a Privacy Statement.
	<blockquote>		<blockquote>
	The properties may feature Nielsen proprietary measurement software, ~~which will allow~~ users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices ~~with regard to~~ it, please see the Nielsen Digital Measurement Privacy Policy at https://nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=sv		The properties may feature Nielsen proprietary measurement software, allowing users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices concerning it, please see the Nielsen Digital Measurement Privacy Policy at https://nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=sv
	</blockquote>		</blockquote>

	==== User Opt Back In ====		==== User Opt Back In ====
	Once users have opted-out, they can choose to opt back into Nielsen Measurement at any time by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.		Once users have opted-out, they can choose to opt back into Nielsen Measurement at any time by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted, and they will be able to be measured.

	==== First Party ID (FPID)====		==== First Party ID (FPID)====
	- The broadcaster must enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK.<br>		- The broadcaster must enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK.<br>

	- The <code>enableFpid</code> flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is true. If this flag is changed from true to false then the AppSDK should wipe out the stored FPID and use a blank value for FPID parameter in all the pings.<br>		- The <code>enableFpid</code> flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is true. If this flag is changed from true to false, then the AppSDK should wipe out the stored FPID and use a blank value for FPID parameter in all the pings.<br>

	- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device or until FPID is wiped out or until it is expired.<br>		- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device or until FPID is wiped out or until it is expired.<br>

	- The default value for this parameter is 180 days. Once this timeout is reached the FPID should be regenerated.<br>		- The default value for this parameter is 180 days. Once this timeout is reached, the FPID should be regenerated.<br>

	== Review the Reference Implementation for VoD and Live Streams ==		== Review the Reference Implementation for VoD and Live Streams ==
Line 325:		Line 325:
	It also covers DAI (Dynamic Ad Insertion) with preroll and post-roll Ads.		It also covers DAI (Dynamic Ad Insertion) with preroll and post-roll Ads.

	In order to start live stream select the checkbox "isLive" below the video player.		In order to start a live stream, select the checkbox "isLive" below the video player.

	Start the Reference Implementation for SE [http://nielsenonlinesupport.com/se/bsdk/index.htm sdkRefImplSE].		Start the Reference Implementation for SE [http://nielsenonlinesupport.com/se/bsdk/index.htm sdkRefImplSE].
Line 334:		Line 334:
	== Test your player by yourself ==		== Test your player by yourself ==
	=== Guide ===		=== Guide ===
	1. Run your player in the Browser, start a video<br />		1. Run your player in the Browser, and start a video<br />
	2. Open the Developer Network View in order to monitor network traffic<br />		2. Open the Developer Network View in order to monitor network traffic<br />
	3. Filter the network traffic by "imr" and confirm the presence of GN pings<br />		3. Filter the network traffic by "imr" and confirm the presence of GN pings<br />

FaraazAli: /* Privacy and Opt-Out */

2022-08-04T07:55:29Z

Privacy and Opt-Out

← Older revision		Revision as of 07:55, 4 August 2022
Line 294:		Line 294:
	The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the User Opt-Out option, include the following two items in your privacy policy.		The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research. To implement the User Opt-Out option, include the following two items in your privacy policy.
	*A notice that the player (or page in relation to static measurement) includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).		*A notice that the player (or page in relation to static measurement) includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings).
	*A link to the Nielsen Digital Measurement Privacy Policy at https://~~sites~~.nielsen.com/~~priv~~/~~browser~~/se/sv~~/optout.html~~ (or for English: https://~~sites.~~nielsen.com/~~priv~~/~~browser~~/se/en~~/optout.html~~)		*A link to the Nielsen Digital Measurement Privacy Policy at https://www.nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=sv (or for English: https://nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=en-se)
	*We have two separate entities registered with the IAB TCF, Nielsen Marketing Cloud and Nielsen LLC. The one that is relevant to Swedish measurement is Nielsen LLC (ID: 812) and not NMC. <br><br>		*We have two separate entities registered with the IAB TCF, Nielsen Marketing Cloud and Nielsen LLC. The one that is relevant to Swedish measurement is Nielsen LLC (ID: 812) and not NMC. <br><br>

Line 305:		Line 305:
	The following paragraph is a template for a Privacy Statement.		The following paragraph is a template for a Privacy Statement.
	<blockquote>		<blockquote>
	The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://~~sites.~~nielsen.com/~~priv~~/~~browser~~/se/sv~~/optout.html~~		The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://nielsen.com/legal/privacy-principles/digital-measurement-privacy-statement/?lang=sv
	</blockquote>		</blockquote>

FaraazAli: /* First Party ID (FPID) */

2021-12-10T12:51:33Z

First Party ID (FPID)

← Older revision		Revision as of 12:51, 10 December 2021
Line 312:		Line 312:

	==== First Party ID (FPID)====		==== First Party ID (FPID)====
	- The broadcaster ~~mist~~ enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK.<br>		- The broadcaster must enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK.<br>

	- The <code>enableFpid</code> flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is ~~false~~. If this flag is changed from true to false then the AppSDK should wipe out the stored FPID and use a blank value for FPID parameter in all the pings.<br>		- The <code>enableFpid</code> flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is true. If this flag is changed from true to false then the AppSDK should wipe out the stored FPID and use a blank value for FPID parameter in all the pings.<br>

	- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device or until FPID is wiped out or until it is expired.<br>		- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device or until FPID is wiped out or until it is expired.<br>

FaraazAli: /* Initialization API Call */

2021-12-10T12:01:41Z

Initialization API Call

← Older revision		Revision as of 12:01, 10 December 2021
Line 87:		Line 87:
	\|-		\|-
	\| enableFpid \|\| true/false value is required to to set collection of first party ID.\|\| <syntaxhighlight lang="javascript">		\| enableFpid \|\| true/false value is required to to set collection of first party ID.\|\| <syntaxhighlight lang="javascript">
	{enableFpid: "true"}		{enableFpid: "true"} //alternative: false
	</syntaxhighlight>		</syntaxhighlight>
	\|}		\|}

FaraazAli: /* Privacy and Opt-Out */

2021-12-10T11:59:34Z

Privacy and Opt-Out

← Older revision		Revision as of 11:59, 10 December 2021
Line 307:		Line 307:
	The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://sites.nielsen.com/priv/browser/se/sv/optout.html		The properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://sites.nielsen.com/priv/browser/se/sv/optout.html
	</blockquote>		</blockquote>

			==== User Opt Back In ====
			Once users have opted-out, they can choose to opt back into Nielsen Measurement at any time by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

	==== First Party ID (FPID)====		==== First Party ID (FPID)====
Line 316:		Line 319:

	- The default value for this parameter is 180 days. Once this timeout is reached the FPID should be regenerated.<br>		- The default value for this parameter is 180 days. Once this timeout is reached the FPID should be regenerated.<br>

	~~==== User Opt Back In ====~~
	Once users have opted-out, they can choose to opt back into Nielsen Measurement at any time by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

	== Review the Reference Implementation for VoD and Live Streams ==		== Review the Reference Implementation for VoD and Live Streams ==

FaraazAli: /* First Party ID (FPID) */

2021-12-10T11:58:43Z

First Party ID (FPID)

← Older revision		Revision as of 11:58, 10 December 2021
Line 311:		Line 311:
	- The broadcaster mist enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK.<br>		- The broadcaster mist enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK.<br>

	- The enableFpid flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is false. If this flag is changed from true to false then the AppSDK should wipe out the stored FPID and use a blank value for FPID parameter in all the pings.<br>		- The <code>enableFpid</code> flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is false. If this flag is changed from true to false then the AppSDK should wipe out the stored FPID and use a blank value for FPID parameter in all the pings.<br>

	- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device or until FPID is wiped out or until it is expired.<br>		- Generated FPID value is stored in the persistent memory until the application is uninstalled from a device or until FPID is wiped out or until it is expired.<br>

FaraazAli: /* First Party ID (FPID) */

2021-12-10T11:58:04Z

First Party ID (FPID)

← Older revision		Revision as of 11:58, 10 December 2021
Line 309:		Line 309:

	==== First Party ID (FPID)====		==== First Party ID (FPID)====
	- The broadcaster mist enableFPID in the initialization settings which is set to true or false depending on user consent. This is to be set by the broadcaster when initializing our SDK.<br>		- The broadcaster mist enableFPID in the initialization settings which is set to <code>true</code> or <code>false</code> depending on user consent. This is to be set by the broadcaster when initializing our SDK.<br>

	- The enableFpid flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is false. If this flag is changed from true to false then the AppSDK should wipe out the stored FPID and use a blank value for FPID parameter in all the pings.<br>		- The enableFpid flag is needed to enable/disable FPID usage for the AppID. The default value for this flag is false. If this flag is changed from true to false then the AppSDK should wipe out the stored FPID and use a blank value for FPID parameter in all the pings.<br>