Set a zone's Open RTB categories

Sets the IAB categories sent for the zone in bid requests (iabCategories) and/or the IAB categories whose ads it refuses (blockedIabCategories), as saving the console's Open RTB card does.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/zones/{zoneId}/openrtb.do

Sets the IAB categories sent for the zone in bid requests (iabCategories) and/or the IAB categories whose ads it refuses (blockedIabCategories), as saving the console's Open RTB card does. A category is named by its id or its IAB code, e.g. IAB1_2 (IAB1-2 is read the same). Only the lists sent change; send a list empty to clear it. Needs the Open RTB permission and update rights on the zone's site.

Path Params

zoneId integer required

Zone id

3001

Form Params

iabCategories array<string>

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

IAB1,IAB19_18

blockedIabCategories array<string>

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

IAB7_39

Responses

200

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

400

Neither list sent, or a value that is no IAB category

401

Authentication error

403

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

404

The zone does not exist or is deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/zones/3001/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'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/zones/3001/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"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/zones/3001/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"))
    .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/zones/3001/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" });

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

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/zones/3001/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")

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