Set how zone targeting rules of one type combine

Sets how the zone's Include or Exclude list of one targeting type combines, for the types a visitor can hold several values of: COOKIE_VALUE, CUSTOM, DMP and API_JSON_FIELD.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/zone/{zoneId}/targeting/match-mode.do

Sets how the zone's Include or Exclude list of one targeting type combines, for the types a visitor can hold several values of: COOKIE_VALUE, CUSTOM, DMP and API_JSON_FIELD. A list splits into groups: the rules on one key a visitor holds once (one cookie name, one custom parameter) are alternatives, and every other rule (a DMP segment, an API JSON field, a custom parameter registered as a list, an expression) is a group of its own. ANY (the default) — an Include list passes when any group matches, an Exclude list keeps out a visitor matching any group. ALL — an Include list passes only when every group matches, an Exclude list keeps out only a visitor matching every group: tier=gold, tier=silver and region=eu under ALL read (tier = gold or silver) and (region = eu). Every rule of the list takes the mode, and a rule created later joins its list's mode. The response carries a warning when the switch leaves a value both included and excluded, at this level or against a level above. Requires UPDATE permission on the zone's site, MANAGE_SUPPLY_PRE_TARGETING and the type's own targeting permission (e.g. PRETARGETING_COOKIE_VALUE).

Path Params

zoneId integer required

Unique numeric ID of the zone

200

Form Params

type string required

Targeting type whose list to set — COOKIE_VALUE, CUSTOM, DMP or API_JSON_FIELD

COOKIE_VALUE

rule string required

Which list to set — INCLUDE or EXCLUDE

INCLUDE

matchMode string required

ANY — one group is enough; ALL — every group must match

ALL

Responses

200

Success — the response carries the type, the rule, the saved matchMode, how many rules changed (updated) and, when a value is now both included and excluded, a warning

400

Missing or unknown type, rule or matchMode, a type without a match mode, or no rules of that type in that list

401

Unauthorized

403

Forbidden

404

Zone not found

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/zone/200/targeting/match-mode.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'type=COOKIE_VALUE' \
  --data-urlencode 'rule=INCLUDE' \
  --data-urlencode 'matchMode=ALL'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/zone/200/targeting/match-mode.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"type": "COOKIE_VALUE", "rule": "INCLUDE", "matchMode": "ALL"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/zone/200/targeting/match-mode.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"type":"COOKIE_VALUE","rule":"INCLUDE","matchMode":"ALL"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/zone/200/targeting/match-mode.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("type=COOKIE_VALUE&rule=INCLUDE&matchMode=ALL"))
    .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/zone/200/targeting/match-mode.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["type"] = "COOKIE_VALUE", ["rule"] = "INCLUDE", ["matchMode"] = "ALL" });

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/zone/200/targeting/match-mode.do", strings.NewReader(`type=COOKIE_VALUE&rule=INCLUDE&matchMode=ALL`))
	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/zone/200/targeting/match-mode.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, 'type=COOKIE_VALUE&rule=INCLUDE&matchMode=ALL');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/zone/200/targeting/match-mode.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('type' => "COOKIE_VALUE", 'rule' => "INCLUDE", 'matchMode' => "ALL")

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