URL Macro Variables Guide

Utilize these predefined macro variables for dynamic URL customization. Below is a breakdown of each variable and its typical replacement value.

Macro Variables

Variable
Description
Example Replacement

[vx_cache_buster]

A unique string to prevent caching of content.

Randomly generated string

[vx_width]

The width of the video in pixels.

1920

[vx_height]

The height of the video in pixels.

1080

[vx_gdpr]

GDPR compliance information. (Usually empty if GDPR is not applicable)

1 or 0

[vx_cookie_consent]

Indicates whether the user has consented to cookies.

1 or 0

[vx_appname]

The name of your application/site as configured.

MyAppName

[vx_app_id]

A unique identifier for your application, typically combining platform name and the app's name.

web.myappname.vodlix

[vx_latitude]

The latitude coordinate from the user's IP location.

52.5200

[vx_longitude]

The longitude coordinate from the user's IP location.

13.4050

[vx_timestamp]

A timestamp variable, often used for cache busting or tracking.

1609459200 (Unix Epoch)

[vx_device_type]

The type of device used, determined by checking if the device is mobile or not.

mobile or desktop

[vx_device_os]

The operating system of the device.

iOS, Android, Windows

[vx_ip]

User's IP address, used for geotargeting and compliance with regional ad regulations.

127.0.0.1

[vx_app_bundle]

A unique identifier for your application, typically combining platform name and the app's name.

web.myappname.vodlix

[vx_app_store_url]

URL of the app on the app store, used in certain promotional campaigns.

https://example.com

[vx_device_id]

A unique identifier of the user's device, important for frequency capping and targeting.

f10a3034bb452013

[vx_us_privacy]

Indicates compliance with US privacy laws, essential for advertisers in the United States.

1 or 0

[vx_user_agent]

Indicates the browser or device user agent string of the user. Essential for identifying user environment.

The user agent string from the HTTP request, or 'unknown' if not available.

[vx_lmt]

Indicates the tracking status of user, where 1 signifies the tracking is disabled.

1 or 0

[vx_ifa]

Represents the Identifier for Advertising (IFA), a unique identifier used for tracking and advertising purposes on mobile devices.

Advertising ID for Android and iOS

Session-based UUID for other cases

[vx_ifa_type]

Indicates the type of Identifier for Advertising (IFA) being used.

'aaid' for Android

'idfa' for iOS

'sessionid' for other cases

[vx_iab_category]

Classifies content according to IAB content ta.

E.g., 'IAB1' for Arts & Entertainment, 'IAB2' for Automotive.

[vx_url]

This will only be accessible when viewed in a browser; it will not be available on the app

https://yoursite.com

[vx_content_url]

It will display the content URL, or you can also refer to it as the watch video URL

https://yoursite.com/watch/{content_id}/{content_title}

Implementation

These macros are implemented within URLs in requests. They dynamically replace with relevant data.

Notes

  • It's important to ensure that these macros are correctly implemented to maintain the effectiveness and legal compliance of the ad delivery system.

  • Some macros might be optional or used only in specific scenarios based on the campaign requirements and regulations.

Last updated