DTVR Domless SDK - Revision history

AmySockanathan: Add information about Implementation hooks

2025-06-09T19:49:45Z

Add information about Implementation hooks

← Older revision		Revision as of 19:49, 9 June 2025
Line 82:		Line 82:
	\|domlessEnv: '1'		\|domlessEnv: '1'
	\|}		\|}

			====Implementation Hooks====
			Implementation hooks are essential for the DOM-less SDK to work as expected. Please refer to the "[[Domless_SDK_API_Reference#Implementation Hooks \| Implementation Hooks]] " section in the [[Domless_SDK_API_Reference \| DOM-less SDK API Reference Guide]].

			====Nielsen Debug Node.js Server for Event Tracking====
			We are excited to announce the beta version of our Debug Node.js server, designed to track requests and events sent from our Dom-less SDK using WebSocket connections. While this feature is not officially released, we are currently looking for users interested in beta testing.

			If you'd like to try this tool and provide feedback, please reach out to your Nielsen Technical Account Manager (TAM) for more information. Your insights would be invaluable in helping us refine this feature for a future release!

	=== DOM-less SDK DTVR Video Step 3 - Create DTVR Metadata Object ===		=== DOM-less SDK DTVR Video Step 3 - Create DTVR Metadata Object ===

AmySockanathan: /* Sample DTVR Video Integration */

2024-11-22T16:40:33Z

Sample DTVR Video Integration

← Older revision		Revision as of 16:40, 22 November 2024
Line 199:		Line 199:
	appName: 'BSDK RN Sample App',		appName: 'BSDK RN Sample App',
	deviceId: 'testDeviceId',		deviceId: 'testDeviceId',
	nol_sdkDebug: 'debug', // remove debug flag when going to production domlessEnv:		nol_sdkDebug: 'debug', // remove debug flag when going to production
	// "1" for React Native \| "2" for Amazon \| "3" for NodeJS \| "4" for Custom		domlessEnv: // "1" for React Native \| "2" for Amazon \| "3" for NodeJS \| "4" for Custom
	// reference SDK interface documentation		// reference SDK interface documentation
	// for additonal metadata properties		// for additonal metadata properties

AmySockanathan: /* Events that can be passed to `ggPM` method */

2024-07-31T18:29:55Z

Events that can be passed to `ggPM` method

← Older revision		Revision as of 18:29, 31 July 2024
Line 91:		Line 91:
	'adModel': '1'		'adModel': '1'
	});		});
	2. <code>~~sendId3~~</code> - This event is used to send the id3 event to the Nielsen SDK. This event should be called when the id3 event is triggered, passing the id3 data from the stream.		2. <code>sendID3</code> - This event is used to send the id3 event to the Nielsen SDK. This event should be called when the id3 event is triggered, passing the id3 data from the stream.
	instance.ggPM('~~sendId3~~', '<id3 metadata received>');		instance.ggPM('sendID3', '<id3 metadata received>');
	3. <code>end</code> - This event is used to send the end event to the Nielsen SDK. This event should be called when the video playback is finished, passing the playhead at that time.		3. <code>end</code> - This event is used to send the end event to the Nielsen SDK. This event should be called when the video playback is finished, passing the playhead at that time.
	instance.ggPM('end', 300);		instance.ggPM('end', 300);
Line 252:		Line 252:
	if (data.metadata && data.metadata.key === 'PRIV') {		if (data.metadata && data.metadata.key === 'PRIV') {
	nSdkInstance.then(instance => {		nSdkInstance.then(instance => {
	instance.ggPM('~~sendId3~~', data.metadata.info);		instance.ggPM('sendID3', data.metadata.info);
	});		});
	}		}

AmySockanathan: /* Events that can be passed to `ggPM` method */

2024-07-31T18:23:05Z

Events that can be passed to `ggPM` method

