Get placement VAST tag

Returns the VAST (Video Ad Serving Template) tag URL for a video placement identified by its key.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/placement/{key}/vast-tag.do

Returns the VAST (Video Ad Serving Template) tag URL for a video placement identified by its key. The placement must be of type VIDEO_PLACEMENT. Supports VAST protocol versions 2.0, 3.0, and 4.0 (defaults to 3.0). The returned tag URL can be used in video players to request video ads.

Path Params

key string required

Unique placement key string (MD5 hash)

a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

Query Params

v string

VAST protocol version: 2.0, 3.0, or 4.0 (default: 3.0)

3.0

Responses

200

VAST tag returned

400

Not a video placement

404

No live placement has this key

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placement/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/vast-tag.do?v=3.0' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/placement/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/vast-tag.do?v=3.0", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placement/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/vast-tag.do?v=3.0', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/placement/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/vast-tag.do?v=3.0"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/placement/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/vast-tag.do?v=3.0");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/placement/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/vast-tag.do?v=3.0", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/placement/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/vast-tag.do?v=3.0");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placement/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/vast-tag.do?v=3.0")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body