Get placement banners

Retrieves all banners currently linked to the specified placement, filtered to only include banners whose placement type is SITE_PLACEMENT, MOBILE_SITE_PLACEMENT, or NON_STANDARD_SITE_PLACEMENT.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}/banners.do

Retrieves all banners currently linked to the specified placement, filtered to only include banners whose placement type is SITE_PLACEMENT, MOBILE_SITE_PLACEMENT, or NON_STANDARD_SITE_PLACEMENT. The response is a JSON array of banner objects containing basic banner information, plus 'weightOnPlacement' where the banner has its own weight on this placement instead of its banner weight (shown with the MANAGE_PLACEMENT_WEIGHTS and MANAGE_BANNER_WEIGHT permissions) and 'campaignWeightOnPlacement' where its campaign has its own weight here (with MANAGE_CAMPAIGN_WEIGHT). Deleted banners, and banners of private advertisers the caller has no VIEW share on, are excluded from the results; a banner whose advertiser the caller may not view (or a foreign one under MASK_CAMPAIGNS) is named BANNER_{id} and carries no weights. Requires VIEW on the placement's site.

Path Params

placementId integer required

Unique identifier of the placement whose linked banners should be retrieved

3001

Responses

200

List of linked banners

400

Bad request — invalid or missing parameters

401

Authentication error

403

No VIEW share on the placement's site

404

Placement not found or deleted

Language

cURL Request

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

Python Request

import requests

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

Node Request

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