List stale location targeting

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations.do

Location and country rules, on every advertiser, campaign, banner, site, zone and placement the user may manage (paused ones included, deleted ones left out), that name a place the geo database no longer knows: it renames and merges places between updates. Each rule carries 'kind': SAFE - removing it changes nothing, the ad server already ignores it (a valid include of the same type sits beside it, or it is a country exclude); OPENS_ALL - it is among the entity's only includes of its type, which keep every visitor out today, and removing them lifts the location limit altogether; STARTS_DELIVERY - a location exclude that keeps every visitor out today, so removing it starts delivery to everyone else. 'counts' sums the rules per kind. When the geo service does not answer, or nearly every place fails at once, 'status' is GEO_UNAVAILABLE with the reason in 'unavailable' and nothing is listed, so an outage never reads as stale targeting. 'unchecked' counts places the service gave no clear answer for; their rules are not listed. Requires MANAGE_DEMAND_TARGETING or MANAGE_SUPPLY_PRE_TARGETING; each rule also needs that side's update rights on its entity and the targeting permission of its type.

Responses

200

{success, status: OK|GEO_UNAVAILABLE, unavailable, message, places, unchecked, counts:{SAFE, OPENS_ALL, STARTS_DELIVERY}, rows:[{targetId, type, value, place, rule, kind, level, entityId, entityName, active, targetingOn, path:[{level, id, name}]}]}

400

Bad request — invalid or missing parameters

401

Authentication error

403

The role lacks both MANAGE_DEMAND_TARGETING and MANAGE_SUPPLY_PRE_TARGETING

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations.do', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .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("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations.do", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	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/targeting/stale-locations.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations.do")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

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