Knowledge Base

Search for anything about "All-in-One Video Gallery"

BACK TO DOCS

Use Ad Tag Variables (Macros)

This is a Premium feature.

Ad tag variables (also known as macros) are dynamic placeholders used by VAST servers to optimize ad delivery and tracking. These variables allow ad servers to gather essential information about ad views, such as the user’s location, the video being played, and the duration of the video. The All-in-One Video Gallery plugin supports a variety of ad tag variables that can be included in your VAST URL. Once an ad request is made, these variables are automatically replaced with real-time values.

Supported Ad Tag Variables

The following table lists the ad tag variables supported by the All-in-One Video Gallery plugin:

VariableDescription
[domain]The domain name where the player is embedded.
[player_width]The width of the video player in pixels.
[player_height]The height of the video player in pixels.
[random_number]A randomly generated number used to prevent caching of the VAST response.
[timestamp]The current time on the user’s device, expressed as a UNIX timestamp.
[page_url]The URL of the page where the video is embedded.
[referrer]The URL of the referring page that directed the viewer to the current player.
[ip_address]The IP address of the user.
[post_id]The ID of the currently playing video. If unavailable, it falls back to the post ID of the embedded player.
[post_title]The title of the currently playing video. If unavailable, it falls back to the post title.
[post_excerpt]A short description of the currently playing video. If unavailable, it falls back to the post description.
[video_file]The URL of the currently playing video file.
[video_duration]The total duration of the currently playing video in seconds.
[autoplay]Returns 0 if autoplay is off, 1 if autoplay is enabled.

Matching Ad Tag Variables with Your Ad Server

The naming conventions used by All-in-One Video Gallery may differ from those used by your ad server. However, you can match the appropriate variable based on the data required.

For example, if your ad server requests the content_url parameter but our plugin uses [page_url], you can use [page_url] to send back the correct value.

Example of an Ad Tag with Variables

Here is an example of a VAST ad tag using our supported variables:

https://adserver.com/vast/12345678?name=[video_title]&page_url=[page_url]&duration=[video_duration]&cachebuster=[random_number]

Breaking Down the Example

  • name → The ad server requires the video title, so we use [video_title] to send the correct value.
  • page_url → The ad server wants the URL where the player is embedded, so we use [page_url].
  • duration → The ad server requests the total video duration, which we provide using [video_duration].
  • cachebuster → Many ad servers require a cachebuster parameter to prevent caching. We fulfill this requirement using [random_number].

Requesting Additional Ad Tag Variables

We continuously strive to support more ad tag variables. While we may not be able to accommodate every unique request, we welcome suggestions.

If your ad server requires a variable not listed above, please contact our support team with the following details:

  • The name of your ad partner.
  • A description of the tag variable you need.

Our team will review your request and consider it for future updates.

Scroll to Top