Set site video creative requirements

Replaces the publisher's video creative requirements set on the site with the request body; an empty object clears them.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/sites/{siteId}/video-requirements.do

Replaces the publisher's video creative requirements set on the site with the request body; an empty object clears them. The switch is set separately (video-requirements/enable, /disable). Every requirement is optional and only those present are checked: resolutions (each with an optional bitrate range in Mbps that wins over videoBitrate), videoBitrate {min, max} in Mbps, durations in seconds with durationTolerance (default 0.5), frameRates, containers (MP4, MOV, WEBM), videoCodecs (H264, HEVC, PRORES, VP9, AV1, MPEG2), audioCodecs (AAC, PCM, AC3, EAC3, MP3, OPUS), minAudioBitrate in kbps, audioChannels, maxFileSizeMb and loudness {target, tolerance} in LKFS. While the site's switch (enabled) is on, an uploaded video (LOCAL_VIDEO, or the best file of ADVANCED_LOCAL_VIDEOS) that fails them is linked as usual but not served on this site's placements; external video, VAST tags and DSP bids are not checked. Off keeps them but checks nothing. The ad servers apply the change within seconds. Requires UPDATE access to the site and ENABLED level on the SITE_VIDEO_CREATIVE_REQUIREMENTS permission.

Path Params

siteId integer required

Unique numeric ID of the site

5001

Body

A JSON body. An example, built from the field definitions:

{
  "bitrateExemptsProRes": "true",
  "durations": [
    15,
    30
  ],
  "durationTolerance": "0.5",
  "frameRates": [
    23.976,
    29.97
  ]
}

Responses

200

Requirements saved; the stored requirements are returned

400

Invalid body, each problem named in errors by field — e.g. a negative duration, a bitrate range whose min exceeds its max, an unknown codec or container

401

Authentication error

403

Insufficient permissions, naming the missing one

404

Site not found or deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "bitrateExemptsProRes": "true",
  "durations": [
    15,
    30
  ],
  "durationTolerance": "0.5",
  "frameRates": [
    23.976,
    29.97
  ]
}'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json={
    "bitrateExemptsProRes": "True",
    "durations": [
        15,
        30
    ],
    "durationTolerance": "0.5",
    "frameRates": [
        23.976,
        29.97
    ]
})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "bitrateExemptsProRes": "true",
    "durations": [
      15,
      30
    ],
    "durationTolerance": "0.5",
    "frameRates": [
      23.976,
      29.97
    ]
  }),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"bitrateExemptsProRes\":\"true\",\"durations\":[15,30],\"durationTolerance\":\"0.5\",\"frameRates\":[23.976,29.97]}"))
    .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("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("{\"bitrateExemptsProRes\":\"true\",\"durations\":[15,30],\"durationTolerance\":\"0.5\",\"frameRates\":[23.976,29.97]}", Encoding.UTF8, "application/json");

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

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do", strings.NewReader(`{"bitrateExemptsProRes":"true","durations":[15,30],"durationTolerance":"0.5","frameRates":[23.976,29.97]}`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	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/sites/5001/video-requirements.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"bitrateExemptsProRes":"true","durations":[15,30],"durationTolerance":"0.5","frameRates":[23.976,29.97]}');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "{\"bitrateExemptsProRes\":\"true\",\"durations\":[15,30],\"durationTolerance\":\"0.5\",\"frameRates\":[23.976,29.97]}"

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