Template:iOS Configure Metadata - Revision history

ColinBrown: /* Metadata Example */

2022-03-28T20:23:23Z

Metadata Example

← Older revision		Revision as of 20:23, 28 March 2022
Line 52:		Line 52:
	@ "assetid": @ "C77664",		@ "assetid": @ "C77664",
	@ "program": @ "The Big Bang Theory",		@ "program": @ "The Big Bang Theory",
	@ "title": @ "The Pants Alternative S03E18",		@ "title": @ "The Pants Alternative S03E18", //Formats accepted: S01E03, S1E3, S1 E3
	@ "crossId1": @ "EP009311820061", //optional		@ "crossId1": @ "EP009311820061", //optional
	@ "crossId2": @ "Content Originator", //optional		@ "crossId2": @ "Content Originator", //optional

ColinBrown: /* Metadata Example */

2022-03-28T19:41:07Z

Metadata Example

← Older revision		Revision as of 19:41, 28 March 2022
Line 37:		Line 37:
	"crossId2": "Content Originator", //optional		"crossId2": "Content Originator", //optional
	"length": "3600",		"length": "3600",
	"airdate": "2022-03-21T10:05~~:00-04~~:00", ~~//iso Date Format~~		"airdate": "2022-03-21T10:05:00",
	"isfullepisode": "Yes",		"isfullepisode": "Yes",
	"adloadtype": "2",		"adloadtype": "2",
Line 56:		Line 56:
	@ "crossId2": @ "Content Originator", //optional		@ "crossId2": @ "Content Originator", //optional
	@ "length": @ "3600",		@ "length": @ "3600",
	@ "airdate": @ "2022-03-21T10:05~~:00-04~~:00",		@ "airdate": @ "2022-03-21T10:05:00",
	@ "isfullepisode": @ "y",		@ "isfullepisode": @ "y",
	@ "adloadtype": @ "2",		@ "adloadtype": @ "2",

ColinBrown: /* Metadata Example */

2022-03-28T19:23:45Z

Metadata Example

← Older revision		Revision as of 19:23, 28 March 2022
Line 51:		Line 51:
	@ "type": @ "content",		@ "type": @ "content",
	@ "assetid": @ "C77664",		@ "assetid": @ "C77664",
	@ "program": @ "~~Program Name~~",		@ "program": @ "The Big Bang Theory",
	@ "title": @ "~~S2,E3~~",		@ "title": @ "The Pants Alternative S03E18",
	@ "crossId1": @ "~~Standard Episode ID~~", //optional		@ "crossId1": @ "EP009311820061", //optional
	@ "crossId2": @ "Content Originator", //optional		@ "crossId2": @ "Content Originator", //optional
	@ "length": @ "3600",		@ "length": @ "3600",

ColinBrown: /* Metadata Example */

2022-03-28T19:23:00Z

Metadata Example

← Older revision		Revision as of 19:23, 28 March 2022
Line 35:		Line 35:
	"title": "The Pants Alternative S03E18", //Formats accepted: S01E03, S1E3, S1 E3		"title": "The Pants Alternative S03E18", //Formats accepted: S01E03, S1E3, S1 E3
	"crossId1": "EP009311820061", //optional		"crossId1": "EP009311820061", //optional
	"crossId2": "Content Originator" //optional		"crossId2": "Content Originator", //optional
	"length": "3600",		"length": "3600",
	"airdate": "2022-03-21T10:05:~~00Z~~", //iso Date Format		"airdate": "2022-03-21T10:05:00-04:00", //iso Date Format
	"isfullepisode": "Yes",		"isfullepisode": "Yes",


	"adloadtype": "2",		"adloadtype": "2",
	"segB": "CustomSegmentValueB", //optional		"segB": "CustomSegmentValueB", //optional
	"segC": "CustomSegmentValueC", //optional		"segC": "CustomSegmentValueC" //optional

	];		];
Line 53:		Line 51:
	@ "type": @ "content",		@ "type": @ "content",
	@ "assetid": @ "C77664",		@ "assetid": @ "C77664",
			@ "program": @ "Program Name",
	@ "title": @ "S2,E3",		@ "title": @ "S2,E3",
			@ "crossId1": @ "Standard Episode ID", //optional
			@ "crossId2": @ "Content Originator", //optional
			@ "length": @ "3600",
			@ "airdate": @ "2022-03-21T10:05:00-04:00",
	@ "isfullepisode": @ "y",		@ "isfullepisode": @ "y",
	~~@ "program": @ "Program Name",~~
	~~@ "length": @ "3600",~~
	~~@ "airdate": @ "20200321 10:05:00",~~
	@ "adloadtype": @ "2",		@ "adloadtype": @ "2",
	@ "segB": @ "CustomSegmentValueB", //optional		@ "segB": @ "CustomSegmentValueB", //optional
	@ "segC": @ "CustomSegmentValueC", //optional		@ "segC": @ "CustomSegmentValueC" //optional
	~~@ "crossId1": @ "Standard Episode ID", //optional~~
	~~@ "crossId2": @ "Content Originator" //optional~~
	}		}
	</syntaxhighlight>		</syntaxhighlight>

ColinBrown at 19:19, 28 March 2022

2022-03-28T19:19:28Z

