Add rules group to banner

Creates a new targeting rules group and associates it with the specified banner.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/{bannerId}/add.do

Creates a new targeting rules group and associates it with the specified banner. A rules group bundles one or more individual rules together with a logical operator (AND/OR) and an include/exclude flag that determines whether matching traffic is allowed or blocked. The response JSON contains 'success: true' and a 'ruleGroupId' field with the newly created group's ID. Requires UPDATE permission on the banner's parent advertiser campaign share and CAMPAIGN_RULES_MANAGEMENT permission. POST only: a GET answers 405, since a state change over GET can be triggered by a prefetch or an embedded link.

Path Params

bannerId integer required

The unique numeric identifier of the banner to add the rules group to

7890

Form Params

ruleIds array<integer> required

Array of rule IDs to include in the new rules group (at least one required)

200

include boolean required

Whether the rules group is an inclusion (true) or exclusion (false) filter

true

operator string required

Logical operator for combining rules within the group: AND (all must match) or OR (any must match)

AND

Responses

200

Rules group added successfully

400

Bad request - ruleIds is empty or names a rule that does not exist

401

Unauthorized - authentication error

403

Forbidden - insufficient permissions

404

Banner not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/add.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'ruleIds=200' \
  --data-urlencode 'include=true' \
  --data-urlencode 'operator=AND'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/add.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"ruleIds": "200", "include": "true", "operator": "AND"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/add.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"ruleIds":"200","include":"true","operator":"AND"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/add.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("ruleIds=200&include=true&operator=AND"))
    .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/rules/banner/7890/add.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["ruleIds"] = "200", ["include"] = "true", ["operator"] = "AND" });

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/rules/banner/7890/add.do", strings.NewReader(`ruleIds=200&include=true&operator=AND`))
	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/rules/banner/7890/add.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, 'ruleIds=200&include=true&operator=AND');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/rules/banner/7890/add.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('ruleIds' => "200", 'include' => "true", 'operator' => "AND")

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