← Older revision		Revision as of 18:23, 31 July 2024
Line 86:		Line 86:

	==== Events that can be passed to `ggPM` method ====		==== Events that can be passed to `ggPM` method ====
	1. <code>~~loadmetadata~~</code> - This event is used to send DTVR metadata to the Nielsen SDK. This event should be called when the video metadata is loaded.		1. <code>loadMetadata</code> - This event is used to send DTVR metadata to the Nielsen SDK. This event should be called when the video metadata is loaded.
	instance.ggPM('~~loadmetadata~~', {		instance.ggPM('loadMetadata', {
	'type': 'content',		'type': 'content',
	'adModel': '1'		'adModel': '1'
	});		});
	2. <code>~~sendid3~~</code> - This event is used to send the id3 event to the Nielsen SDK. This event should be called when the id3 event is triggered, passing the id3 data from the stream.		2. <code>sendId3</code> - This event is used to send the id3 event to the Nielsen SDK. This event should be called when the id3 event is triggered, passing the id3 data from the stream.
	instance.ggPM('~~sendid3~~', '<id3 metadata received>');		instance.ggPM('sendId3', '<id3 metadata received>');
	3. <code>end</code> - This event is used to send the end event to the Nielsen SDK. This event should be called when the video playback is finished, passing the playhead at that time.		3. <code>end</code> - This event is used to send the end event to the Nielsen SDK. This event should be called when the video playback is finished, passing the playhead at that time.
	instance.ggPM('end', 300);		instance.ggPM('end', 300);
Line 239:		Line 239:
	// NOTE: some players may have an event when video metadata is loaded, recommended to use if available. E.g. loadedmetadata		// NOTE: some players may have an event when video metadata is loaded, recommended to use if available. E.g. loadedmetadata
	const onPlay = () => {		const onPlay = () => {
	// Nielsen SDK ggPM '~~loadmetadata~~' event		// Nielsen SDK ggPM 'loadMetadata' event
	if (nSdkInstance && !metadataLoaded) {		if (nSdkInstance && !metadataLoaded) {
	nSdkInstance.then((instance: any) => {		nSdkInstance.then((instance: any) => {
	instance.ggPM('~~loadmetadata~~', videometadata);		instance.ggPM('loadMetadata', videometadata);
	metadataLoaded = true;		metadataLoaded = true;
	});		});
Line 252:		Line 252:
	if (data.metadata && data.metadata.key === 'PRIV') {		if (data.metadata && data.metadata.key === 'PRIV') {
	nSdkInstance.then(instance => {		nSdkInstance.then(instance => {
	instance.ggPM('~~sendid3~~', data.metadata.info);		instance.ggPM('sendId3', data.metadata.info);
	});		});
	}		}

AmySockanathan: /* DOM-less SDK DTVR Video Step 2 - SDK Initialization */

2024-07-31T18:16:44Z

DOM-less SDK DTVR Video Step 2 - SDK Initialization

← Older revision		Revision as of 18:16, 31 July 2024
Line 34:		Line 34:
	This project is an API that allows clients to integrate the Nielsen SDK in DOM-less environments like React Native, NodeJS, etc.		This project is an API that allows clients to integrate the Nielsen SDK in DOM-less environments like React Native, NodeJS, etc.

	Refer to the "DOM-less SDK initialization" section in the ~~DOMless~~ SDK API Reference Guide.		Refer to the " [[Domless_SDK_API_Reference#DOM-less SDK Initialization\|DOM-less SDK initialization]] " section in the [[Domless_SDK_API_Reference\|DOM-less SDK API Reference Guide]].

	==== SDK Initialization ====		==== SDK Initialization ====

AmySockanathan: /* Sample Nielsen BSDK-Domless NodeJS Example */

2024-07-31T17:42:19Z

Sample Nielsen BSDK-Domless NodeJS Example

← Older revision		Revision as of 17:42, 31 July 2024
Line 118:		Line 118:
	==== Sample Nielsen BSDK-Domless NodeJS Example ====		==== Sample Nielsen BSDK-Domless NodeJS Example ====

	* [~~Nielsen bsdk-domless NodeJS Repository Example](<nowiki>~~https://github.com/NielsenDigitalSDK/bsdk-domless-samples/tree/main/nodejs~~</nowiki>)~~		* [https://github.com/NielsenDigitalSDK/bsdk-domless-samples/tree/main/nodejs Nielsen bsdk-domless NodeJS Repository Example]

	==== Sample DTVR Video Integration ====		==== Sample DTVR Video Integration ====

AmySockanathan: /* DOM-less SDK DTVR Video Step 2 - SDK Initialization */

2024-07-30T21:17:50Z

DOM-less SDK DTVR Video Step 2 - SDK Initialization

← Older revision		Revision as of 21:17, 30 July 2024
Line 34:		Line 34:
	This project is an API that allows clients to integrate the Nielsen SDK in DOM-less environments like React Native, NodeJS, etc.		This project is an API that allows clients to integrate the Nielsen SDK in DOM-less environments like React Native, NodeJS, etc.

			Refer to the "DOM-less SDK initialization" section in the DOMless SDK API Reference Guide.

	~~==== Exposed Interface ====~~		==== SDK Initialization ====
	~~The exposed interface is as follows:~~

	~~1. <code>`ggPM`</code> - method to send messages to the Nielsen SDK~~

	~~2. <code>`processEvent`</code> - method to send app state to the Nielsen SDK, e.g., focus, blur, appclose~~

	===== SDK Initialization =====
	The following table contains the list of arguments that can be passed		The following table contains the list of arguments that can be passed
	{\| class="wikitable"		{\| class="wikitable"
Line 94:		Line 88:
	1. <code>loadmetadata</code> - This event is used to send DTVR metadata to the Nielsen SDK. This event should be called when the video metadata is loaded.		1. <code>loadmetadata</code> - This event is used to send DTVR metadata to the Nielsen SDK. This event should be called when the video metadata is loaded.
	instance.ggPM('loadmetadata', {		instance.ggPM('loadmetadata', {

	'type': 'content',		'type': 'content',

	'adModel': '1'		'adModel': '1'

	});		});
	2. <code>sendid3</code> - This event is used to send the id3 event to the Nielsen SDK. This event should be called when the id3 event is triggered, passing the id3 data from the stream.		2. <code>sendid3</code> - This event is used to send the id3 event to the Nielsen SDK. This event should be called when the id3 event is triggered, passing the id3 data from the stream.

AmySockanathan: /* DOM-less SDK DTVR Video Step 2 - SDK Initialization */

2024-07-30T21:14:45Z

DOM-less SDK DTVR Video Step 2 - SDK Initialization

@@ Line 33: / Line 33: @@
 === DOM-less SDK DTVR Video Step 2 - SDK Initialization ===
 This project is an API that allows clients to integrate the Nielsen SDK in DOM-less environments like React Native, NodeJS, etc.
-==== Exposed Interface[edit | edit source] ====
+==== Exposed Interface ====
 The exposed interface is as follows:
@@ Line 148: / Line 133: @@
 import { BsdkInstance } from 'bsdk-domless';
 const nsdkConfig = {
-     app_id: 'DHG163HR-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
+     app_id: 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
      instance_name: 'videoInstance',
 };
@@ Line 243: / Line 228: @@
      const videometadata = {
          'type': 'content',
-        'length': '300',
+         'adModel': '1'
+     }
      const setUpEventListeners = (): void => {
          video.addEventListener('ended', onEnded);
          video.addEventListener('playing', onPlay);
          video.addEventListener('metadata', onMetadata )
      };
@@ Line 267: / Line 243: @@
              metadataLoaded = false;
          });
+         }
      };
@@ Line 290: / Line 253: @@
                  instance.ggPM('loadmetadata', videometadata);
                  metadataLoaded = true;
              });
+         }

