Get placement

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}.do

Returns one placement: everything placements/summary returns for it (id, name, description, type, key, active, size and dimensions, zoneId, zoneName, siteId, siteName, category, labels, defaultCode, targeting switch, native preferences and adapter template, video player settings) plus every scalar setting the update endpoints accept, under the same names. A video placement also reads back its videoFormats, skipButtonEnabled, skipButtonShowAfterSeconds, vmapMaxNumberOfPreRolls, vastDefaultAdTitle, ssaiStitcher and podSeparation, plus, with the Video RTB Configuration permission (enabled or read-only), videoPlaybackMethod and videoApiFramework; an unset one, such as ssaiStitcher with no stitcher or podSeparation when it is off, is left out. A placement on inventory the caller sees masked comes back masked, as in the summary. Its Open RTB card (IAB categories, blocked IAB categories, blocked banner attributes) is read by placements/{placementId}/openrtb. Requires VIEW access to the placement's site (ALL, or SHARED with a share on the site). The response also carries additionalFieldValues: every custom field the network defines for this entity type, keyed by field id, each with its name and this entity's value (null when unset) - the values of /rest-api/additional-fields/{entityType}/{entityId}.

Path Params

placementId integer required

Placement ID

4001

Responses

200

The placement

400

Bad request — invalid or missing parameters

401

Authentication error

403

No VIEW access to the placement's site

404

Placement not found, deleted, or of a type the placement API does not manage

Language

cURL Request

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

Python Request

import requests

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

Node Request

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