Set a placement's Open RTB settings

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}/openrtb.do

Sets what the console's Open RTB card on a placement sets: the IAB categories sent for it in bid requests (iabCategories), the IAB categories whose ads it refuses (blockedIabCategories), the banner (creative) attributes it blocks (blockedBannerAttributes) and its custom OpenRTB tag id (customOpenRtbTagId). A category is named by its id or its IAB code, e.g. IAB1_2 (IAB1-2 is read the same); a banner attribute by its name or OpenRTB id. Only the fields sent change; send one empty to clear it. Needs the Open RTB permission and update rights on the placement's site.

Path Params

placementId integer required

Placement id

4001

Form Params

iabCategories array<string>

IAB categories sent for the placement in bid requests, by id or IAB code, comma-separated; empty to clear

IAB1,IAB19_18

blockedIabCategories array<string>

IAB categories whose ads the placement refuses, by id or IAB code, comma-separated; empty to clear

IAB7_39

blockedBannerAttributes array<string>

Banner (creative) attributes the placement blocks, sent as OpenRTB battr, by name or OpenRTB id, comma-separated; empty to clear: AUDIO_AD_AUTO_PLAY (1), AUDIO_AD_USER_INITIATED (2), EXPANDABLE_AUTOMATIC (3), EXPANDABLE_USER_INITIATED_CLICK (4), EXPANDABLE_USER_INITIATED_ROLLOVER (5), IN_BANNER_VIDEO_AD_AUTO_PLAY (6), IN_BANNER_VIDEO_AD_USER_INITIATED (7), POP (8), PROVOCATIVE_OR_SUGGESTIVE_IMAGERY (9), SHAKY_FLASHING_FLICKERING_EXTREME_ANIMATION_SMILEYS (10), SURVEYS (11), TEXT_ONLY (12), USER_INTERACTIVE (13), WINDOWS_DIALOG_OR_ALERT_STYLE (14), HAS_AUDIO_ON_OFF_BUTTON (15), AD_CAN_BE_SKIPPED (16)

POP,AUDIO_AD_AUTO_PLAY

customOpenRtbTagId string

Custom OpenRTB tag id sent as imp.tagid instead of the placement key, up to 256 characters; empty to clear

homepage-top-728

Responses

200

The placement's Open RTB settings after the save, in the shape of the GET

400

Nothing sent, a value that is no IAB category or banner attribute, or a custom tag id over 256 characters

401

Authentication error

403

The Open RTB permission is off, or no update rights on the placement's site

404

The placement does not exist or is deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/openrtb.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'iabCategories=IAB1,IAB19_18' \
  --data-urlencode 'blockedIabCategories=IAB7_39' \
  --data-urlencode 'blockedBannerAttributes=POP,AUDIO_AD_AUTO_PLAY'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/openrtb.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"iabCategories": "IAB1,IAB19_18", "blockedIabCategories": "IAB7_39", "blockedBannerAttributes": "POP,AUDIO_AD_AUTO_PLAY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/openrtb.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"iabCategories":"IAB1,IAB19_18","blockedIabCategories":"IAB7_39","blockedBannerAttributes":"POP,AUDIO_AD_AUTO_PLAY"}),
});

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/4001/openrtb.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("iabCategories=IAB1%2CIAB19_18&blockedIabCategories=IAB7_39&blockedBannerAttributes=POP%2CAUDIO_AD_AUTO_PLAY"))
    .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/placements/4001/openrtb.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["iabCategories"] = "IAB1,IAB19_18", ["blockedIabCategories"] = "IAB7_39", ["blockedBannerAttributes"] = "POP,AUDIO_AD_AUTO_PLAY" });

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/placements/4001/openrtb.do", strings.NewReader(`iabCategories=IAB1%2CIAB19_18&blockedIabCategories=IAB7_39&blockedBannerAttributes=POP%2CAUDIO_AD_AUTO_PLAY`))
	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/4001/openrtb.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, 'iabCategories=IAB1%2CIAB19_18&blockedIabCategories=IAB7_39&blockedBannerAttributes=POP%2CAUDIO_AD_AUTO_PLAY');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/openrtb.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('iabCategories' => "IAB1,IAB19_18", 'blockedIabCategories' => "IAB7_39", 'blockedBannerAttributes' => "POP,AUDIO_AD_AUTO_PLAY")

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