AmySockanathan: /* Sample DTVR Video Integration */

2024-07-30T17:30:17Z

Sample DTVR Video Integration

← Older revision		Revision as of 17:30, 30 July 2024
Line 257:		Line 257:
	video.addEventListener('playing', onPlay);		video.addEventListener('playing', onPlay);
	video.addEventListener('pause', onPause);		video.addEventListener('pause', onPause);
	};		video.addEventListener('metadata', onMetadata )
			};

	const onEnded = () => {		const onEnded = () => {
	// Nielsen SDK ggPM 'end' event		// Nielsen SDK ggPM 'end' event
	if (nSdkInstance) {		if (nSdkInstance) {
	nSdkInstance.then((instance: any) => {		nSdkInstance.then((instance: any) => {
	instance.ggPM('end', Math.round(video.currentTime));		instance.ggPM('end', Math.round(video.currentTime));
	metadataLoaded = false;		metadataLoaded = false;
	});		});
	}		}
	};		};

			const onTimeUpdate = () => {
			const currPlayhead = Math.round(video.current?.currentTime!);
			if (currPlayhead > 0 && currPlayhead !== previousPlayhead) {
			previousPlayhead = currPlayhead;
			// Nielsen SDK ggPM 'setplayheadposition' event
			if (nSdkInstance) {
			nSdkInstance.then((instance: any) => {
			instance.ggPM('setplayheadposition', currPlayhead);
			});
			}
			}
			};

			// NOTE: some players may have an event when video metadata is loaded, recommended to use if available. E.g. loadedmetadata
			const onPlay = () => {
			// Nielsen SDK ggPM 'loadmetadata' event
			if (nSdkInstance && !metadataLoaded) {
			nSdkInstance.then((instance: any) => {
			instance.ggPM('loadmetadata', videometadata);
			metadataLoaded = true;
			});
			}
			};

	const ~~onTimeUpdate~~ = () => {		const onPause = () => {
	~~const currPlayhead = Math.round(video.current?.currentTime!);~~		// Nielsen SDK ggPM 'pause' event
	~~if (currPlayhead > 0 && currPlayhead !== previousPlayhead)~~ {
	~~previousPlayhead = currPlayhead;~~ // Nielsen SDK ggPM '~~setplayheadposition~~' event
	if (nSdkInstance) {		if (nSdkInstance) {
	nSdkInstance.then((instance: any) => {		nSdkInstance.then((instance: any) => {
	instance.ggPM('~~setplayheadposition~~', ~~currPlayhead~~);		instance.ggPM('pause', Math.round(video.currentTime));
	});		});
	}		}
	}		};
	};

	// NOTE: ~~some players may have an event when video metadata~~ is ~~loaded, recommended to use if available. E.g. loadedmetadata~~		// NOTE: retireval of ID3 tags will vary by player and is primarily used for DTVR measurement
	const ~~onPlay~~ = () => {		const onMetadata = (data) = {
	~~// Nielsen SDK ggPM 'loadmetadata' event~~		if (data.metadata && data.metadata.key === 'PRIV') {
	if (~~nSdkInstance~~ && ~~!metadataLoaded) {~~		nSdkInstance.then(instance => {
	~~nSdkInstance~~.~~then((instance: any) => {~~		instance.ggPM('sendid3', data.metadata.info);
	~~instance~~.~~ggPM('loadmetadata', videometadata);~~		});
	~~metadataLoaded~~ = ~~true;~~		}
	~~});~~		};
	}
	};		return (
	~~const onPause~~ = () =~~> {~~
	~~// Nielsen SDK ggPM~~ '~~pause~~' ~~event~~
	~~if (nSdkInstance~~) {
	nSdkInstance.then((instance~~: any)~~ => {
	instance.ggPM('~~pause~~', ~~Math~~.~~round(video~~.~~currentTime)~~);
	});
	}
	};
	return (
	<View>		<View>
	<Video source={ { uri: 'https://www.w3schools.com/html/mov_bbb.mp4' } } />		<Video
			source={{ uri: 'https://www.w3schools.com/html/mov_bbb.mp4' }}
			/>
	</View>		</View>
	);		);
	};		};
	</syntaxhighlight>		</syntaxhighlight>

