Update banner no-click capping

Updates an existing no-click capping rule for a banner, modifying its amount, period, period type, distribution, or subject.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/no-click-capping/update.do

Updates an existing no-click capping rule for a banner, modifying its amount, period, period type, distribution, or subject. Fields not sent keep their value. It never creates a rule: when the banner has no rule of this type for the subject the answer is 404 naming it - create one with the matching set.do. If the capping was previously disabled, this call re-enables it. Rules are keyed by subject: without subject the banner's only rule of this type is updated (keeping its subject), otherwise the USER_COOKIE rule. Requires UPDATE permission and the MANAGE_CAPPING_AND_LIMITATIONS privilege; using IP or LES_IP subjects requires additional permissions.

Path Params

bannerId integer required

Numeric ID of the banner to update no-click capping for

42

Form Params

amount integer

Maximum number of impressions without a click before the banner is suppressed. Optional; if omitted the existing amount is preserved.

5

period integer

Length of the capping time window, expressed in units defined by periodType. Omitted keeps the current period

24

periodType string

Unit of the capping period. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Omitted keeps the current unit

HOUR

evenDistribution boolean

When true, impression counting is distributed evenly across the period

false

subject string

Entity used to identify unique users for capping; selects the rule to update. If omitted and the banner has exactly one rule of this type, that rule is updated and keeps its subject; otherwise USER_COOKIE. Allowed values: USER_COOKIE, USER_SERVER_SIDE, USER_MIXED, IP, LES_IP

USER_COOKIE

Responses

200

No-click capping updated successfully

400

Invalid request parameters

401

Authentication error

403

Not enough permissions

404

Banner not found, or it has no no-click capping rule for the subject

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/no-click-capping/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'amount=5' \
  --data-urlencode 'period=24' \
  --data-urlencode 'periodType=HOUR'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/no-click-capping/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"amount": "5", "period": "24", "periodType": "HOUR"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/no-click-capping/update.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"amount":"5","period":"24","periodType":"HOUR"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/no-click-capping/update.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("amount=5&period=24&periodType=HOUR"))
    .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/banner/42/no-click-capping/update.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["amount"] = "5", ["period"] = "24", ["periodType"] = "HOUR" });

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/banner/42/no-click-capping/update.do", strings.NewReader(`amount=5&period=24&periodType=HOUR`))
	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/banner/42/no-click-capping/update.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, 'amount=5&period=24&periodType=HOUR');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/no-click-capping/update.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('amount' => "5", 'period' => "24", 'periodType' => "HOUR")

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