Custom Variables Extension

Engineering Portal / Digital / Custom Variables Extension

Clients can utilize the custom extension functionality of the SDK to enable custom reporting. It leverages additional data passed to the SDK during video play back start.

Custom variables are represented as P values. These are included as a part of the C60 URL query parameter.

Note: There are a number of reserved Cx variables used by the core Video Census product. Duplication / corruption of these reserved variables will probably result in the URI being ignored completely by Video Census.

How to setup custom variables

To populate a custom variable, App can update the input JSON metadata to include the additional custom variable. SDK input should be given as a valid JSON.

Below is an example JSON metadata with custom variables.

	{
	    "type" : "content",
	    "assetid" : "ProgramAssetId5_test1",
	    "tv" : "true",
	    "program":"My Program Name",
	    "title":"My Episode Title",
	    "category":"My Category Title",
	    "length" : "3600",
	    "adloadtype":"2",
	    "dataSrc":"cms",
	    "p0":"Test Consignment Part Number",
	    "p1":"Test AD-ID 2",
	    "p2":"1",
	    "p3":"NielsenReserved1",
	    "p4":"Custom Value",
	    "p5":"PageURL.com",
	    "p6":"NielsenReserved2",
	    "p11":"de-205177_c01_ 1371480336108",
	    "p12":"Content",
	    "p13":"Orginal air date",
	    "p14":"test1_p14",
	    "p15":"test1_p15",
	    "p16":"AGOF-Code",
	    "p17":"pre-roll",
	    "videoID":"test1_videoID",
	    "videoLength":"1500",
	    "PGTitle":"test1_PGtitle",
	    "publisher":"test1_publisher",
	    "liveStream":"NO",
	    "other":"test1_other"
	}

Key variables p0, p1 ….p19 are used for populating the custom variables.

Any data sent in custom variables is URL encoded and encrypted by the SDK. Please consult your Technical Account Manager in case you need to

• Populate a custom URI variable and NOT have the value URL encoded
• Use alternate key names.

Tag variable name / numbering parameters	VA Custom Variables	Description	Format	Required?	Remark	Note for implementation
p0	c0	Consignment Part Number	String	Optional	Identifier for individual consignment parts.	This variable makes it possible to provide additional information to the reduction of parts of a program.
p1	c1	AD-ID 2	Alphanumeric	Optional	Additional AD-ID, which can be filled by two / direct marketers.
p2	c2	Web-Only	String	Optional	Y/N or 1/0	This variable allows the identification of offers that are not broadcast in linear television.
p3	c3	Reserved Nielsen	Mandatory	Optional	Actual: RTL Now, voxnow etc.
p4	c4	Free	Custom
p5	c5	Page URL	String	Optional	URL of the web. The domain name can be extracted from the Page URL
p6	c6	Reserved Nielsen		Optional
p7	c7	Video-ID	Alphanumeric	Mandatory	Unique ID of a content Video Files ( max . Length 200 characters ) Format: ci_vcid_Video-ID Example : de-205177_c01_ 1371480336108 ci: de-205177 separator: _ vcid: c01 separator: _ Video-ID: 1371480336108	Empty in case of advertising and trailer
p8	c8	Length of the Video file	Numeric	Mandatory	Length of the video in seconds Should be rounded to two decimal places. ie 103.34	For Live stream, length is not required
p9	c9	Program Title	String	Mandatory	Max. Length of 255 characters	Mapping in the player at Advertising → empty Trailer → "Trailer" Content → normal title
p10	c10	Publisher	String	Mandatory	"Aggregator" or "owner". Such as ZDF, Smart Clip. If missing , this should be replaced by a string of the domain name	Actual: RTL Now, voxnow etc.
p11	c11	AD-ID	Alphanumeric	Mandatory for Advertising	Required if advertising is to be expelled Unique ID of a content Video Files (max. Length 200 characters) Format: ci_vcid_AD ID Example : de-205177_c01_ 1371480336108 ci: de-205177 separator: _ vcid: c01 separator: _ AD ID: 1371480336108
p12	c12	consignment	String	Optional	Distinguishing criterion for advertising / content for International SDK. Permitted values: "trailer"; "Advertising"; "Content"	Sponsored Opener → Advertising Sponsored Closer → Advertising
p13	c13	Original Air Time	Timestamp	Optional	Seconds Specifically broadcast beginning of linear TV broadcast of this television format. Allows connection to the transmission protocol of the TV research panel Required if no format ID is delivered
p14	c14	Schedule time	Timestamp	Optional	As an alternative to the original airtime, if this cannot be delivered. Allows connection to the transmission protocol of the TV research panel, though there plan period will be delivered
p15	c15	Format-ID	Alphanumeric	Optional	As an alternative to the original plan and airtime. Format ID also enables the identification of offers that were not broadcast in linear television.	VSN (E-number), if available, otherwise blank. In advertising usually empty
p16	c16	Content-ID	Alphanumeric	Optional	Holds different videos together to form a substantive category, be made where geblidet in a separate process in the production availability Hein characteristics. Content ID is supplied both for content as for promotional use. Ex .: AGOF Code	With trailer / Advertising / Content: AGOF Code of Play Buttons
p17	c17	placement	String	Optional	Placement information for advertising. Currently forms: pre-roll, mid-roll, post-roll, Other
p18	c18	LiveStreaming	Text (Yes/No)	Mandatory
p19	c19	Other	String	Optional	Comment field with free text

