Get a creative

GET

api

manager

creatives

{crid}

Get a creative

curl --request GET \
  --url https://your_a2_service/api/manager/creatives/{crid} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://your_a2_service/api/manager/creatives/{crid}', 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/creatives/{crid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/creatives/{crid}"

	req, _ := http.NewRequest("GET", 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/creatives/{crid}")

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

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

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "height": 1,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "banner",
  "updated_at": "2023-11-07T05:31:56Z",
  "width": 1,
  "advertiser_deleted": false,
  "advertiser_domain": "<string>",
  "advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "advertiser_name": "<string>",
  "banner": {
    "ext": {
      "alt": "<string>",
      "impression_tracking_url": "<string>",
      "show_ad_badge": true
    },
    "img": "<string>",
    "link": {
      "url": "<string>",
      "ext": null,
      "trkr": [
        "<string>"
      ],
      "urlfb": "<string>"
    }
  },
  "description": "<string>",
  "end_date": "2023-11-07T05:31:56Z",
  "ext": {},
  "lica_count": 0,
  "native": {
    "asset": [
      {
        "id": 3,
        "title": {
          "text": "Sample Headline"
        }
      }
    ],
    "link": {
      "url": "https://example.com/click"
    }
  },
  "native_form": {
    "fields": {},
    "format_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ext": {
      "impression_tracking_url": "<string>",
      "metadata": "<string>",
      "show_ad_badge": true
    },
    "link": {
      "url": "<string>",
      "ext": null,
      "trkr": [
        "<string>"
      ],
      "urlfb": "<string>"
    }
  },
  "no": 123,
  "start_date": "2023-11-07T05:31:56Z",
  "status": "inactive",
  "video": {
    "adm": "<string>",
    "api": [
      32767
    ],
    "ctype": 32767,
    "curl": "<string>",
    "dur": 1,
    "ext": null,
    "mime": [
      "<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

crid

string<uuid>

required

Response

Successful Response

created_at

string<date-time>

required

height

integer

required

Height of the creative in pixels.

Required range: x >= 0

string<uuid>

required

Unique identifier for the creative (UUID v7).

name

string

required

Human-readable name of the creative.

owner_id

string<uuid>

required

User ID of the admin/operator who created the creative.

type

enum<string>

required

Type of the creative (e.g., "banner", "video", "native").

Available options:

banner,

video,

native

updated_at

string<date-time>

required

width

integer

required

Width of the creative in pixels.

Required range: x >= 0

advertiser_deleted

boolean

default:false

advertiser_domain

string | null

Advertiser domain using this creative.

advertiser_id

string<uuid> | null

Advertiser ID using this creative.

advertiser_name

string | null

banner

BannerResponse · object | null

Response DTO containing the stored AdCOM Banner data, without input validation.

Show child attributes

description

string | null

Optional description of the creative.

end_date

string<date-time> | null

ext

any

default:{}

extension for the creative

lica_count

integer

default:0

native

Native · object | null

Native creative content

Show child attributes

Example:

{
  "asset": [
    {
      "id": 3,
      "title": { "text": "Sample Headline" }
    }
  ],
  "link": { "url": "https://example.com/click" }
}

native_form

NativeForm · object | null

Response DTO containing the converted stored AdCOM Native data, without input validation.

Show child attributes

integer | null

start_date

string<date-time> | null

status

enum<string>

default:inactive

Status of the creative.

Available options:

inactive,

active

video

Video · object | null

Show child attributes

Get a creative

curl --request GET \
  --url https://your_a2_service/api/manager/creatives/{crid} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://your_a2_service/api/manager/creatives/{crid}', 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/creatives/{crid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/creatives/{crid}"

	req, _ := http.NewRequest("GET", 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/creatives/{crid}")

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

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

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "height": 1,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "banner",
  "updated_at": "2023-11-07T05:31:56Z",
  "width": 1,
  "advertiser_deleted": false,
  "advertiser_domain": "<string>",
  "advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "advertiser_name": "<string>",
  "banner": {
    "ext": {
      "alt": "<string>",
      "impression_tracking_url": "<string>",
      "show_ad_badge": true
    },
    "img": "<string>",
    "link": {
      "url": "<string>",
      "ext": null,
      "trkr": [
        "<string>"
      ],
      "urlfb": "<string>"
    }
  },
  "description": "<string>",
  "end_date": "2023-11-07T05:31:56Z",
  "ext": {},
  "lica_count": 0,
  "native": {
    "asset": [
      {
        "id": 3,
        "title": {
          "text": "Sample Headline"
        }
      }
    ],
    "link": {
      "url": "https://example.com/click"
    }
  },
  "native_form": {
    "fields": {},
    "format_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ext": {
      "impression_tracking_url": "<string>",
      "metadata": "<string>",
      "show_ad_badge": true
    },
    "link": {
      "url": "<string>",
      "ext": null,
      "trkr": [
        "<string>"
      ],
      "urlfb": "<string>"
    }
  },
  "no": 123,
  "start_date": "2023-11-07T05:31:56Z",
  "status": "inactive",
  "video": {
    "adm": "<string>",
    "api": [
      32767
    ],
    "ctype": 32767,
    "curl": "<string>",
    "dur": 1,
    "ext": null,
    "mime": [
      "<string>"
    ]
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

Decision APIs

Data Management APIs

Developer APIs

Authorizations

Path Parameters

Response