Create Ad Unit

POST

api

manager

ad-units

Create Ad Unit

curl --request POST \
  --url https://your_a2_service/api/manager/ad-units \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "main-banner",
  "description": "홈 화면 상단 배너",
  "name": "메인 배너 광고"
}
'

import requests

url = "https://your_a2_service/api/manager/ad-units"

payload = {
    "code": "main-banner",
    "description": "홈 화면 상단 배너",
    "name": "메인 배너 광고"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: 'main-banner', description: '홈 화면 상단 배너', name: '메인 배너 광고'})
};

fetch('https://your_a2_service/api/manager/ad-units', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'main-banner',
    'description' => '홈 화면 상단 배너',
    'name' => '메인 배너 광고'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://your_a2_service/api/manager/ad-units"

	payload := strings.NewReader("{\n  \"code\": \"main-banner\",\n  \"description\": \"홈 화면 상단 배너\",\n  \"name\": \"메인 배너 광고\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your_a2_service/api/manager/ad-units")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"main-banner\",\n  \"description\": \"홈 화면 상단 배너\",\n  \"name\": \"메인 배너 광고\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your_a2_service/api/manager/ad-units")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"main-banner\",\n  \"description\": \"홈 화면 상단 배너\",\n  \"name\": \"메인 배너 광고\"\n}"

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": "<unknown>",
    "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
  },
  "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": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": {
    "code": "LICENSE.FILE_NOT_FOUND",
    "message": "License file not found. Contact your system administrator."
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Request body for POST /ad-units.

Path resolution rules:

No parent_id: path = code
With parent_id: path = {parent.path}/{code}

code

string

required

Ad unit code identifier. Used in ad tags. Immutable after creation. (1-100 chars)

Required string length: 1 - 100

name

string

required

Ad unit display name. (1-255 chars)

Required string length: 1 - 255

ad_unit_sizes

AdUnitSize · object[] | null

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

Show child attributes

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

default:true

Whether the ad unit is active.

native

NativePlacement · object

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

Show child attributes

parent_id

string<uuid> | null

Parent ad unit ID. Determines hierarchy. Immutable after creation.

recommendation

RecommendationPlacement · object

Show child attributes

video

VideoPlacement · object

Video placement configuration.

Show child attributes

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.

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

updated_at

string<date-time> | null

video

VideoPlacement · object

Video placement configuration.

Show child attributes

Create Ad Unit

curl --request POST \
  --url https://your_a2_service/api/manager/ad-units \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "main-banner",
  "description": "홈 화면 상단 배너",
  "name": "메인 배너 광고"
}
'

import requests

url = "https://your_a2_service/api/manager/ad-units"

payload = {
    "code": "main-banner",
    "description": "홈 화면 상단 배너",
    "name": "메인 배너 광고"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: 'main-banner', description: '홈 화면 상단 배너', name: '메인 배너 광고'})
};

fetch('https://your_a2_service/api/manager/ad-units', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'main-banner',
    'description' => '홈 화면 상단 배너',
    'name' => '메인 배너 광고'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://your_a2_service/api/manager/ad-units"

	payload := strings.NewReader("{\n  \"code\": \"main-banner\",\n  \"description\": \"홈 화면 상단 배너\",\n  \"name\": \"메인 배너 광고\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your_a2_service/api/manager/ad-units")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"main-banner\",\n  \"description\": \"홈 화면 상단 배너\",\n  \"name\": \"메인 배너 광고\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your_a2_service/api/manager/ad-units")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"main-banner\",\n  \"description\": \"홈 화면 상단 배너\",\n  \"name\": \"메인 배너 광고\"\n}"

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": "<unknown>",
    "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
  },
  "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": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": {
    "code": "LICENSE.FILE_NOT_FOUND",
    "message": "License file not found. Contact your system administrator."
  }
}

Data Management APIs

Decision APIs

Authorizations

Body

Response