List ad units

Returns the network's ad units - the sizes placements and banners are made in - with the placement types each one applies to.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/ad-units.do

Returns the network's ad units - the sizes placements and banners are made in - with the placement types each one applies to. Use an id as adUnitId when creating or updating a placement or a banner. inventorySide marks a unit offered for placements, campaignsSide one offered for banners; custom marks the unit whose width and height are sent alongside it, anySize one that fits every size. Pass placementType to keep only the units of that type. With placementType, width and height the answer is the one unit a placement of that type and size is made in: the unit of exactly that size, or else the type's custom unit - or none when the type has neither.

Query Params

placementType string

Keep only the ad units of this placement type

SITE_PLACEMENT

width integer

With height and placementType: the width of the size to find the unit of, in pixels

300

height integer

With width and placementType: the height of the size to find the unit of, in pixels

250

Responses

200

[{id, name, width, height, custom, anySize, inventorySide, campaignsSide, placementTypes}]

400

Unknown placementType, or width and height without placementType

401

Authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/ad-units.do?placementType=SITE_PLACEMENT&width=300&height=250' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/ad-units.do?placementType=SITE_PLACEMENT&width=300&height=250", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/ad-units.do?placementType=SITE_PLACEMENT&width=300&height=250', {
  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/ad-units.do?placementType=SITE_PLACEMENT&width=300&height=250"))
    .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/ad-units.do?placementType=SITE_PLACEMENT&width=300&height=250");
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/ad-units.do?placementType=SITE_PLACEMENT&width=300&height=250", 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/ad-units.do?placementType=SITE_PLACEMENT&width=300&height=250");
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/ad-units.do?placementType=SITE_PLACEMENT&width=300&height=250")
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