Set banner weight on a placement

Reference

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

Gives the banner its own delivery weight on one placement it is linked to, replacing its banner weight there: within a campaign the ad server picks among the banners linked to the placement in proportion to their weights, so the same creative can take 70 on one placement and 20 on another. Other placements keep the banner weight. Unlinking the placement drops the override. Requires UPDATE on the banner's advertiser and the MANAGE_PLACEMENT_WEIGHTS and MANAGE_BANNER_WEIGHT permissions. Answers {success, bannerId, placementId, weight, effectiveWeight}; read it back with GET /rest-api/banners/{bannerId}/placements/weights.do.

Path Params

bannerId integer required

Unique identifier of the banner

42

placementId integer required

Placement the banner is linked to

3001

Form Params

weight integer required

The banner's weight on this placement, a whole number from 1 to 32767

70

Responses

200

The weight was set

400

The weight is outside 1-32767

401

Authentication error

403

Insufficient permissions, naming the missing one

404

The banner does not exist, or the placement is not linked to it

Language

cURL Request

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

Python Request

import requests

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

Node Request

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

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/42/placements/3001/weight.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("PUT", HttpRequest.BodyPublishers.ofString("weight=70"))
    .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/banners/42/placements/3001/weight.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["weight"] = "70" });

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/banners/42/placements/3001/weight.do", strings.NewReader(`weight=70`))
	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/banners/42/placements/3001/weight.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, 'weight=70');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banners/42/placements/3001/weight.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('weight' => "70")

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