← Older revision		Revision as of 19:19, 28 March 2022
Line 32:		Line 32:
	"type": "content",		"type": "content",
	"assetid": "C77664",		"assetid": "C77664",
	"title": "~~Program S2~~, E3",		"program": "The Big Bang Theory",
			"title": "The Pants Alternative S03E18", //Formats accepted: S01E03, S1E3, S1 E3
			"crossId1": "EP009311820061", //optional
			"crossId2": "Content Originator" //optional
			"length": "3600",
			"airdate": "2022-03-21T10:05:00Z", //iso Date Format
	"isfullepisode": "Yes",		"isfullepisode": "Yes",
	~~"program": "Program Name",~~
	~~"length": "3600",~~
	~~"airdate": "20200321 10:05:00",~~
	"adloadtype": "2",		"adloadtype": "2",
	"segB": "CustomSegmentValueB", //optional		"segB": "CustomSegmentValueB", //optional
	"segC": "CustomSegmentValueC", //optional		"segC": "CustomSegmentValueC", //optional
	~~"crossId1": "Standard Episode ID", //optional~~
	~~"crossId2": "Content Originator" //optional~~
	];		];
	</syntaxhighlight>		</syntaxhighlight>

ColinBrown: Created page with "== Configure Metadata == All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDic..."

2021-08-23T21:02:34Z

Created page with "== Configure Metadata == All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDic..."

New page

== Configure Metadata ==
All the SDK methods handles only two types of objects: NSString, NSDictionary. The parameters passed must be either a JSON formatted string or a NSDictionary object. The JSON passed in the SDK must be well-formed.
* NSDictionary object
** If an object of unexpected type is passed to the method, the error message will be logged.
** If string has invalid JSON format, the error message will be logged.
* JSON value must be string value.
** This includes boolean and numeric values. For example, a value of true should be represented with "true", number value 123 should be "123".
** All the Nielsen Key names (e.g. appid, program) are case-sensitive. Use the correct variable name as specified in the documentation.
* JSON string can be prepared using either raw NSString or serialized NSDictionary.
 
=== Create channelName Metadata ===
channelName should remain constant throughout the completion of an episode or live stream.
 
{| class="wikitable"
|-
! Key !! Description !! Values !! Required
|-
| channelName || Any string representing the channel/stream || custom || ✓
|-
|}

=== Create Content Metadata ===
Content metadata should remain constant throughout the entirety of an episode/clip including when ads play.
<blockquote> program and title metadata values should be passed to SDK as UTF-8 strings. </blockquote>
{{DCR Content Metadata}}

==== Metadata Example ====
<code>Swift</code>
<syntaxhighlight lang="swift">

let contentMetadata = [
"type": "content",
"assetid": "C77664",
"title": "Program S2, E3",
"isfullepisode": "Yes",
"program": "Program Name",
"length": "3600",
"airdate": "20200321 10:05:00",
"adloadtype": "2",
"segB": "CustomSegmentValueB", //optional
"segC": "CustomSegmentValueC", //optional
"crossId1": "Standard Episode ID", //optional
"crossId2": "Content Originator" //optional
];
</syntaxhighlight>
 
<code>Objective-C</code>
<syntaxhighlight lang="objective-c">
NSDictionary * contentMetadata = @ {
@ "type": @ "content",
@ "assetid": @ "C77664",
@ "title": @ "S2,E3",
@ "isfullepisode": @ "y",
@ "program": @ "Program Name",
@ "length": @ "3600",
@ "airdate": @ "20200321 10:05:00",
@ "adloadtype": @ "2",
@ "segB": @ "CustomSegmentValueB", //optional
@ "segC": @ "CustomSegmentValueC", //optional
@ "crossId1": @ "Standard Episode ID", //optional
@ "crossId2": @ "Content Originator" //optional
}
</syntaxhighlight>


=== Ad Metadata ===
The Ad Metadata (if applicable) should be passed for each individual ad.
{| class="wikitable"
|-
! Keys !! Description !! Values !! Required
|-
| type || type of Ad || <code>'preroll'</code>, <code>'midroll'</code>, <code>'postroll'</code> <code>'ad'</code> - If specific type can not be identified.|| ✓
|-
| assetid || unique ID assigned to Ad || custom (no [[Special Characters]]) || ✓
|}

==== Example Ad Object ====
<syntaxhighlight lang="javascript">
// create Ad object
"ad": {
"type": "preroll",
"assetid": "AD-ID123"
}
</syntaxhighlight>

=== Configure Static Metadata if Applicable===
The below is to measure [[DCR Static iOS SDK|Static Content.]]

The Nielsen reserved keys are:
{| class="wikitable"
|-
! Key !! Description !! Data Type !! Value !! Required?
|-style="background-color:#e9f9fa;"
| type || asset type || fixed || <code>'static'</code> || Yes
|-
| 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 (no [[Special Characters]]) || Yes
|-style="background-color:#e9f9fa;"
| 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
|-style="background-color:#e9f9fa;"
| 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.

'''Aggregation Limits'''
There are limits on the number of unique values that can be aggregated on in reporting. The specific limitations by key are:
{| class="wikitable"
|-
! Key !! Aggregation Limit
|-style="background-color:#e9f9fa;"
| section || maximum of 25 unique values (section <= 25)
|-
| segA || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-
| segB || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-style="background-color:#e9f9fa;"
| segC || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|}

=== Example Static Object ===
<syntaxhighlight lang="javascript">
let staticData =
[
"type": "static",
"section": "Section Name",
"segA": "segmentA",
"segB": "segmentB",
"segC": "en-us"
]
</syntaxhighlight>