|
1 | 1 | ---
|
2 | 2 | title: Analytics Swift Nielsen DTVR Plugin
|
3 |
| -strat: swift |
| 3 | +hidden: true |
4 | 4 | ---
|
5 | 5 |
|
6 |
| -Nielsen Digital Content Ratings (DCR) respond to the shifting, complex multi-platform, multi-device and multi-distribution landscape by providing comprehensive measurement of digital content consumption—including streaming video, static web pages and mobile apps—across all major devices and platforms. The [Analytics-Swift Nielsen-DTVR Plugin](https://github.com/segment-integrations/analytics-swift-nielsen-dtvr) tracks sessions for [Analytics-Swift](https://github.com/segmentio/analytics-swift). |
| 6 | +Digital in TV Ratings (DTVR) responds to the shifting and complex multi-platform, multi-device and multi-distribution landscape by providing comprehensive measurement of digital content consumption—including streaming TV commercial video, static web pages and mobile apps—across all major devices and platforms. The [Analytics-Swift Nielsen-DTVR Plugin](https://github.com/segment-integrations/analytics-swift-nielsen-dtvr){:target="_blank”} tracks sessions for [Analytics-Swift](https://github.com/segmentio/analytics-swift){:target="_blank”}. |
7 | 7 |
|
8 | 8 | ## Getting Started
|
9 | 9 |
|
10 |
| -In order to get started with Nielsen-DTVR and retrieve an `appid` to configure this integration, you must sign a license agreement on the Nielsen engineering portal. |
| 10 | +To get started with Nielsen-DTVR and retrieve an `appid` to configure this integration, you must complete the following prerequisites: |
| 11 | +- Fill out your company info and work with a Nielsen representative. |
| 12 | +- Sign a license agreement on the Nielsen engineering portal. |
| 13 | +- Sign an NDA to sign prior to accessing the download. |
| 14 | +- Complete a pre-certification process with your Nielsen representative before shipping this implementation to production. |
| 15 | +- Reach out to your Segment customer service representative to enable the Nielsen-DTVR plugin, as this destination is in private beta. |
11 | 16 |
|
12 |
| -There will be an NDA to sign prior to accessing the download. Nielsen requires you fill out your company info and have a Nielsen representative before getting started. |
13 |
| - |
14 |
| -You must also go through the pre-certification process as outlined here with your Nielsen representative before shipping this implementation to production. The Nielsen-DTVR destination in the Segment dashboard is in private beta. You will need to talk to your Segment customer service representative to get started. |
15 |
| -ata for Nielsen-DTVR, and events are sent via Cloud Mode. |
16 | 17 |
|
17 | 18 | ### Adding the dependency
|
18 | 19 |
|
19 | 20 | ### via Xcode
|
20 | 21 | In the Xcode `File` menu, click `Add Packages`. You'll see a dialog where you can search for Swift packages. In the search field, enter the URL to this repo.
|
21 | 22 |
|
| 23 | +``` |
22 | 24 | https://github.com/segment-integrations/analytics-swift-nielsen-dtvr
|
| 25 | +``` |
23 | 26 |
|
24 | 27 | You'll then have the option to pin to a version, or specific branch, as well as which project in your workspace to add it to. Once you've made your selections, click the `Add Package` button.
|
25 | 28 |
|
26 | 29 | ### via Package.swift
|
27 | 30 |
|
28 |
| -Open your Package.swift file and add the following do your the `dependencies` section: |
| 31 | +Open your Package.swift file and add the following to the `dependencies` section: |
29 | 32 |
|
30 | 33 | ```
|
31 | 34 | .package(
|
@@ -55,4 +58,48 @@ analytics.add(plugin: NielsenDTVRDestination())
|
55 | 58 | ```
|
56 | 59 |
|
57 | 60 |
|
58 |
| -Your events will now be given Nielsen-DTVR session data and start flowing to Nielsen-DTVR via Device Mode. |
| 61 | +Your events now contain Nielsen-DVTR session data and flow to Nielsen-DVTR in device-mode. |
| 62 | + |
| 63 | +## Track |
| 64 | + |
| 65 | +Segment only supports sending Track events as outlined in our [Video Spec](/docs/connections/spec/video/). To get started tracking video content through Segment, make sure you are using a media player that has an API which allows you to detect the player state such as video or ad plays. For example, you would not be able to collect ad plays using YouTube since their YouTube SDK does not expose any hooks into player states during ad plays. |
| 66 | + |
| 67 | +**IMPORTANT**: We will map the semantic events and properties in the Segment [Video Spec](/docs/connections/spec/video/) to Nielsen's relevant methods and metadata. If you do not implement the Segment [Video Spec](/docs/connections/spec/video/) properly, this integration will not behave properly. |
| 68 | + |
| 69 | +## Settings |
| 70 | + |
| 71 | +#### App ID |
| 72 | +Once the Segment source is integrated with your app, toggle |
| 73 | +Nielsen-DTVR on in your Segment destinations catalog, and add your `appId`, |
| 74 | +which you can retrieve from your Nielsen representative. |
| 75 | + |
| 76 | +The `appId` is the unique id for the application assigned by Nielsen. It is |
| 77 | +GUID data type. Be sure to use the test `appId` during development, test, and |
| 78 | +certification processes. Use Production appid to submit app to App / Play |
| 79 | +store, after receiving Nielsen certification. |
| 80 | + |
| 81 | +These new settings will take up to an hour to propagate to all of your existing |
| 82 | +users. For new users it will be instantaneous. |
| 83 | + |
| 84 | +#### Enable Debug Mode |
| 85 | +Check this setting if you would like to activate the |
| 86 | +Debug flag. Once the flag is active, it logs each API call made and the data |
| 87 | +passed. DO NOT activate the Debug flag in a production environment. |
| 88 | + |
| 89 | +#### id3Property |
| 90 | +Indicate the key in your payload associated with the id3 tag. |
| 91 | +If one is not provided we will default to `id3`. |
| 92 | + |
| 93 | +#### Events to Send Id3 Tags |
| 94 | +Add the event names you would like to trigger Segment to `sendId3` tags. |
| 95 | + |
| 96 | +#### sfcode |
| 97 | +Required for mobile only: Add the unique identifier for the |
| 98 | +environment that the Nielsen SDK should point to. If not specified the default |
| 99 | +value will be `us`. |
| 100 | + |
| 101 | +<!-- Nielsen does not host their framework on a dependency management site such |
| 102 | +as Cocoapods nor Maven. You must manually add the framework after installing |
| 103 | +the Segment-Nielsen-DTVR dependency. Navigate to [Nielsen's Engineering |
| 104 | +Site](https://engineeringportal.nielsen.com/docs/Digital_Downloads){:target="_blank"} and |
| 105 | +download the Video framework. --> |
0 commit comments