Get VAST
Request VAST ad markup for a single ad break.
curl -X GET "https://avails.5centscdn.com/v1/vast?publisher_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&content_id=1024&placement=preroll&tags=sports%2Clive&category=3&device=3&device_ua=example_string&language=en&user_key=example_string&device_ip=203.0.113.10&continent_geoname_id=6255149&country_geoname_id=6252001&subdivision_1_geoname_id=5332921&subdivision_2_geoname_id=5391959&city_geoname_id=5391811&country=US®ion=NY&city=New%20York&max_duration=30&min_ad_length=5&max_ad_length=30&max_ads=4&fill_ceiling_seconds=35&break_position=1&break_id=break-1&transaction_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&skipoffset=5&skip_policy=example_string" \
-H "Content-Type: application/json"
import requests
import json
url = "https://avails.5centscdn.com/v1/vast?publisher_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&content_id=1024&placement=preroll&tags=sports%2Clive&category=3&device=3&device_ua=example_string&language=en&user_key=example_string&device_ip=203.0.113.10&continent_geoname_id=6255149&country_geoname_id=6252001&subdivision_1_geoname_id=5332921&subdivision_2_geoname_id=5391959&city_geoname_id=5391811&country=US®ion=NY&city=New%20York&max_duration=30&min_ad_length=5&max_ad_length=30&max_ads=4&fill_ceiling_seconds=35&break_position=1&break_id=break-1&transaction_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&skipoffset=5&skip_policy=example_string"
headers = {
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://avails.5centscdn.com/v1/vast?publisher_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&content_id=1024&placement=preroll&tags=sports%2Clive&category=3&device=3&device_ua=example_string&language=en&user_key=example_string&device_ip=203.0.113.10&continent_geoname_id=6255149&country_geoname_id=6252001&subdivision_1_geoname_id=5332921&subdivision_2_geoname_id=5391959&city_geoname_id=5391811&country=US®ion=NY&city=New%20York&max_duration=30&min_ad_length=5&max_ad_length=30&max_ads=4&fill_ceiling_seconds=35&break_position=1&break_id=break-1&transaction_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&skipoffset=5&skip_policy=example_string", {
method: "GET",
headers: {
"Content-Type": "application/json"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://avails.5centscdn.com/v1/vast?publisher_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&content_id=1024&placement=preroll&tags=sports%2Clive&category=3&device=3&device_ua=example_string&language=en&user_key=example_string&device_ip=203.0.113.10&continent_geoname_id=6255149&country_geoname_id=6252001&subdivision_1_geoname_id=5332921&subdivision_2_geoname_id=5391959&city_geoname_id=5391811&country=US®ion=NY&city=New%20York&max_duration=30&min_ad_length=5&max_ad_length=30&max_ads=4&fill_ceiling_seconds=35&break_position=1&break_id=break-1&transaction_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&skipoffset=5&skip_policy=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://avails.5centscdn.com/v1/vast?publisher_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&content_id=1024&placement=preroll&tags=sports%2Clive&category=3&device=3&device_ua=example_string&language=en&user_key=example_string&device_ip=203.0.113.10&continent_geoname_id=6255149&country_geoname_id=6252001&subdivision_1_geoname_id=5332921&subdivision_2_geoname_id=5391959&city_geoname_id=5391811&country=US®ion=NY&city=New%20York&max_duration=30&min_ad_length=5&max_ad_length=30&max_ads=4&fill_ceiling_seconds=35&break_position=1&break_id=break-1&transaction_id=8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7a&skipoffset=5&skip_policy=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
response = http.request(request)
puts response.body
{}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
/v1/vast
Target server for requests. Edit to use your own host.
Ad Manager project UUID. Scopes the request to a project. Missing or invalid value returns 400.
Content the break is attached to, matched against campaign content targeting allowlists.
Ad placement identifier.
IAB content-category ID, matched against campaign category targeting. Invalid value is ignored with a warning.
IAB device-type ID (1-8), matched against campaign device targeting. Out-of-range value is ignored with a warning.
User-Agent override, for SSAI proxies masking the player's real UA. Falls back to the request's User-Agent header.
Content/ad language targeting.
Frequency-capping / user correlation key.
Client IP override, used for GeoIP resolution and outbound forwarding. Falls back to X-Forwarded-For, then the connection's remote address.
Explicit geo-targeting override.
Explicit geo-targeting override.
Explicit geo-targeting override.
Explicit geo-targeting override.
Explicit geo-targeting override.
Text geo-targeting fallback, used when the geoname-id overrides are not supplied.
Text geo-targeting fallback.
Text geo-targeting fallback.
Break fill target, seconds (IAB BREAKMAXDURATION). 0 if absent or invalid, no warning.
Per-ad minimum duration, seconds (IAB BREAKMINADLENGTH). 0 if absent or invalid, no warning.
Per-ad maximum duration, seconds (IAB BREAKMAXADLENGTH). 0 if absent or invalid, no warning.
Pod-size cap override (IAB BREAKMAXADS). 0 (service default) if absent or invalid, no warning.
Hard overshoot ceiling, distinct from the fill target. 0 (= max_duration) if absent or invalid, no warning.
IAB BREAKPOSITION - 1=pre-roll, 2=mid-roll, 3=post-roll, 4=standalone. Invalid value ignored with a warning.
Correlates the response to a VMAP ad break.
IAB TRANSACTIONID correlator. Left blank if absent (not auto-generated for VAST).
Uniform ad-skip override, written to VAST's <Linear skipoffset>. Accepts false (not skippable), N%, or a number of seconds (including 0, meaning skippable immediately - not the same as false). A malformed value is dropped with a warning.
Full rule-based ad-skip override, URL-encoded JSON matching the SkipPolicy shape from the Ad Manager management API. Highest precedence, above skipoffset and the project's saved default. Malformed/invalid JSON is dropped with a warning and falls back to skipoffset/the saved default.
Request Preview
Response
Response will appear here after sending the request
Query Parameters
Ad Manager project UUID. Scopes the request to a project. Missing or invalid value returns 400.
8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7aContent the break is attached to, matched against campaign content targeting allowlists.
1024IAB content-category ID, matched against campaign category targeting. Invalid value is ignored with a warning.
3IAB device-type ID (1-8), matched against campaign device targeting. Out-of-range value is ignored with a warning.
3User-Agent override, for SSAI proxies masking the player's real UA. Falls back to the request's User-Agent header.
Frequency-capping / user correlation key.
Client IP override, used for GeoIP resolution and outbound forwarding. Falls back to X-Forwarded-For, then the connection's remote address.
203.0.113.10Text geo-targeting fallback, used when the geoname-id overrides are not supplied.
USBreak fill target, seconds (IAB BREAKMAXDURATION). 0 if absent or invalid, no warning.
30Per-ad minimum duration, seconds (IAB BREAKMINADLENGTH). 0 if absent or invalid, no warning.
5Per-ad maximum duration, seconds (IAB BREAKMAXADLENGTH). 0 if absent or invalid, no warning.
30Pod-size cap override (IAB BREAKMAXADS). 0 (service default) if absent or invalid, no warning.
4Hard overshoot ceiling, distinct from the fill target. 0 (= max_duration) if absent or invalid, no warning.
35IAB BREAKPOSITION - 1=pre-roll, 2=mid-roll, 3=post-roll, 4=standalone. Invalid value ignored with a warning.
1234IAB TRANSACTIONID correlator. Left blank if absent (not auto-generated for VAST).
8f2a1c3e-4b5d-4a6e-9f1a-2b3c4d5e6f7aUniform ad-skip override, written to VAST's \<Linear skipoffset\>. Accepts false (not skippable), N%, or a number of seconds (including 0, meaning skippable immediately - not the same as false). A malformed value is dropped with a warning.
5Full rule-based ad-skip override, URL-encoded JSON matching the SkipPolicy shape from the Ad Manager management API. Highest precedence, above skipoffset and the project's saved default. Malformed/invalid JSON is dropped with a warning and falls back to skipoffset/the saved default.
Responses
VAST XML ad response for the requested break.