Get a template banner's property values

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/template-properties.do

Returns the template of a TEMPLATE banner (templateId, templateName, active) and each of its properties in the template's order: key (the $$KEY$$ the template uses), title, type (STRING, INTEGER, BOOLEAN, SELECT, PLACEMENT_KEY, FILE, HTML5_ZIP), required, readonly and the banner's current value, with the type's own details - min/max/step for INTEGER, isUrl/multiline for STRING, options [{value, name}] for SELECT (send the option's value), checked for BOOLEAN, and for FILE / HTML5_ZIP the stored file's fileName and fileUrl only. editable says whether the caller may change them: it needs UPDATE on the banner's advertiser and, while the template is inactive, the UPDATE_PROPERTIES_OF_INACTIVE_TEMPLATE permission. Requires VIEW permission on the banner's advertiser.

Path Params

bannerId integer required

ID of the TEMPLATE banner

3001

Responses

200

The template and its properties with the banner's values

400

The banner is not a TEMPLATE banner

401

Authentication error

403

Not enough permissions

404

Banner not found or deleted

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/template-properties.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/template-properties.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/banner/3001/template-properties.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/banner/3001/template-properties.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/banner/3001/template-properties.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/banner/3001/template-properties.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/banner/3001/template-properties.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