# URL Macro Variables Guide

### 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. | <p></p><p>Advertising ID for Android and iOS</p><p>Session-based UUID for other cases</p>                               |
| `[vx_ifa_type]`              | Indicates the type of Identifier for Advertising (IFA) being used.                                                                 | <p><code>'aaid'</code> for Android</p><p><code>'idfa'</code> for iOS</p><p><code>'sessionid'</code> for other cases</p> |
| `[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}>                                                           |
| `[`vx\_av\_url`]`            | Watch video link or live link based on content type                                                                                | `https://vodlix.com/watch/video123`                                                                                     |
| `[`vx\_session\_app\_name`]` | App name from session                                                                                                              | ios\_app                                                                                                                |
| `[`vx\_content\_id`]`        | Video/content ID                                                                                                                   | 123                                                                                                                     |
| `[`vx\_content\_title`]`     | URL encoded content title                                                                                                          | The%20Great%20Movie                                                                                                     |
| `[`vx\_content\_episode`]`   | Boolean - true if content is an episode                                                                                            | true                                                                                                                    |
| `[`vx\_content\_season`]`    | Season ID if content is an episode                                                                                                 | 2                                                                                                                       |
| `[`vx\_content\_series`]`    | Series ID if content is an episode                                                                                                 | 456                                                                                                                     |
| `[`vx\_content\_cat`]`       | Content type label (Movie, Series, etc.)                                                                                           | Movie                                                                                                                   |
| `[`vx\_content\_keywords`]`  | URL encoded content tags                                                                                                           | action%2Cthriller%2Cadventure                                                                                           |
| `[`vx\_content\_genre`]`     | URL encoded genre from categories                                                                                                  | Action%2CThriller                                                                                                       |
| `[`vx\_s\_source`]`          | Video source URL                                                                                                                   | `https://cdn.vodlix.com/videos/video123.mp4`                                                                            |
| `[`vx\_content\_length`]`    | Duration in seconds                                                                                                                | 7200                                                                                                                    |
| `[`vx\_content\_language`]`  | Content language                                                                                                                   | en                                                                                                                      |
| `[`vx\_content\_rating`]`    | MPAA rating                                                                                                                        | PG-13                                                                                                                   |
| `[`vx\_content\_channel`]`   | True if content type is 4 (live channel)                                                                                           | false                                                                                                                   |
| `[`vx\_content\_context`]`   | 'Live' or 'VOD' based on content type                                                                                              | VOD                                                                                                                     |
| `[`vx\_network`]`            | Network information                                                                                                                | Netflix                                                                                                                 |
| `[`vx\_session`]`            | Session ID                                                                                                                         | fda7v4up8u0fg7o6809g8r4jcj                                                                                              |

<br>

#### 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.