List an Advanced Local Video(s) banner's video files

The video files (renditions) the banner's VAST offers, in the order they are served: highest bitrate first, then widest.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/vast/media-files.do

The video files (renditions) the banner's VAST offers, in the order they are served: highest bitrate first, then widest. The first row ('servedFirst') is the file a stitcher transcodes from and the one served as the mezzanine; it is also the file a site's video requirements are checked against. 'source' says how a file came: UPLOAD, LINK (downloaded once from 'sourceUrl') or LIBRARY (a media library file, 'mediaAssetId'; referenced, not copied). 'facts' are what was read from the file; a file stored before facts were read has only its size, bitrate, duration and type ('probed' false). 'options' tells an editor whether lower resolutions are made from an upload ('compressionEnabled'; otherwise every file is stored as uploaded and 'scaleTo' is ignored), which ones ('scales'), and the size limit each file is held to; 'editable' is whether the caller may add or delete files. Needs the Advanced Local Video(s) permission and view rights on the banner's advertiser.

Path Params

bannerId integer required

Advanced Local Video(s) banner id

5001

Responses

200

{bannerId, total, editable, options:{compressionEnabled, scales, maxFileSizeBytes}, mediaFiles:[{id, fileName, width, height, bitrate, duration, contentType, mediaAssetId, source, sourceUrl, url, servedFirst, facts:{width, height, durationSeconds, videoBitrateKbps, frameRate, constantFrameRate, videoCodec, container, contentType, audioCodec, audioBitrateKbps, audioChannels, audioSampleRate, fileSizeBytes, loudnessLkfs, probed}}]}

400

The banner is not an Advanced Local Video(s) banner

401

Authentication error

403

The Advanced Local Video(s) permission is off, or no view rights on the banner

404

The banner does not exist or is deleted

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/5001/vast/media-files.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/5001/vast/media-files.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/5001/vast/media-files.do', {
  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/banner/5001/vast/media-files.do"))
    .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/banner/5001/vast/media-files.do");
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/banner/5001/vast/media-files.do", 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/banner/5001/vast/media-files.do");
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/banner/5001/vast/media-files.do")
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