Suggest current places for stale location targeting

For every stale place the list would show, what it is called now, from names and the answers the server already holds: this never calls the AI model (POST to the same path for that).

Reference

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

For every stale place the list would show, what it is called now, from names and the answers the server already holds: this never calls the AI model (POST to the same path for that). Rules naming the same stale place with the same include or exclude form one group, with its 'targetIds', how many rules of each kind and how many entities of each level carry them. 'suggestion.action' is REPLACE (apply with POST replace.do: targetIds, countryCode, regionName, cityName as the suggestion gives them), REMOVE (no current place matches, and removing the rules changes nothing: POST remove.do) or KEEP (nothing is proposed: removing the rules would change delivery, or the geo service did not answer for the place; the user decides). A city whose region is gone is looked for under up to 80 of the country's regions; where the country has more, not finding it there is a NO_SUCCESSOR of LOW confidence. 'reason' is SPELLING, SUFFIX (an administrative word such as "County" or "Stationsby" dropped), REGION_RENAMED, RENAMED, MERGED, NO_SUCCESSOR, NOT_MATCHED, COUNTRY_RULE or GEO_UNANSWERED, with 'reasonParams' (old name, new name) and 'reasonText' in the user's language; 'confidence' is HIGH, MEDIUM or LOW; 'source' says whether names (DETERMINISTIC) or the AI assistant's model (AI) matched it. 'ai' is NOT_NEEDED when every place was answered, otherwise SKIPPED, and the places left open read NOT_MATCHED. Nothing is changed. Requires MANAGE_DEMAND_TARGETING or MANAGE_SUPPLY_PRE_TARGETING.

Responses

200

{success, status: OK|GEO_UNAVAILABLE, unavailable, message, ai, aiMessage, groups:[{type, value, place, rule, targetIds, kinds:{SAFE, OPENS_ALL, STARTS_DELIVERY}, entities:{ADVERTISER, CAMPAIGN, BANNER, SITE, ZONE, PLACEMENT}, suggestion:{action, countryCode, regionName, cityName, newPlace, reason, reasonParams, reasonText, confidence, source}}]}

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/suggestions.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/suggestions.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/suggestions.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/suggestions.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/suggestions.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/suggestions.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/suggestions.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/suggestions.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