/

Browse the help center

Create advertiser custom parameter targeting

Creates a custom parameter targeting rule for the specified advertiser.

Reference

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

Creates a custom parameter targeting rule for the specified advertiser. Supports three modes: EXPRESSION for complex boolean expressions (e.g., '($p1==1 || $p1=="a") && ($p2>=12 && $p2<=22)'), VALUE for simple value matching, and SUBSTRING for partial string matching. When using VALUE or SUBSTRING modes, provide the operation and parameter fields. 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

customValue string required

Custom targeting value — an expression, value, or substring depending on customType

premium_user

customType string

Optional custom target type — EXPRESSION, VALUE, or SUBSTRING

VALUE

operation string

Optional comparison operation — EQUALS, NOT_EQUALS, CONTAINS, or NOT_CONTAINS

EQUALS

parameter string

Optional parameter name for the operation value

segment

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/custom/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'rule=INCLUDE' \
  --data-urlencode 'customValue=premium_user' \
  --data-urlencode 'customType=VALUE' \
  --data-urlencode 'operation=EQUALS' \
  --data-urlencode 'parameter=segment'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/custom/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"rule": "INCLUDE", "customValue": "premium_user", "customType": "VALUE", "operation": "EQUALS", "parameter": "segment"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/custom/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"rule":"INCLUDE","customValue":"premium_user","customType":"VALUE","operation":"EQUALS","parameter":"segment"}),
});

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/custom/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("rule=INCLUDE&customValue=premium_user&customType=VALUE&operation=EQUALS&parameter=segment"))
    .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/custom/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["rule"] = "INCLUDE", ["customValue"] = "premium_user", ["customType"] = "VALUE", ["operation"] = "EQUALS", ["parameter"] = "segment" });

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/custom/create.do", strings.NewReader(`rule=INCLUDE&customValue=premium_user&customType=VALUE&operation=EQUALS&parameter=segment`))
	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/custom/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&customValue=premium_user&customType=VALUE&operation=EQUALS&parameter=segment');

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/custom/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", 'customValue' => "premium_user", 'customType' => "VALUE", 'operation' => "EQUALS", 'parameter' => "segment")

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