List custom parameters

The parameters registered for the network's ad tags.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameters.do

The parameters registered for the network's ad tags. Targeting editors offer them as the parameter of a Custom Parameter rule. usage=true adds rules: how many Custom Parameter targeting rules on live entities read each one, and unregistered: the names such rules read that are not registered, with their rule counts. Both, and the description, come back only to callers with the CUSTOM_PARAMETERS admin permission: the rules are read from other clients' targeting, and the description is the admins' own note. policy says what reaches analytics: LEGACY (the Analytics configuration list still decides; legacy describes it to CUSTOM_PARAMETERS admins), ANY (every parameter except those with recordInAnalytics false) or ONLY_VERIFIED (only registered parameters with recordInAnalytics true). Fields: id, name (without the cp. prefix), label, description, valueMode (DYNAMIC: any value; STATIC: one of values), allowOtherValues, values ([{value, label}] in list order), listSeparator (COMMA, PIPE, SEMICOLON, WHITESPACE, their ids 1 to 4, or null: the character a request value carrying several values is split on before a One of rule matches it item by item), recordInAnalytics, builtIn (seeded with the platform: kept by name, never deleted), canBeRemoved, createdAt, updatedAt.

Query Params

usage boolean

true: count the targeting rules that read each parameter (CUSTOM_PARAMETERS admins only)

true

query string

Only the parameters whose name or label contains this, ignoring case

genre

Responses

200

{parameters: [parameter], total, mayManage (whether the caller may change them and see the rules that read them), policy (LEGACY, ANY or ONLY_VERIFIED), legacy: {names, mode, applies (the list's filter is on for this server; other servers may differ), movesByItself (the list is empty, so the policy leaves LEGACY within a minute)} while LEGACY (CUSTOM_PARAMETERS admins only), unregistered: [{name, rules}] with usage=true}

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameters.do?usage=true&query=genre' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameters.do?usage=true&query=genre", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameters.do?usage=true&query=genre', {
  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/custom-parameters.do?usage=true&query=genre"))
    .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/custom-parameters.do?usage=true&query=genre");
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/custom-parameters.do?usage=true&query=genre", 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/custom-parameters.do?usage=true&query=genre");
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/custom-parameters.do?usage=true&query=genre")
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