Update placement banners

Creates or updates the set of banners linked to a placement.

Reference

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

Creates or updates the set of banners linked to a placement. When 'append' is false (default), the provided banner IDs completely replace all existing links by unlinking current banners and linking the new set; when true, the new banners are added without removing existing ones. Banners that do not fit the placement, or whose campaign or advertiser is deleted, are not linked: the answer lists the banners linked in 'linked' and the others in 'skipped' as {id, reason}. A replace (append=false) cannot remove links the caller may not manage; those are listed in 'kept' as {id, reason}. An id that is no banner is refused with 400 and nothing changes. Requires the LINK_PLACEMENTS_TO_BANNERS permission.

Path Params

placementId integer required

Unique identifier of the placement to update banner links for

3001

Form Params

ids array<integer> required

Array of banner IDs to link to the placement. An id of no banner or of a deleted one is skipped and listed in 'skipped' with the reason

42

append boolean

When true, the provided banner IDs are added to the existing linked banners. When false (default), the provided IDs replace all existing links

false

Responses

200

{success, linked, skipped, kept}

400

An id that is no banner

401

Authentication error

403

Insufficient permissions

404

Not found — resource does not exist

500

Internal server error

Language

cURL Request

curl --request PUT \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placements/3001/banners.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'ids=42' \
  --data-urlencode 'append=true'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/3001/banners.do', {
  method: 'PUT',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"ids":"42","append":"true"}),
});

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")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("PUT", HttpRequest.BodyPublishers.ofString("ids=42&append=true"))
    .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("PUT"), "https://YOUR-NETWORK-DOMAIN/rest-api/placements/3001/banners.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["ids"] = "42", ["append"] = "true" });

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("PUT", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/3001/banners.do", strings.NewReader(`ids=42&append=true`))
	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/placements/3001/banners.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'ids=42&append=true');

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::Put.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('ids' => "42", 'append' => "true")

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