Create advertiser IP range targeting

Creates an IP range targeting rule for the specified advertiser and enables targeting if it was previously disabled.

Reference

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

Creates an IP range targeting rule for the specified advertiser and enables targeting if it was previously disabled. Both IPv4 and IPv6 addresses are supported. The ipFrom must be less than or equal to ipTo. Returns the created targeting rule as JSON. Requires IP_RANGE targeting permission and UPDATE permission on the advertiser.

Path Params

advertiserId integer required

Unique numeric ID of the advertiser

1234

Form Params

rule string required

Targeting rule type: INCLUDE or EXCLUDE

INCLUDE

ipFrom string required

Start of the IP range (e.g., '194.222.012.001' for IPv4 or '2001:0db8:85a3:0000:0000:8a2e:0370:7334' for IPv6)

192.168.1.0

ipTo string required

End of the IP range (must be greater than or equal to ipFrom)

192.168.1.255

Responses

200

Success

400

Invalid IP range or ipFrom exceeds ipTo

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/ip-range/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'rule=INCLUDE' \
  --data-urlencode 'ipFrom=192.168.1.0' \
  --data-urlencode 'ipTo=192.168.1.255'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/ip-range/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"rule": "INCLUDE", "ipFrom": "192.168.1.0", "ipTo": "192.168.1.255"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/ip-range/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"rule":"INCLUDE","ipFrom":"192.168.1.0","ipTo":"192.168.1.255"}),
});

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/ip-range/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("rule=INCLUDE&ipFrom=192.168.1.0&ipTo=192.168.1.255"))
    .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/ip-range/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["rule"] = "INCLUDE", ["ipFrom"] = "192.168.1.0", ["ipTo"] = "192.168.1.255" });

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/ip-range/create.do", strings.NewReader(`rule=INCLUDE&ipFrom=192.168.1.0&ipTo=192.168.1.255`))
	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/ip-range/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&ipFrom=192.168.1.0&ipTo=192.168.1.255');

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/ip-range/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", 'ipFrom' => "192.168.1.0", 'ipTo' => "192.168.1.255")

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