comScore Destination

Destination Info

• Accepts Page, Identify, and Track calls
• Refer to it as comScore in the Integrations object

Components

• Browser
• iOS
• Android

Connection Modes

Device-mode	Cloud-mode
Web	Web
Mobile	Mobile
Server	Server

Segment’s comScore destination code is open source and available on GitHub. Feel free to check it out:

• JavaScript
• iOS
• Android

Getting Started

comScore is supported on mobile apps and web browsers.

Web

When you enable comScore in the Segment App, your changes appear in the Segment CDN within 45 minutes, and then analytics.js starts asynchronously loading comScore’s beacon.js library onto your page. This means you should remove comScore’s snippet from your page.

Be sure to input your comScore c2 ID for comScore to start recording data. The c2 ID can be found by clicking on the “Get Tag” button within the Comscore dashboard. You will need to pull out the C2 Value from the comScore script tag. You do not need to copy/paste the entire script tag.

Mobile

To get started with comScore and Segment, you’ll want to first integrate your mobile app with our iOS or Android sources. comScore can only accept data sent directly from their iOS and Android SDKs. For that reason we can only send data directly from our iOS and Android SDKs to comScore. Data recorded in our server-side sources cannot be sent to comScore.

For mobile sources, you will need to enter your comScore c2 ID and Publisher Secret.

iOS

To install comScore using Segment on iOS, please follow the additional set up steps in the Segment-Comscore iOS repository.

Android

To install comScore using Segment on Android, please follow the additional set up steps in the Segment-Comscore Android repository.

Page

Calling page on web will automatically send a call to comScore’s Application Tag, along with any labels mapped in the Beacon Param Map setting.

Identify

Calling identify with comScore enabled will automatically set the user attributes provided as labels, passing that information on to comScore. With the mobile destination, we map a Segment identify event to comScore’s setPersistentLabelWithName. Identify is not supported in the web destination.

Track

Calling track on events will automatically set the properties of that track call as hidden values in comScore to enhance your reports. With the mobile destination, we map a Segment track event to comScore’s notifyHiddenEventWithLabels. Track is not supported in the web destination.

Screen

Calling screen on mobile will automatically attribute the name, category and properties on that call to be used in the comScore tool. With the mobile destination, we map a Segment screen event to comScore’s notifyViewEventWithLabels. Screen is not supported in the web destination.

Flush

Calling flush will clear the offline cache with comScore’s flushOfflineCache method.

User Consent

To communicate user consent, Comscore requires customers add a label called cs_ucfr to events. Segment supports setting the cs_ucfr label on web only. Using the Comscore User Consent Label setting, input the custom field you would like to map to cs_ucfr. The custom field mapped to cs_ucfr should be present on all page calls as per comScore’s requirements.

Segment will map values to comScore’s cs_ucfr label as outlined below:

cs_ucfr will be omitted in all other cases.

Video Streaming

Note: The video tracking functionality is in beta for mobile only, and requires version 3.0.0 of the Segment-comScore SDK. If you have feedback on or questions about this beta feature, contact us!

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. Refer to our Video Spec and implement video tracking as outlined there. We will map the semantic events to comScore’s relevant methods.

Playback Events

When you call Video Playback Started, Segment initializes an instance of the comScore streamingAnalytics class with [streamingAnalytics createPlaybackSession];. It is essential that this event is called in order to continue tracking through comScore’s Streaming Tag.

From there we will map to the relevant events on the instance as outlined below:

If the properties.position is passed in, we will call the above methods with the play position.

Playback Properties (Labels)

For each playback event, we will set the following asset labels translated from our video spec to comScore:

Note that iOS and Android expect different casing. We expect snake_case for iOS and camelCase for Android.

Content Events

If the properties.position is passed in, we will call the above methods with the play position.

Content Properties (Labels)

Note that iOS and Android expect different casing. We expect snake_case for iOS and camelCase for Android.

Ad Events

Note that iOS and Android expect different casing. We expect snake_case for iOS and camelCase for Android.

Additional Video Destinations Specific Options

