NickParrucci at 13:29, 27 July 2023

2023-07-27T13:29:26Z

← Older revision		Revision as of 13:29, 27 July 2023
Line 694:		Line 694:

	== → iOS DTVR (coming soon) ==		== → iOS DTVR (coming soon) ==

	<!--		<!--

	<span class="mw-customtoggle-myDivision100" style="color: cornflowerblue"> Show/hide iOS DTVR </span>		<span class="mw-customtoggle-myDivision100" style="color: cornflowerblue"> Show/hide iOS DTVR </span>
	<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivision100">		<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivision100">
Line 1,082:		Line 1,080:

	</div>		</div>
			-->


	</div>		</div>
	~~-->~~

NickParrucci at 13:26, 27 July 2023

2023-07-27T13:26:30Z

← Older revision		Revision as of 13:26, 27 July 2023
Line 694:		Line 694:

	== → iOS DTVR (coming soon) ==		== → iOS DTVR (coming soon) ==

	<!--		<!--

	<span class="mw-customtoggle-myDivision100" style="color: cornflowerblue"> Show/hide iOS DTVR </span>		<span class="mw-customtoggle-myDivision100" style="color: cornflowerblue"> Show/hide iOS DTVR </span>
	<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivision100">		<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivision100">

NickParrucci: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital NOTOC Provided below are step-by-step quick start guides for implementing Nielsen iOS SD..."

2023-05-05T14:16:24Z

Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital __NOTOC__ Provided below are step-by-step quick start guides for implementing Nielsen iOS SD..."

New page

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
[[Category:Digital]]
__NOTOC__

Provided below are step-by-step quick start guides for implementing Nielsen iOS SDK for DCR Static, DCR Video, and DTVR products. Click each section to get started.

== → iOS DCR Static ==
<span class="mw-customtoggle-myDivision" style="color: cornflowerblue"> Show/hide DCR Static </span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivision">

==== iOS DCR Static Introduction ====
<span class="mw-customtoggle-myDivisiona-" style="color: cornflowerblue"> Show/hide Intro </span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivisiona-">

The Digital Content Ratings (DCR) Static product provides content consumption measurement on client webpages. This measurement includes insight into the total time a user spent on a webpage, how they navigated through the page via links, and many other data points.
This tutorial provides the steps to implement the DCR Static product in a sample iOS app. It includes:

*SDK Initialization Call
*DCR Static Metadata: information about the sections being tracked

By the end of this guide you will have the needed steps to integrate Nielsen's AppSDK in the background of your app.
</div>

=== iOS DCR Static Step 1 - Obtain AppID ===
<span class="mw-customtoggle-myDivisiona" style="color: cornflowerblue"> Show/hide step 1 </span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivisiona">

To begin using the iOS SDK (AppSDK) you will need to obtain an Application ID (AppId)

{| class="wikitable"
|-
! !! Item !! Description !! Source
|-
|✅ || App ID (appid) || Unique ID assigned to the player/site and configured by product || Contact your Nielsen TAM

|}

The appid is a 37 character unique ID assigned to the player/site and configured by product and is required when creating a new instance of the AppSDK on the webpage.
</br>Example: '''PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX'''

</div>

=== iOS DCR Static Step 2 - SDK Initialization ===
<span class="mw-customtoggle-myDivisionc" style="color: cornflowerblue"> Show/hide step 2 </span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivisionc">

==== How to obtain the NielsenAppApi.Framework ====
The Nielsen AppSDK can either be downloaded directly or can be integrated directly within an application through the use of CocoaPods. We recommend using the CocoaPods-based integration whenever possible to ensure you maintain the most recent changes and enhancements to the Nielsen libraries.
* [[Digital_Measurement_iOS_Artifactory_Guide|Select to obtain CocoaPods implementation guide]]
* [[Special:Downloads|Select to Download Directly]]

==== Configuring Xcode Development Environment ====
Starting with SDK version 6.0.0.0, the Nielsen App SDK is compatible with Apple iOS versions 8.0 and above. In addition, when using the dynamic framework, all the required frameworks are linked automatically as the are needed. More details can be found here: https://stackoverflow.com/questions/24902787/dont-we-need-to-link-framework-to-xcode-project-anymore

<blockquote>'''Note''': All communications between the SDK and the Census (Collection Facility) use HTTPS.</blockquote>

==== Download Framework ====
The first step is to download and copy the [[Special:Downloads|NielsenAppApi.framework]] bundle to the app project directory. (''Not required if using CocaPods'')

