Create advertiser platform rank targeting

Creates a platform rank targeting rule for the specified advertiser.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/{advertiserId}/targeting/platform-rank/create.do

Creates a platform rank targeting rule for the specified advertiser. The rule filters ad requests based on the operating system platform's popularity rank score, using the specified comparison relation. Higher rank values indicate less popular platforms. Requires UPDATE permission on the advertiser and MANAGE_DEMAND_TARGETING user permission.

Path Params

advertiserId integer required

Unique numeric ID of the advertiser

1234

Form Params

rule string required

Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist

INCLUDE

platformRank integer required

Platform popularity rank threshold value

50

relation string

Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is LOWER_EQUAL

GREATER_EQUAL

Responses

200

Success

400

Invalid targeting value

401

Unauthorized

403

Forbidden

404

Advertiser not found

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/platform-rank/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'rule=INCLUDE' \
  --data-urlencode 'platformRank=50' \
  --data-urlencode 'relation=GREATER_EQUAL'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/platform-rank/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"rule": "INCLUDE", "platformRank": "50", "relation": "GREATER_EQUAL"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/platform-rank/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"rule":"INCLUDE","platformRank":"50","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/advertiser/1234/targeting/platform-rank/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("rule=INCLUDE&platformRank=50&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/advertiser/1234/targeting/platform-rank/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["rule"] = "INCLUDE", ["platformRank"] = "50", ["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/advertiser/1234/targeting/platform-rank/create.do", strings.NewReader(`rule=INCLUDE&platformRank=50&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/advertiser/1234/targeting/platform-rank/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&platformRank=50&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/advertiser/1234/targeting/platform-rank/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", 'platformRank' => "50", 'relation' => "GREATER_EQUAL")

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