Example on passing destination specific option values through on iOS:

options:@{
  @"integrations": @{
   @"com-score" : @{
     @"c3": @"c3 value",
     @"c4: @"c4 value",
     @"c6" : @"c6 value",
     @"tvAirdate" : @"2017-05-22"
    }
  }
}

Example for Android:

Map<String, Object> comScoreOptions = new LinkedHashMap<>();
comScoreOptions.put("c3", "c3 value");
comScoreOptions.put("c4", "c4 value");
comScoreOptions.put("c6", "c6 value");

Analytics.with(context).track("Video Playback Started", new Properties(), new Options().setIntegrationOptions("comScore", comScoreOptions));

Video Metrix Dictionary Classification

Represented with the labels c3, c4, c6, these labels determine which entity the clip will credit to in the Video Metrix dictionary. Segment allows you to pass values for these labels as a destination-specific option, since these values will.

These are required fields, so all three of these labels must always be passed. Unused labels must still be passed with the literal string value *null. These values should ONLY appear as part of the video destination, they should not appear or be set in the general mobile destination.

Airdates

Only mapped on content events. ComScore has two definitions for Airdates: TV Airdate and Digital Airdate.This airdate helps comScore establish monetization windows (live, day +1, day +3, …) for any given episode or show. The monetization windows are used to calculate commercial and program ratings. Each expects a value in yyyy-mm-dd format.

We allow you to pass in one or the other and map to comScore’s labels for each.

tvAirdate : TV Airdate. The date on which the content aired on TV.

digitalAirdate : Digital Airdate. The date on which the content aired digitally.

Classification Type

Classification types are how comScore differentiates between an Ad and Content. Segment allows you to pass in a value for the classification type in two ways:

Ad Classification Type

You can pass in a value for adClassificationType as an integration specific option. Segment defaults to value va00 on all Ad related video tracking events. The values you may dynamically pass in are described by comScore below.

LINEAR - VIDEO ON DEMAND Linear advertisements delivered into a media player and presented before, in the middle of, or after video content is consumed by the user. The advertisement completely takes over the full view of the media player.

LINEAR - LIVE Linear advertisements delivered before, in the middle of, or after a live stream of content. The advertisement completely takes over the full view of the media player.

BRANDED ENTERTAINMENT Media that a user may intentionally view (like content), or it may be served to a user during an ad break (like an advertisement).

Content Classification Type

You can pass in a value for contentClassificationType as a destination-specific option. Segment defaults to value vc00 on all Content related video tracking events. The values you may dynamically pass in are described by comScore below.

PREMIUM Content with strong brand equity or brand recognition. Premium content is usually created or produced by media and entertainment companies using professional-grade equipment, talent, and production crews that hold or maintain the rights for distribution and syndication.

USER-GENERATED Content with little-to-no brand equity or brand recognition. User-generated content (UGC) has minimal production value, and is uploaded to the Internet by non-media professionals.

BUMPERS Bumpers - also known as billboards or slates - are static promotional items which usually run before content and usually last less than 5 seconds.

FAQ

How does comScore determine platform type?

The SDK auto-collects the internal device names, which comScore maps to their reportable Platforms seen broken out in your comScore Direct dashbaord.

How does comScore determine unique devices?

The comScore SDK will collect unique device id’s under the hood, so based on this there is some filtering that can happen here. IN order to see a number for this metric, you need to select a Geography, Client ID, and Platform in the comScore dashboard. The All option will not produce a unique device.

How does comScore determine the application name?

Used in the classification from comScore’s Audience reporting, comScore retrieves the application name from your app’s Info.plist application bundle name as returned by CFBundleName. If you want to override the automatically retrieved value, you can provide a string with your preferred app name.

How does comScore work with ProGuard?

If you are using minifyEnabled in your build, you would need to add the following to your proguard-project.txt file.

-keep class com.comscore.** { *; }
-dontwarn com.comscore.**

The comScore library uses static classes and the code is already optimized. These setting inform ProGuard to add the library as-is.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.