Keys & Parameters for Targeting and Reporting Purposes

The following are natively supported data keys that can be used for targeting and reporting. You will find these in the console under Admin > Keys for account administrators.

 

Run Time Parameters Supported in Ad Requests

Video SSP supports multiple run time parameters. Some of these are detected/inferred from request and some can be passed as keys in the query string of an ad request. These run time parameters can be used for reporting or targeting purposes.

 

Inferred from Ad Request

Key Name Parameter Targetable Reportable Macro?
Browser n/a Yes No User-agent
Day of Week n/a Yes Yes No
Device Type n/a Yes Yes Yes/User-agent
Geography n/a Yes Yes IP
IP n/a No No Yes
Operating System n/a Yes No User-agent
Video Platform n/a Yes Yes User-agent
View Hour n/a Yes Yes No

 

Passed into Ad Request

The following table reflects the parameters that may be passed in the query string of an ad request for targeting or reporting purposes. There are some default keys that Video SSP supports and then you are also allowed to configure custom keys of your own.

Key Name Parameter Targetable Reportable Macro Applicability Allowed values
Cache Breaker cb       Required for all ad tags Random cache-breaker value
Category categories Yes Yes Yes Optional for all ad tags Max 64 characters
Chromeless v.chromeless       Optional for all ad tags  Disables the display of the countdown, play button, and pause-on-click when value is set to "1"
Custom keys(Two ways of passing)  ctx.ckey  Yes Yes1) Yes Optional for all ad tags
  • Multiple key value pairs are separated by “&”.
  • Values assigned to a key are displayed with an equals sign
  • Max 128 characters per key value..

Example: ctx.ckey1=value1&ctx.ckey2=value2
context
  • Multiple key value pairs are separated by encoded comma “%2C”.
  • Values assigned to a key are displayed with an encoded equals sign “%3D”.
  • Max 128 characters per key value.

Example:
context=key1=value1,key2=value2 must be encoded to: context=Ckey1%3Dvalue1%2Ckey2%3Dvalue2
Player Name pi.sdk      

Optional for all ad tags

Used for reporting purposes only.

Encoded Player name.

“Playwire", "O2"

 
Site pageURL       Required for all ad tags URL-encoded domain or full URL of the site where the player is embedded.
Type of Player Tech loaded pi.sdkType      

Optional for all ad tags

If used, indicates player technology and is used to filter ads.

This field indicates whether flash or js player is loaded 
Video Description description No No Yes  Optional for all ad tags  Max 64 characters 
Video Duration duration No Yes1)  Yes Optional for all ad tags  Max 64 characters 
Video Id id Yes Yes1) Yes  Optional for all ad tags  Max 64 characters 
Video Keywords keywords Yes No Yes  Optional for all ad tags  Max 64 characters 
Video Title title Yes No Yes  Optional for all ad tags Max 64 characters 
Video URL url Yes Yes1) Yes  Optional for all ad tags 

URL-encoded URL of the video content media file.

Max 64 characters

1)Default is no; must be updated to be reportable under Admin > Keys.

 

Passed into Ad Request from a Mobile Device

Other than the parameters mentioned above Video SSP also supports some mobile specific parameters that can be passed in the query string of an ad request from mobile devices for targeting or reporting purposes. A number of these parameters are recommended to be passed to enforce necessary rules of frequency capping in cookie-less environments.

Targeting key Parameter Targetable Reportable Macro Applicability Allowed values
AID for Android a.aid No No No  Preferred for all mobile tags. For enforcing frequency capping in case of apps Android advertising id
App Name appName No (Targeting can be done using Media lists) Yes Yes  Required for all mobile tags called from server-side  
Bundle ID/Package name of the app app_bundle No (Targeting can be done using Media lists) Yes Yes Preferred for all mobile app tags   
Device ID deviceid No No Yes  Preferred for connected TVS. For enforcing frequency capping in case of apps (cookie-less environments).  
IDFA for IOS a.idfa No No No  Preferred for all mobile tags Apple identifier for advertising
IP Address a.ip No No  Yes  Required for all mobile tags called from server-side  
Latitude lat No  No  Yes  Preferred to pass the latitude of the device from the GPS signal  
Longitude lon No  No  Yes  Preferred to pass the longitude of the device from the GPS signal  
Session ID dvc_sid No  No  Yes  Preferred for connected TVS. Enforcing frequency capping in case device ID is not available.  
Store URL app_storeurl No  No  Yes  Preferred for all mobile app tags  
User Agent a.ua No No  Yes  Required for all mobile tags called from server-side  


  

Have more questions? Submit a request