AmySockanathan: /* DOM-less SDK DTVR Video Introduction */

2024-07-26T19:27:58Z

DOM-less SDK DTVR Video Introduction

← Older revision		Revision as of 19:27, 26 July 2024
Line 9:		Line 9:

	* DOM-less SDK Initialization		* DOM-less SDK Initialization
	* DTVR ~~Video~~ Metadata: information about the content being tracked		* DTVR Metadata: information about the content being tracked
	* DTVR ~~Video~~ Events/API calls		* DTVR Events/API calls

	By the end of this guide you will have the needed steps to integrate Nielsen's DOM-less SDK in your app.		By the end of this guide you will have the needed steps to integrate Nielsen's DOM-less SDK in your app.
Line 107:		Line 107:

	==== Events that can be passed to `ggPM` method ====		==== Events that can be passed to `ggPM` method ====
	1. <code>loadmetadata</code> - This event is used to send ~~DCR Video~~ metadata to the Nielsen SDK. This event should be called when the video metadata is loaded.		1. <code>loadmetadata</code> - This event is used to send DTVR metadata to the Nielsen SDK. This event should be called when the video metadata is loaded.
	instance.ggPM('loadmetadata', {		instance.ggPM('loadmetadata', {

Line 115:		Line 115:

	});		});

	2. <code>sendid3</code> - This event is used to send the id3 event to the Nielsen SDK. This event should be called when the id3 event is triggered, passing the id3 data from the stream.		2. <code>sendid3</code> - This event is used to send the id3 event to the Nielsen SDK. This event should be called when the id3 event is triggered, passing the id3 data from the stream.
	instance.ggPM('sendid3', '<id3 metadata received>');		instance.ggPM('sendid3', '<id3 metadata received>');
