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

VariableDescriptionExample 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_device_os]

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

127.0.0.1

[vx_dnt]

Reflects user's preference for tracking, critical for privacy compliance.

1 or 0

[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

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