Create placement blocked advertiser targeting

Creates blocked advertiser targeting rules for the specified placement.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/placement/{placementId}/targeting/advertiser/create.do

Creates blocked advertiser targeting rules for the specified placement. Multiple advertiser IDs can be provided as a comma-separated string. The placement must not be deleted. Each advertiser must exist, not be deleted, and the user must have UPDATE permission on it (an UPDATE share, or campaign UPDATE at ALL level). A created target also switches the entity's targeting on, since targets take effect only while it is on. The answer lists the ids targeted now in 'created' and the ones that already were in 'alreadyTargeted'; an unknown or deleted id is refused and nothing is created.

Path Params

placementId integer required

Unique numeric ID of the placement

4001

Form Params

advertiserIds string required

Comma-separated list of advertiser IDs to block (e.g., '123,456,789')

123,456,789

rule string required

Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist

INCLUDE

Responses

200

{success, created, alreadyTargeted}

400

An unknown or deleted id

401

Unauthorized

403

Forbidden

404

Placement or advertiser not found

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/advertiser/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'advertiserIds=123,456,789' \
  --data-urlencode 'rule=INCLUDE'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/advertiser/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"advertiserIds": "123,456,789", "rule": "INCLUDE"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/advertiser/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"advertiserIds":"123,456,789","rule":"INCLUDE"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/advertiser/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("advertiserIds=123%2C456%2C789&rule=INCLUDE"))
    .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("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/advertiser/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["advertiserIds"] = "123,456,789", ["rule"] = "INCLUDE" });

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("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/advertiser/create.do", strings.NewReader(`advertiserIds=123%2C456%2C789&rule=INCLUDE`))
	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/placement/4001/targeting/advertiser/create.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'advertiserIds=123%2C456%2C789&rule=INCLUDE');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/advertiser/create.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('advertiserIds' => "123,456,789", 'rule' => "INCLUDE")

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