Whether your channel is created using BrightScript or Direct Publisher, using a custom ad server gives you the flexibility to use URL Parameter Macros. This feature allows parameter values to be substituted in ad request and tracking URLs. It allows for dynamic configuration of values that can be used for ad targeting, interaction tracking, and development purposes, or to optimize the ad experience for the user’s device. Examples of the parameters you can use are: content ID, genre, device ID, etc.
Here's a full list of the available parameters:
| URL Parameter | Description |
|---|---|
| ROKU_ADS_APP_ID | Identifies the client application making the ad request |
| ROKU_ADS_APP_VERSION | Used to obtain the application version string |
| ROKU_ADS_CACHE_BUSTER | Makes the URL unique to avoid retrieving cached ad server responses, or to ensure proper counting of unique event tracking beacons |
| ROKU_ADS_CONTENT_GENRE | Identifies the content categorization to allow for ad targeting |
| ROKU_ADS_CONTENT_ID | Identifies the content to allow for ad targeting |
| ROKU_ADS_CONTENT_LENGTH | Improves ad targeting by providing length of content (in number of seconds) |
| ROKU_ADS_DEVICE_MODEL | Device model |
| ROKU_ADS_DISPLAY_HEIGHT | Height of device display |
| ROKU_ADS_DISPLAY_WIDTH | Width of device display |
| ROKU_ADS_EXTERNAL_IP | External IP address of the device |
| ROKU_ADS_LIB_VERSION | Used to obtain the RAF library version string |
| ROKU_ADS_LIMIT_TRACKING | Set to true or false, depending on whether user has limited ad tracking |
| ROKU_ADS_TIMESTAMP | Current timestamp value (number of milliseconds elapsed since 00:00:00 1/1/1970 GMT) |
| ROKU_ADS_TRACKING_ID | RIDA value used for device identification |
| ROKU_ADS_USER_AGENT | Device model and firmware version |
| ROKU_ADS_KIDS_CONTENT | Mark ad requests as "directed towards children." This macro is designed to help your channel comply with the Children's Online Privacy Protection Act (COPPA) |