Get banner prototype by campaign type

Retrieves the self-serve campaign banner prototype associated with the specified campaign type.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/prototype/banner/{prototypeType}.do

Retrieves the self-serve campaign banner prototype associated with the specified campaign type. The prototypeType path variable is a SelfServeCampaignType enum value (e.g. BANNER_DESKTOP, BANNER_MOBILE, VIDEO_DESKTOP). The response includes the full prototype details including banner metadata and the default action configuration. Returns HTTP 400 if no prototype is configured for the given campaign type. Requires REST API authentication.

Path Params

prototypeType string required

Self-serve campaign type enum value (e.g. BANNER_DESKTOP, BANNER_MOBILE, VIDEO_DESKTOP, VIDEO_MOBILE)

BANNER_DESKTOP

Responses

200

JSON object containing the banner prototype with id, type, banner details, and defaultAction

400

Bad request - no prototype configured for the specified campaign type

401

Authentication error - invalid hash, timestamp, or username

403

Forbidden — insufficient permissions

404

Not found — resource does not exist

500

Internal server error while retrieving the prototype

Language

cURL Request

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

Python Request

import requests

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

Node Request

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