Create banner OS targeting

Creates an operating system targeting rule for the specified banner.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/targeting/operating-system/create.do

Creates an operating system targeting rule for the specified banner. Requires OS targeting permission.

Path Params

bannerId integer required

Unique numeric ID of the banner

7890

Form Params

rule string required

Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist

INCLUDE

operatingSystem string required

Operating system to target (e.g., WINDOWS, MACOS, LINUX, ANDROID, IOS)

ANDROID

version string

Optional OS version: a version value from the OS versions endpoint (for example 16.-1 for iOS 16.x.x) or its title. An unknown version, or a version on an OS without versions, answers 400 with the valid versions

16.-1

relation string

Version comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL. Required when version is sent (a version without it answers 400); ignored without version

GREATER_EQUAL

Responses

200

Success

400

Invalid targeting value

401

Unauthorized

403

Forbidden

404

Banner not found

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/7890/targeting/operating-system/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'rule=INCLUDE' \
  --data-urlencode 'operatingSystem=ANDROID' \
  --data-urlencode 'version=16.-1' \
  --data-urlencode 'relation=GREATER_EQUAL'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/7890/targeting/operating-system/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"rule": "INCLUDE", "operatingSystem": "ANDROID", "version": "16.-1", "relation": "GREATER_EQUAL"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/7890/targeting/operating-system/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"rule":"INCLUDE","operatingSystem":"ANDROID","version":"16.-1","relation":"GREATER_EQUAL"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/banner/7890/targeting/operating-system/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("rule=INCLUDE&operatingSystem=ANDROID&version=16.-1&relation=GREATER_EQUAL"))
    .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/banner/7890/targeting/operating-system/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["rule"] = "INCLUDE", ["operatingSystem"] = "ANDROID", ["version"] = "16.-1", ["relation"] = "GREATER_EQUAL" });

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/banner/7890/targeting/operating-system/create.do", strings.NewReader(`rule=INCLUDE&operatingSystem=ANDROID&version=16.-1&relation=GREATER_EQUAL`))
	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/banner/7890/targeting/operating-system/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, 'rule=INCLUDE&operatingSystem=ANDROID&version=16.-1&relation=GREATER_EQUAL');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/7890/targeting/operating-system/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('rule' => "INCLUDE", 'operatingSystem' => "ANDROID", 'version' => "16.-1", 'relation' => "GREATER_EQUAL")

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