Save placement screen-size ranges in one call

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/placement/{placementId}/targeting/screen-resolution/save-ranges.do

Saves one to 20 screen-size ranges as INCLUDE or EXCLUDE rules of the specified placement and deletes the screen-resolution rules listed in replaceIds, in one transaction: when a range is unusable, a replaceIds entry is not a screen-resolution rule of this placement, or a permission is missing, nothing is saved and nothing is deleted. Each range is one rule; its limits are inclusive whole pixels from 1 to 9999 and a limit left out is open, so {"rule":"INCLUDE","ranges":[{"maxWidth":767},{"minWidth":1440}]} targets screens up to 767 or from 1440 px wide. A range equal to a stored rule keeps that rule, including a replaced one. Switches the placement's targeting on if it was off. The answer lists the saved rules in targets and the deleted rule ids in replaced, with a warning when a saved rule is now targeted both ways. Requires UPDATE permission on the placement, MANAGE_SUPPLY_PRE_TARGETING user permission and PRETARGETING_RESOLUTION.

Path Params

placementId integer required

Unique numeric ID of the placement

4001

Body

A JSON body. An example, built from the field definitions:

{
  "rule": "INCLUDE"
}

Responses

200

Success — the answer carries targets and replaced

400

rule or ranges missing, or a range unusable — nothing changed

401

Unauthorized

403

Forbidden — nothing changed

404

Placement not found, or a replaceIds entry is not one of its screen-resolution rules — nothing changed

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/screen-resolution/save-ranges.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "rule": "INCLUDE"
}'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/screen-resolution/save-ranges.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json={
    "rule": "INCLUDE"
})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/screen-resolution/save-ranges.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "rule": "INCLUDE"
  }),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/screen-resolution/save-ranges.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"rule\":\"INCLUDE\"}"))
    .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/placement/4001/targeting/screen-resolution/save-ranges.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("{\"rule\":\"INCLUDE\"}", Encoding.UTF8, "application/json");

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/placement/4001/targeting/screen-resolution/save-ranges.do", strings.NewReader(`{"rule":"INCLUDE"}`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	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/placement/4001/targeting/screen-resolution/save-ranges.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/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"rule":"INCLUDE"}');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placement/4001/targeting/screen-resolution/save-ranges.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "{\"rule\":\"INCLUDE\"}"

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