Sample ping including custom variables

• https://secure-qat2.imrworldwide.com/cgi-bin/d?prd=dcr&ci=APRP7&ch=APRP7_NA&asn=defChnAsset&tl=.%250B%2517pE%2519%251F%251B%2502%2517M7%251BDYP&c6=vc,NA&ca=APRP7_NA_2015Q2&cg=.%250B%2517vT%2504%2509%2513%2509r%2514C%2526YAY%2515&c13=asid,DHG163HR-BH45-JKY6-BKH7-67GJKY68GJK7&c32=segA,CustomSegmentValueA&c33=segB,CustomSegmentValueB&c34=segC,CustomSegmentValueC&c15=apn,QA_AppSDK&sup=0&segment2=539&segment1=usa&forward=0&ad=0&cr=4_00_99_D1_11100&c9=devid,773a9f4ad6d81a0027d255aab8fba986730ebde17cdbfd4631952c26ac943a1d&enc=true&c1=nuid,28c2908271526cb6381c2b59f7afe5c0c811262f63cafe69c7f5d2e3ba458066&r=&at=timer&rt=video&c16=sdkv,bj.5.0.0&c27=cln,160&crs=&si=&lat=-223.323&lon=123.223&c29=plid,14340086662764241&c30=bldv,5.0.0.2&st=dcr&c7=osgrp,NA&c8=devgrp,DSK&c10=plt,DSK&c40=adbid,adobeIdValue4&c14=osver,IOS%2FAndroid&c26=1&c35=&c36=cref1,crossReference11&c37=cref2,&c11=agg,1&c12=apv,&h33=2&c51=adl,0&c52=noad,0&adid=ProgramAssetId5_test1&streamst=1444384462&devtypid=iPad4,1&c3=st,c&c60=agfall,p0=%2517%2517CAjA3%2504V,p1=%2517%2517CA%2504%252F%251CE,p2=%2517%2517CA%2504%252F%251CF,p3=%2517%2517CA%2504%252F%251CG,p4=%2517%2517CA%2504%252F%251C%2540,p5=%2517%2517CA%2504%252F%251CA,p6=%2517%2517CA%2504%252F%251CB,p7=%2517%2517CA%2504%252F%251A%251D%2502%2517%2502%252A6,p8=RG0%2505,p9=%2517%2517CA%2504%252F%253C3%2512%251B%2519%250F%2517,p10=%2517%2517CA%2504%252F%251C%2501%2504%251E%2504%2510%251AUG,p11=%2517%2517CA%2504%252F%251CEW,p12=%2517%2517CA%2504%252F%251CET,p13=%2517%2517CA%2504%252F%251CEU,p14=%2517%2517CA%2504%252F%251CER,p15=%2517%2517CA%2504%252F%251CES,p16=%2517%2517CA%2504%252F%251CEP,p17=%2517%2517CA%2504%252F%251CEQ,p18=,p19=%2517%2517CA%2504%252F%2503t%250E%2517%251F&sessid=1444384462&islive=false&c61=1444384466&c62=sendTime,1444384467&rnd=1444918180921