AdUnit

Archive Ad Unit

Moves the ad unit to ARCHIVED so it drops out of the inventory list. Ad units that have been served cannot be deleted, so this is how they are retired. Archived ad units no longer count toward the license limit.

Access Control: Admin and Operator accounts have full access (create/read/update/delete) to ad unit resources. Advertiser accounts have no access to this endpoint — see GET /ad-units/targets for the lightweight, allocation-target-selection view available to advertisers.

POST

api

manager

ad-units

{ad_unit_id}

archive

Archive Ad Unit

curl --request POST \
  --url https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "code": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "path": "<string>",
  "ad_unit_sizes": [
    {
      "h": 1,
      "w": 1
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "display": {
    "ampren": 127,
    "api": [
      32767
    ],
    "clktype": 1,
    "context": "ContentCentric",
    "ctype": [
      127
    ],
    "displayfmt": {
      "expdir": "Left",
      "ext": null,
      "h": 1,
      "hratio": 1,
      "w": 1,
      "wratio": 1
    },
    "event": [
      {
        "type": 1,
        "api": [
          32767
        ],
        "ext": null,
        "jstrk": [
          "<string>"
        ],
        "method": [
          1
        ],
        "pxtrk": [
          "<string>"
        ],
        "wjs": 1,
        "wpx": 1
      }
    ],
    "ext": null,
    "h": 250,
    "ifrbust": [
      "<string>"
    ],
    "mime": [
      "<string>"
    ],
    "pos": "Unknown",
    "priv": 0,
    "ptype": "Feed",
    "topframe": 127,
    "unit": 2,
    "w": 300
  },
  "ext": {
    "algorithm": "axa0",
    "approval_method": "admin",
    "bcat": [],
    "default_cpa": 0,
    "default_cpc": 0,
    "display": {
      "enabled": 0
    },
    "external_raw_data": "<unknown>",
    "implicit_app_inference": {
      "android_bundle": "<string>",
      "app_name": "<string>",
      "cat": [
        "<string>"
      ],
      "ios_bundle": "<string>",
      "ua_keywords": []
    },
    "metric_mode": "all",
    "native": {
      "enabled": 0,
      "render_mode": "html"
    },
    "passback": "<unknown>",
    "payout": "rates",
    "public_url": "<string>",
    "publisher": {
      "company": "<string>",
      "domain": "<string>",
      "ext": null,
      "id": "<string>",
      "name": "<string>",
      "page": "<string>",
      "seller_id": "<string>"
    },
    "recommendation": {
      "enabled": 0
    },
    "responsive": "fixed",
    "target_ecpm": 0,
    "target_service": "<string>",
    "video": {
      "enabled": 0
    }
  },
  "gpid": "<string>",
  "instl": 0,
  "is_active": true,
  "native": {
    "assets": []
  },
  "no": 123,
  "recommendation": {
    "ext": {},
    "topn": 10
  },
  "status": "INACTIVE",
  "updated_at": "2023-11-07T05:31:56Z",
  "video": {
    "api": [
      32767
    ],
    "boxing": 1,
    "clktype": 1,
    "comp": [
      {
        "display": {
          "ampren": 127,
          "api": [
            32767
          ],
          "clktype": 1,
          "context": "ContentCentric",
          "ctype": [
            127
          ],
          "displayfmt": {
            "expdir": "Left",
            "ext": null,
            "h": 1,
            "hratio": 1,
            "w": 1,
            "wratio": 1
          },
          "event": [
            {
              "type": 1,
              "api": [
                32767
              ],
              "ext": null,
              "jstrk": [
                "<string>"
              ],
              "method": [
                1
              ],
              "pxtrk": [
                "<string>"
              ],
              "wjs": 1,
              "wpx": 1
            }
          ],
          "ext": null,
          "h": 123,
          "ifrbust": [
            "<string>"
          ],
          "mime": [
            "<string>"
          ],
          "pos": "Unknown",
          "priv": 0,
          "ptype": "Feed",
          "topframe": 127,
          "unit": 2,
          "w": 123
        },
        "ext": null,
        "id": "<string>",
        "vcm": 123
      }
    ],
    "comptype": [
      "Static"
    ],
    "ctype": [
      123
    ],
    "delay": 0,
    "delivery": [
      "Streaming"
    ],
    "expdir": [
      "Left"
    ],
    "ext": null,
    "h": 300,
    "linear": 0,
    "maxbitr": 1,
    "maxdur": 0,
    "maxext": 0,
    "maxseq": 1,
    "mime": [
      "<string>"
    ],
    "minbitr": 1,
    "mincpmpersec": 123,
    "mindur": 0,
    "overlayexpdir": [
      "Left"
    ],
    "playend": "OnVideoCompletion",
    "playmethod": [
      1
    ],
    "poddur": 1,
    "podid": 1,
    "podseq": 0,
    "pos": "Unknown",
    "ptype": 1,
    "rqddurs": [
      1
    ],
    "skip": 0,
    "skipafter": 0,
    "skipmin": 0,
    "slotinpod": 0,
    "unit": 2,
    "w": 480
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication. Pass the access token in the Authorization: Bearer <token> header.

Path Parameters

ad_unit_id

string<uuid>

required

Query Parameters

force

boolean

default:false

Response

Successful Response

Response schema for AdUnit mutation operations (create/patch).

code

string

required

Ad unit code identifier.

created_by

string<uuid>

required

The ID of the user who created the ad unit.

string<uuid>

required

ID of the ad unit (uuid7)

name

string

required

Name of the ad unit.

path

string

required

Hierarchical path of the ad unit (e.g., "parent_id/child_id").

ad_unit_sizes

AdUnitSize · object[] | null

Targeting metadata sizes Distinct from display/video.w/h which govern serving and rendering.

Show child attributes

created_at

string<date-time> | null

description

string | null

Description of the ad unit.

display

DisplayPlacement · object

Display placement configuration.

Show child attributes

ext

AdUnitExt · object

Ad unit extension fields.

Show child attributes

gpid

string | null

Canonical Placement ID for OpenRTB imp.ext.gpid.

instl

enum<integer>

default:0

Indicates if this is an interstitial placement, where 0 = no, 1 = yes. Applies across display, video, and native.

Available options:

0,

1

is_active

boolean | null

Whether the ad unit is active.

Superseded by status. Kept until every consumer reads status.

native

NativePlacement · object

Based on OpenRTB Native Ads 1.2 Native Markup Request Object, not the AdCOM standard native format

Show child attributes

integer | null

recommendation

RecommendationPlacement · object

Show child attributes

status

enum<string>

default:INACTIVE

Operational status of the ad unit. Defaults to Inactive.

Available options:

ACTIVE,

INACTIVE,

ARCHIVED

updated_at

string<date-time> | null

video

VideoPlacement · object

Video placement configuration.

Show child attributes

Archive Ad Unit

curl --request POST \
  --url https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://your_a2_service/api/manager/ad-units/{ad_unit_id}/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "code": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "path": "<string>",
  "ad_unit_sizes": [
    {
      "h": 1,
      "w": 1
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "display": {
    "ampren": 127,
    "api": [
      32767
    ],
    "clktype": 1,
    "context": "ContentCentric",
    "ctype": [
      127
    ],
    "displayfmt": {
      "expdir": "Left",
      "ext": null,
      "h": 1,
      "hratio": 1,
      "w": 1,
      "wratio": 1
    },
    "event": [
      {
        "type": 1,
        "api": [
          32767
        ],
        "ext": null,
        "jstrk": [
          "<string>"
        ],
        "method": [
          1
        ],
        "pxtrk": [
          "<string>"
        ],
        "wjs": 1,
        "wpx": 1
      }
    ],
    "ext": null,
    "h": 250,
    "ifrbust": [
      "<string>"
    ],
    "mime": [
      "<string>"
    ],
    "pos": "Unknown",
    "priv": 0,
    "ptype": "Feed",
    "topframe": 127,
    "unit": 2,
    "w": 300
  },
  "ext": {
    "algorithm": "axa0",
    "approval_method": "admin",
    "bcat": [],
    "default_cpa": 0,
    "default_cpc": 0,
    "display": {
      "enabled": 0
    },
    "external_raw_data": "<unknown>",
    "implicit_app_inference": {
      "android_bundle": "<string>",
      "app_name": "<string>",
      "cat": [
        "<string>"
      ],
      "ios_bundle": "<string>",
      "ua_keywords": []
    },
    "metric_mode": "all",
    "native": {
      "enabled": 0,
      "render_mode": "html"
    },
    "passback": "<unknown>",
    "payout": "rates",
    "public_url": "<string>",
    "publisher": {
      "company": "<string>",
      "domain": "<string>",
      "ext": null,
      "id": "<string>",
      "name": "<string>",
      "page": "<string>",
      "seller_id": "<string>"
    },
    "recommendation": {
      "enabled": 0
    },
    "responsive": "fixed",
    "target_ecpm": 0,
    "target_service": "<string>",
    "video": {
      "enabled": 0
    }
  },
  "gpid": "<string>",
  "instl": 0,
  "is_active": true,
  "native": {
    "assets": []
  },
  "no": 123,
  "recommendation": {
    "ext": {},
    "topn": 10
  },
  "status": "INACTIVE",
  "updated_at": "2023-11-07T05:31:56Z",
  "video": {
    "api": [
      32767
    ],
    "boxing": 1,
    "clktype": 1,
    "comp": [
      {
        "display": {
          "ampren": 127,
          "api": [
            32767
          ],
          "clktype": 1,
          "context": "ContentCentric",
          "ctype": [
            127
          ],
          "displayfmt": {
            "expdir": "Left",
            "ext": null,
            "h": 1,
            "hratio": 1,
            "w": 1,
            "wratio": 1
          },
          "event": [
            {
              "type": 1,
              "api": [
                32767
              ],
              "ext": null,
              "jstrk": [
                "<string>"
              ],
              "method": [
                1
              ],
              "pxtrk": [
                "<string>"
              ],
              "wjs": 1,
              "wpx": 1
            }
          ],
          "ext": null,
          "h": 123,
          "ifrbust": [
            "<string>"
          ],
          "mime": [
            "<string>"
          ],
          "pos": "Unknown",
          "priv": 0,
          "ptype": "Feed",
          "topframe": 127,
          "unit": 2,
          "w": 123
        },
        "ext": null,
        "id": "<string>",
        "vcm": 123
      }
    ],
    "comptype": [
      "Static"
    ],
    "ctype": [
      123
    ],
    "delay": 0,
    "delivery": [
      "Streaming"
    ],
    "expdir": [
      "Left"
    ],
    "ext": null,
    "h": 300,
    "linear": 0,
    "maxbitr": 1,
    "maxdur": 0,
    "maxext": 0,
    "maxseq": 1,
    "mime": [
      "<string>"
    ],
    "minbitr": 1,
    "mincpmpersec": 123,
    "mindur": 0,
    "overlayexpdir": [
      "Left"
    ],
    "playend": "OnVideoCompletion",
    "playmethod": [
      1
    ],
    "poddur": 1,
    "podid": 1,
    "podseq": 0,
    "pos": "Unknown",
    "ptype": 1,
    "rqddurs": [
      1
    ],
    "skip": 0,
    "skipafter": 0,
    "skipmin": 0,
    "slotinpod": 0,
    "unit": 2,
    "w": 480
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Data Management APIs

Decision APIs

Archive Ad Unit

Authorizations

Path Parameters

Query Parameters

Response