Get matching placements for banner

Returns all placements that are compatible with the specified banner and not yet linked to it.

Reference

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

Returns all placements that are compatible with the specified banner and not yet linked to it. Compatibility is determined by placement type, zone, and site sharing rules. Results can be filtered by publisher category IDs and/or placement label names. Each carries id, name, type, zoneId, siteId and, for a placement with a size, width and height. Requires VIEW permission on the banner's advertiser and PLACEMENT_LABELS permission if filtering by labels.

Path Params

bannerId integer required

ID of the banner to find matching placements for

3001

Query Params

publisherCategories array<integer>

IDs of publisher categories to filter matching placements by

10

labels array<string>

Label names to filter matching placements by

premium

Responses

200

List of matching placements

400

Bad request — invalid or missing parameters

401

Authentication error

403

Not enough permissions

404

Banner not found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/matchplacements.do?publisherCategories=10&labels=premium' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/matchplacements.do?publisherCategories=10&labels=premium", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/matchplacements.do?publisherCategories=10&labels=premium', {
  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/3001/matchplacements.do?publisherCategories=10&labels=premium"))
    .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/3001/matchplacements.do?publisherCategories=10&labels=premium");
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/3001/matchplacements.do?publisherCategories=10&labels=premium", 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/3001/matchplacements.do?publisherCategories=10&labels=premium");
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/3001/matchplacements.do?publisherCategories=10&labels=premium")
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