Get site ads.txt lines

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/sites/{siteId}/ads-txt.do

Returns the ads.txt lines (app-ads.txt for an app) the publisher has to publish for this site, as one list ('lines') and grouped by why each is required ('groups'): NETWORK — the network's own line, named the way the network's OpenRTB supply chain names the site; on a site with an active header-bidding tag that carries a supply chain, the pair the tag sends (the White Label seller domain and the site's schainSellerId), plus the OpenRTB pair while an active DSP partner's banner runs on the site; DIRECT, or RESELLER when the site's schainSellerType is INTERMEDIARY — and the ads.txt lines set on the White Label page, whose MANAGERDOMAIN opens the file, and OWNERDOMAIN too on a site the network sells under its own name (nobody owns it, or the network's admin does); SITE — the site's own additional lines ('additional' lists them with their ids and, for a variable no partner may set, why it is not published in 'notPublished'); ADVERTISER — the lines of each demand partner (an advertiser that resells or runs its own tag) with an active banner linked to an active placement of the site. A line is listed once. 'headerBidding' lists each partner bidder in the site's active header-bidding tags with the ads.txt system it sells under ('system', null when the bidder is not a known one), whether a listed line already names that system ('covered') and whether the last check found every such line in the live file ('live': null when no line names the system or no check read the file; a line added since the check is not live until the next one). Also returns the last check of the publisher's live file, read at the root domain of the site URL: status (ALL_PRESENT, LINES_MISSING, NO_FILE, FETCH_FAILED, NO_DOMAIN), checkedAt, fileUrl, the missing lines, the bidders' systems the file has no record of ('missingSystems') and why the fetch failed ('error', in the caller's language). Requires ENABLED or READONLY level on the SITE_SUPPLY_CHAIN permission and VIEW permission on the site; a masked share is refused.

Path Params

siteId integer required

Unique numeric ID of the site

5001

Responses

200

Lines and last check returned

400

Bad request — invalid or missing parameters

401

Authentication error

403

No SITE_SUPPLY_CHAIN permission, or the site is outside the caller's shares or masked

404

Site not found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/ads-txt.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

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