==== Add Framework ====
In the General tab for app configuration add NielsenAppApi.framework in the list of Embedded Binaries. (''Not required if using CocaPods'')

==== Add Path ====
Add path to the NielsenAppApi.framework in the Framework Search Paths build setting. (''Not required if using CocaPods'')

==== Import Framework ====
Add NielsenAppApi.framework module in the source file of your app:

==== Using Swift ====
Add the following:
<syntaxhighlight lang="swift">
import NielsenAppApi
</syntaxhighlight>

==== Using Objective-C ====
<syntaxhighlight lang ="objective-c">
@import NielsenAppApi;
</syntaxhighlight>

=== Sample SDK Initialization Code ===
{{ExampleCode|
|Swift =
Swift 4.0 Example:
<code>NielsenInit.swift</code>
<syntaxhighlight lang="swift">
import Foundation
import NielsenAppApi

class NielsenInit : NSObject {
class func createNielsenApi(delegate: NielsenAppApiDelegate) -> NielsenAppApi?{

let appInformation:[String: String] = [
"appid": "PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
"sfcode": "dcr",
"nol_devDebug": "DEBUG"
]
return NielsenAppApi(appInfo:appInformation, delegate:delegate)
}
}
</syntaxhighlight>

Sample code using AVPlayer.
<code>LandingVC.swift</code>

<syntaxhighlight lang="swift">
import UIKit
import NielsenAppApi

class LandingVC: UIViewController, NielsenAppApiDelegate {

var nielsenMain : NielsenAppApi!
var sdkMethods : SDKMethods!
var data : [String : Any]!

class ViewController: UIViewController, NielsenAppApiDelegate, AVPlayerViewControllerDelegate {

// your code//

override func viewDidLoad() {
super.viewDidLoad()
//Getting the instance of NielsenApi
self.nielsenApi = NielsenInit.createNielsenApi(delegate: self)
}
}
override func viewDidAppear(_ animated: Bool) {
self.data = sdkMethods.loadStaticMaster() // This is just an example of populating the metadata
self.nielsenMain.loadMetadata(self.data)
}
</syntaxhighlight>
|Objective C =
Initialize the Nielsen App object within the viewDidLoad view controller delegate method using initWithAppInfo:delegate:
<blockquote>If App SDK is initialized using init or new methods, it will ignore the API calls resulting in no measurement. The SDK will not return any errors.</blockquote>
<syntaxhighlight lang="objective-c">
#import "NielsenInit.h"
#import <NielsenAppApi/NielsenEventTracker.h>

@implementation NielsenInit

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate
{
//Initialising the NielsenEventTracker class by passing app information which returns the instance of NielsenEventTracker.

NSDictionary *appInformation = @{ @"appid": @"PDA7D5EE6-B1B8-4123-9277-2A788XXXXXXX",
@"appversion": @"1.0",
@"sfcode": @"dcr",
@"nol_devDebug": @"DEBUG", };

return [[NielsenAppApi alloc] initWithAppInfo:appInformation delegate:delegate];
}

@end
</syntaxhighlight>

The following would be the <code>NielsenInit.h</code> file:
<syntaxhighlight lang="objective-c">
#import <Foundation/Foundation.h>

@class NielsenAppApi;
@protocol NielsenAppApiDelegate;

@interface NielsenInit : NSObject

+ (NielsenAppApi *)createNielsenAppApiWithDelegate:(id<NielsenAppApiDelegate>)delegate;

@end
</syntaxhighlight>
Sample Code:
<syntaxhighlight lang="objective-c">
@implementation ViewController

- (void)viewDidLoad {
[super viewDidLoad];

//Getting the instance of Nielsen SDK
nielsenApi = [NielsenInit createNielsenAppApiWithDelegate:nil];
</syntaxhighlight>
}}

</div>

=== iOS DCR Static Step 3 - Create/Load DCR Static Metadata Object ===
<span class="mw-customtoggle-myDivisiond" style="color: cornflowerblue"> Show/hide step 3 </span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivisiond">

==== Configure Metadata ====
Map the Nielsen keys to variables so that the content metadata is dynamically updated.

The Nielsen reserved keys are:
{| class="wikitable"
|-
! Key !! Description !! Data Type !! Value !! Required?
|-
| type || asset type || fixed || <code>'static'</code> || Yes
|-
| assetid || Unique ID for each article || dynamic || custom <br>(no [[Special Characters]]) || No
|-
| section || section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values || dynamic || custom || Yes
|-
| segA || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || dynamic || custom || No
|-
| segB || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || dynamic || custom || No
|-
| segC || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || dynamic || custom || No
|}

The values passed through the Nielsen keys will determine the breakouts that are seen in reporting. The custom segments (A, B & C) will roll into the sub-brand. To not use custom segments A, B and C, do not pass any value in these keys.

==== Configure API calls - loadMetadata ====
Use [[loadMetadata]] to pass 'content' [[Digital Measurement Metadata]]. The CMS data must be passed as a JSON object.
<syntaxhighlight lang="java"> loadMetadata(JSONObject jsonMetadata);</syntaxhighlight>

<blockquote>Note: The [[loadMetadata]] call must have ("type": "static"). </blockquote>

Call [[loadMetadata]] with JSON metadata as below.
<syntaxhighlight lang="java"> new JSONObject()
.put("type", "static")
.put("section", "siteSection")
.put("assetid", "vid345-67483")
.put("segA", "segmentA")
.put("segB", "segmentB")
.put("segC","segmentC")
}</syntaxhighlight>

As soon as this loadMetadata call is made, AppSDK will record a view event and start tracking the section/page time spent (AppSDK 9.1 and above).

==== DCR Static Duration Measurement per Section/Page/Asset ====
If your Nielsen AppID is enabled for DCR Static duration measurement, a view event will be recorded and a timer will be started for each screen/page. Duration will be measured until a new page is loaded or the app is moved to the background. The event which triggers recognition of page view and timer start is the loadMetadata API call with a metadata object of type 'static'. Once a page is viewed and the timer has started, duration will be measured until a new page has loaded ''with associated loadMetadata call having a different '''section name''' from the previous page''. If a new loadMetadata call is made with the same '''section name''', it will be ignored - no new view will be recorded. If it is desired to have a new view event even though the metadata contains the same '''section name''' (example: single-page apps having several assedIDs but common section name), staticEnd API can be called between page views. For the purposes of this overview, staticend will not be used. See [[DCR_Static_iOS_SDK|this page]] for more information. <br>

</div>

=== Keep Going ===
<span class="mw-customtoggle-myDivisiong" style="color: cornflowerblue"> Show/hide </span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivisiong">

Congratulations, you've successfully integrated the iOS SDK in your app!

You can add static loadMetadata calls for more sections/pages in your app to see what happens when transitioning between sections.

View your application's debug logs and search for the term (AppSDK) to see messages emitted by Nielsen AppSDK.

</div>

=== Next Steps ===
<span class="mw-customtoggle-myDivisioni" style="color: cornflowerblue"> Show/hide </span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivisioni">

Now that you've integrated DCR Static for the AppSDK, what's next?

====Going Live====

In addition to the basic steps above, before going live developers need to handle app background/foreground events, make certain privacy disclosures, and allow users to opt out of Nielsen measurement. More details can be found [[DCR_Static_iOS_SDK|here]], along with a more comprehensive reference for implementing DCR Static measurement with AppSDK.

Once the DCR Tracking Code is added, Nielsen will validate the implementation. Following Nielsen testing, developers need to make a few updates to the initialization call to ensure that the app is being measured properly.

#'''App ID''': Ensure that correct is used during initialization '''PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'''
#'''Debug Logging''': Disable logging by changing initialization call to use @"nol_devDebug":@"INFO".

</div>

</div>

== → iOS DCR Video (coming soon) ==


== → iOS DTVR (coming soon) ==

iOS Step By Step - Revision history

Mywikis at 02:50, 27 March 2024

NickParrucci at 13:30, 27 July 2023

NickParrucci at 13:29, 27 July 2023

NickParrucci at 13:26, 27 July 2023

NickParrucci at 13:25, 27 July 2023

NickParrucci at 13:24, 27 July 2023

NickParrucci: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital NOTOC Provided below are step-by-step quick start guides for implementing Nielsen iOS SD..."

← Older revision		Revision as of 13:25, 27 July 2023
Line 1,081:		Line 1,081:
	</div>		</div>

	~~-->~~

	</div>		</div>
			-->

iOS Step By Step - Revision history

Mywikis at 02:50, 27 March 2024

NickParrucci at 13:30, 27 July 2023

NickParrucci at 13:29, 27 July 2023

NickParrucci at 13:26, 27 July 2023

NickParrucci at 13:25, 27 July 2023

NickParrucci at 13:24, 27 July 2023

NickParrucci: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital __NOTOC__ Provided below are step-by-step quick start guides for implementing Nielsen iOS SD..."

NickParrucci: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} Category:Digital NOTOC Provided below are step-by-step quick start guides for implementing Nielsen iOS SD..."