Get ad unit values by banner type

Returns available ad unit (size) values for the given banner type, filtered to only include ad units that are accessible to the authenticated user's role.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/banners/{bannerType}/adunit/values.do

Returns available ad unit (size) values for the given banner type, filtered to only include ad units that are accessible to the authenticated user's role. Valid banner types include: LOCAL_FILE, EXTERNAL_FILE, CODE, LOCAL_VIDEO, EXTERNAL_VIDEO, VAST_2_0_TAG_URL, VPAID_FRAMEWORK, ADVANCED_LOCAL_VIDEOS, TEMPLATE, OPENRTB_DSP, LOCAL_NATIVE, EXTERNAL_NATIVE.

Path Params

bannerType string required

Banner type enum value (e.g. LOCAL_FILE, CODE, LOCAL_VIDEO, OPENRTB_DSP)

LOCAL_FILE

Responses

200

List of ad unit values

400

Bad request — invalid or missing parameters

401

Authentication error

403

Not enough permissions

404

No matching ad units found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banners/LOCAL_FILE/adunit/values.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/banners/LOCAL_FILE/adunit/values.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banners/LOCAL_FILE/adunit/values.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/banners/LOCAL_FILE/adunit/values.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/banners/LOCAL_FILE/adunit/values.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/banners/LOCAL_FILE/adunit/values.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/banners/LOCAL_FILE/adunit/values.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/banners/LOCAL_FILE/adunit/values.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