Set campaign weight on a placement

Reference

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

Gives the campaign its own weight on one placement that any of its banners is linked to, replacing its campaign weight in the campaign draw there: summer 3 against fall 1 sends three requests of four to the summer campaign on that placement only. 0 keeps the campaign out of the draw on that placement. House ads stay at 0 whatever is set. Requires UPDATE on the campaign's advertiser and the MANAGE_PLACEMENT_WEIGHTS and MANAGE_CAMPAIGN_WEIGHT permissions. Answers {success, campaignId, placementId, weight, effectiveWeight}; read it back with GET /rest-api/campaign/{campaignId}/placements/weights.do.

Path Params

campaignId integer required

Unique identifier of the campaign

12

placementId integer required

Placement any of the campaign's banners is linked to

3001

Form Params

weight integer required

The campaign's weight on this placement, a whole number from 0 to 32767

3

Responses

200

The weight was set

400

The weight is outside 0-32767

401

Authentication error

403

Insufficient permissions, naming the missing one

404

The campaign does not exist, or none of its banners is linked to the placement

Language

cURL Request

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

Python Request

import requests

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

Node Request

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

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/12/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=3"))
    .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/campaign/12/placements/3001/weight.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["weight"] = "3" });

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

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/12/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' => "3")

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