Add media library videos to an Advanced Local Video(s) banner

Adds media library videos to the banner's video files: one by 'mediaAssetId', or several at once by 'mediaAssetIds'.

Reference

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

Adds media library videos to the banner's video files: one by 'mediaAssetId', or several at once by 'mediaAssetIds'. Every file is checked first — it must be a video the user can see in the library and within the network's video size limit — and if any is refused nothing is added: the 400 names each refused file in errors['mediaAssetIds[<id>]'] (errors.mediaAssetId for the single form, which answers a file it cannot find with 404). A file is referenced, not copied, so deleting the row later leaves the library file in place. A video the banner already has is not added again; 'skipped' names it and its row ('alreadyAdded' gives that row's id for the single form). Needs the Advanced Local Video(s) and Media Library permissions and update rights on the banner's advertiser.

Path Params

bannerId integer required

Advanced Local Video(s) banner id

5001

Form Params

mediaAssetId integer

One media library video id; or send mediaAssetIds

42

mediaAssetIds array<integer>

Several media library video ids, added together or not at all

42

Responses

200

As the list, plus created:[ids], skipped:[{mediaAssetId, mediaFileId}] and, for the single form, alreadyAdded

400

Neither mediaAssetId nor mediaAssetIds, a file that is not a video, is not visible or is over the size limit (per file in errors; nothing is added), not an Advanced Local Video(s) banner, or the file storage service is switched off

401

Authentication error

403

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

404

The banner does not exist, or (single form) the library file does not exist or is not visible

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/5001/vast/media-files/from-library.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'mediaAssetId=42' \
  --data-urlencode 'mediaAssetIds=42'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/5001/vast/media-files/from-library.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"mediaAssetId":"42","mediaAssetIds":"42"}),
});

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/from-library.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("mediaAssetId=42&mediaAssetIds=42"))
    .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/banner/5001/vast/media-files/from-library.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["mediaAssetId"] = "42", ["mediaAssetIds"] = "42" });

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/banner/5001/vast/media-files/from-library.do", strings.NewReader(`mediaAssetId=42&mediaAssetIds=42`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	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/from-library.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/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'mediaAssetId=42&mediaAssetIds=42');

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/from-library.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('mediaAssetId' => "42", 'mediaAssetIds' => "42")

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