Line 134:		Line 133:
	'''Sample ID3 Tags'''		'''Sample ID3 Tags'''

	<code>		<code>www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_<wbr />JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00
	www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/X100zdCIGeIlgZnkYj6UvQ==/AAAB2Jz2_k74GXSzx4npHuI_<wbr />JwJd3QSUpW30rDkGTcbHEzIMWleCzM-uvNOP9fzJcQMWQLJqzXMCAxParOb5sGijSV9dNM3QiBniJYGZ5GI-lL1fXTTN0IgZ4iWBmeRiPpS9AAAAAAAAAAAAAAAAAAAAAFJWFM5SVhTONNU=/00000/00000/00

	www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/R8WHe7pEBeqBhu8jTeXydg==/AAICoyitYqlxT7n6aZ0oMCGhe<wbr />Fi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8<wbr />QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00		www.nielsen.com/X100zdCIGeIlgZnkYj6UvQ==/R8WHe7pEBeqBhu8jTeXydg==/AAICoyitYqlxT7n6aZ0oMCGhe<wbr />Fi4CXFp46AMUPZz1lMr_M9tr3_cjee1SHqxrOiVerMDLeyn9xzocZSKwi746Re8vNOtpNCAZjYABs_J0R25IHpvOc1HS8<wbr />QHGgD5TgOJeS6gX100zdCIGeIlgZnkYj6UvVJWFNhSVhTiPE0=/00000/46016/00
	</code>		</code>

	=== DOM-less SDK DTVR ~~Video~~ Step 4 - Basic Set of Events - Sample Playback ===		=== DOM-less SDK DTVR Step 4 - Basic Set of Events - Sample Playback ===

	==== Sample Nielsen BSDK-Domless NodeJS Example ====		==== Sample Nielsen BSDK-Domless NodeJS Example ====
Line 239:		Line 237:
	* Please refer to chosen video player documentation on available events		* Please refer to chosen video player documentation on available events
	*/		*/
	const video = useRef<Video>(null);		const video = useRef<Video>(null);
	let previousPlayhead = 0; // keep track of previous playhead position		let previousPlayhead = 0; // keep track of previous playhead position
	let metadataLoaded = false; // in case of replay scenario set flag for metadata load		let metadataLoaded = false; // in case of replay scenario set flag for metadata load
	// Sample video metadata		// Sample video metadata
	const videometadata = {		const videometadata = {
	'type': 'content',		'type': 'content',
	'length': '300',		'length': '300',
	'censuscategory': 'Enlisted',		'censuscategory': 'Enlisted',
	'title': 'Channel1',		'title': 'Channel1',
	'assetid': '204558915991',		'assetid': '204558915991',
	'section': 'ProgramAsset8',		'section': 'ProgramAsset8',
	'tv': 'true',		'tv': 'true',
	'adModel': '0',		'adModel': '0',
	'dataSrc': 'cms'		'dataSrc': 'cms'
	}		}
	const setUpEventListeners = (): void => {		const setUpEventListeners = (): void => {
	video.addEventListener('ended', onEnded);		video.addEventListener('ended', onEnded);
	video.addEventListener('timeupdate', onTimeUpdate);		video.addEventListener('timeupdate', onTimeUpdate);
	video.addEventListener('playing', onPlay);		video.addEventListener('playing', onPlay);
	video.addEventListener('pause', onPause);		video.addEventListener('pause', onPause);
	};		};

	const onEnded = () => {		const onEnded = () => {
	// Nielsen SDK ggPM 'end' event		// Nielsen SDK ggPM 'end' event
Line 269:		Line 268:
	}		}
	};		};

	const onTimeUpdate = () => {		const onTimeUpdate = () => {
	const currPlayhead = Math.round(video.current?.currentTime!);		const currPlayhead = Math.round(video.current?.currentTime!);
Line 280:		Line 280:
	}		}
	};		};

	// NOTE: some players may have an event when video metadata is loaded, recommended to use if available. E.g. loadedmetadata		// NOTE: some players may have an event when video metadata is loaded, recommended to use if available. E.g. loadedmetadata
	const onPlay = () => {		const onPlay = () => {