Ad Serving
Serving an ad
Serves an ad based on the ad unit tag (tagid) and request payload (AdRequest).
Selects the most appropriate ad using line item, creative, and bidding strategy data.
Returns the final ad determined through DSP response and internal mediation logic.
POST
/
app
/
v0
/
ad
/
{tagid}
Serving an ad
curl --request POST \
--url https://your_a2_service/app/v0/ad/{tagid} \
--header 'Content-Type: application/json' \
--data '
{
"ad_size": [
[
123
]
],
"app": {
"bundle": "<string>",
"domain": "<string>",
"name": "<string>",
"storeurl": "<string>",
"ver": "<string>"
},
"device": null,
"site": {
"domain": "<string>",
"mobile": true,
"name": "<string>",
"page": "<string>",
"ref": "<string>",
"search": "<string>"
},
"targeting": "<unknown>",
"user": {
"gender": "M",
"id": "account-187acvbvz",
"yob": 1988
}
}
'import requests
url = "https://your_a2_service/app/v0/ad/{tagid}"
payload = {
"ad_size": [[123]],
"app": {
"bundle": "<string>",
"domain": "<string>",
"name": "<string>",
"storeurl": "<string>",
"ver": "<string>"
},
"device": None,
"site": {
"domain": "<string>",
"mobile": True,
"name": "<string>",
"page": "<string>",
"ref": "<string>",
"search": "<string>"
},
"targeting": "<unknown>",
"user": {
"gender": "M",
"id": "account-187acvbvz",
"yob": 1988
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ad_size: [[123]],
app: {
bundle: '<string>',
domain: '<string>',
name: '<string>',
storeurl: '<string>',
ver: '<string>'
},
device: null,
site: {
domain: '<string>',
mobile: true,
name: '<string>',
page: '<string>',
ref: '<string>',
search: '<string>'
},
targeting: '<unknown>',
user: {gender: 'M', id: 'account-187acvbvz', yob: 1988}
})
};
fetch('https://your_a2_service/app/v0/ad/{tagid}', 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/app/v0/ad/{tagid}",
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([
'ad_size' => [
[
123
]
],
'app' => [
'bundle' => '<string>',
'domain' => '<string>',
'name' => '<string>',
'storeurl' => '<string>',
'ver' => '<string>'
],
'device' => null,
'site' => [
'domain' => '<string>',
'mobile' => true,
'name' => '<string>',
'page' => '<string>',
'ref' => '<string>',
'search' => '<string>'
],
'targeting' => '<unknown>',
'user' => [
'gender' => 'M',
'id' => 'account-187acvbvz',
'yob' => 1988
]
]),
CURLOPT_HTTPHEADER => [
"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/app/v0/ad/{tagid}"
payload := strings.NewReader("{\n \"ad_size\": [\n [\n 123\n ]\n ],\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\n \"targeting\": \"<unknown>\",\n \"user\": {\n \"gender\": \"M\",\n \"id\": \"account-187acvbvz\",\n \"yob\": 1988\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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/app/v0/ad/{tagid}")
.header("Content-Type", "application/json")
.body("{\n \"ad_size\": [\n [\n 123\n ]\n ],\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\n \"targeting\": \"<unknown>\",\n \"user\": {\n \"gender\": \"M\",\n \"id\": \"account-187acvbvz\",\n \"yob\": 1988\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/app/v0/ad/{tagid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"ad_size\": [\n [\n 123\n ]\n ],\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\n \"targeting\": \"<unknown>\",\n \"user\": {\n \"gender\": \"M\",\n \"id\": \"account-187acvbvz\",\n \"yob\": 1988\n }\n}"
response = http.request(request)
puts response.read_body{
"ad": {
"display": {
"banner": {
"img": "https://example.com/image.jpg"
},
"h": 1024,
"w": 768
},
"id": "b56dc3bf-935d-4ee6-b1ed-f31bfc02be91"
},
"ext": {
"ad_log": "YTU2ZDY2ZjctNDM4ZS00OTVjLWJiYTAtMjI4Mzk2MjQ0ZWVkfDA2NDI4NjYwLWY2NDMtNGVmNS05MzgzLTZjZmE1OGYxOGI2OXxjNTZkYzNiZi05MzVkLTRlZTYtYjFlZC1mMzFiZmMwMmJlOTF8NGJlMmQ4ZTYtYThhMS00NzI2LWEzMjAtNjkyNTYzMDkwZTQyfDllZjY2ZGM4LTBlMmMtNDlmMS05NDU3LWFmYmUwZGQ2ZjU3M3w1NTgxNmIzOTcxMWY5YjVhY2YzYjkwZTMxM2VkMjllNTE2NjU2MjNm",
"message": "success"
},
"version": "0.1.0"
}"<string>""<string>""<string>"{
"version": "<string>",
"ad": {
"id": "<string>",
"cat": [
"<string>"
],
"cattax": 32767,
"display": {
"adm": "<string>",
"api": [
32767
],
"banner": {
"img": "<string>",
"ext": "<unknown>",
"link": {
"url": "<string>",
"ext": "<unknown>",
"trkr": [
"<string>"
],
"urlfb": "<string>"
}
},
"ctype": [
127
],
"curl": "<string>",
"event": [
{
"method": 1,
"type": 1,
"url": "<string>",
"api": [
32767
],
"cdata": "<unknown>",
"ext": "<unknown>"
}
],
"ext": "<unknown>",
"h": 1,
"hratio": 1,
"mime": "<string>",
"native": {
"asset": [
{
"data": {
"value": "<string>",
"ext": "<unknown>",
"len": 123,
"type": 1
},
"ext": "<unknown>",
"id": 123,
"image": {
"url": "<string>",
"ext": "<unknown>",
"h": 1,
"type": 1,
"w": 1
},
"link": {
"url": "<string>",
"ext": "<unknown>",
"trkr": [
"<string>"
],
"urlfb": "<string>"
},
"req": 0,
"title": {
"text": "<string>",
"ext": "<unknown>",
"len": 1
},
"video": {
"adm": "<string>",
"curl": "<string>",
"ext": "<unknown>"
}
}
],
"ext": "<unknown>",
"link": {
"url": "<string>",
"ext": "<unknown>",
"trkr": [
"<string>"
],
"urlfb": "<string>"
}
},
"priv": "<string>",
"w": 1,
"wratio": 1
},
"ext": "<unknown>",
"iurl": "<string>",
"lang": "<string>",
"video": {
"adm": "<string>",
"api": [
32767
],
"ctype": 32767,
"curl": "<string>",
"dur": 1,
"ext": "<unknown>",
"mime": [
"<string>"
]
}
},
"errorcode": "<string>",
"ext": "<unknown>",
"user": {
"buyeruid": "<string>",
"ext": "<unknown>",
"gender": "M",
"geo": {
"accuracy": 123,
"city": "<string>",
"country": "<string>",
"ext": "<unknown>",
"ipservice": 1,
"lastfix": 1,
"lat": 123,
"lon": 123,
"metro": "<string>",
"region": "<string>",
"regionfips104": "<string>",
"type": 1,
"utcoffset": 123,
"zip": "<string>"
},
"id": "<string>",
"keywords": "<string>",
"yob": 32767
}
}Path Parameters
The ID of the ad unit.
Get from the advertising manager.
Body
application/json
AdRequest is used for requesting an ad.
AdRequest is used for requesting an ad.
Ad sizes requested for the ad.
Required array length:
2 elementsApp object for the current serving request.
Show child attributes
Show child attributes
Device object for the current serving request.
Show child attributes
Show child attributes
Example:
null
Site object for the current serving request.
Show child attributes
Show child attributes
Targeting key-value pairs for the ad request.
User object for the current serving request.
Show child attributes
Show child attributes
Example:
{
"gender": "M",
"id": "account-187acvbvz",
"yob": 1988
}
Was this page helpful?
⌘I
Serving an ad
curl --request POST \
--url https://your_a2_service/app/v0/ad/{tagid} \
--header 'Content-Type: application/json' \
--data '
{
"ad_size": [
[
123
]
],
"app": {
"bundle": "<string>",
"domain": "<string>",
"name": "<string>",
"storeurl": "<string>",
"ver": "<string>"
},
"device": null,
"site": {
"domain": "<string>",
"mobile": true,
"name": "<string>",
"page": "<string>",
"ref": "<string>",
"search": "<string>"
},
"targeting": "<unknown>",
"user": {
"gender": "M",
"id": "account-187acvbvz",
"yob": 1988
}
}
'import requests
url = "https://your_a2_service/app/v0/ad/{tagid}"
payload = {
"ad_size": [[123]],
"app": {
"bundle": "<string>",
"domain": "<string>",
"name": "<string>",
"storeurl": "<string>",
"ver": "<string>"
},
"device": None,
"site": {
"domain": "<string>",
"mobile": True,
"name": "<string>",
"page": "<string>",
"ref": "<string>",
"search": "<string>"
},
"targeting": "<unknown>",
"user": {
"gender": "M",
"id": "account-187acvbvz",
"yob": 1988
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ad_size: [[123]],
app: {
bundle: '<string>',
domain: '<string>',
name: '<string>',
storeurl: '<string>',
ver: '<string>'
},
device: null,
site: {
domain: '<string>',
mobile: true,
name: '<string>',
page: '<string>',
ref: '<string>',
search: '<string>'
},
targeting: '<unknown>',
user: {gender: 'M', id: 'account-187acvbvz', yob: 1988}
})
};
fetch('https://your_a2_service/app/v0/ad/{tagid}', 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/app/v0/ad/{tagid}",
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([
'ad_size' => [
[
123
]
],
'app' => [
'bundle' => '<string>',
'domain' => '<string>',
'name' => '<string>',
'storeurl' => '<string>',
'ver' => '<string>'
],
'device' => null,
'site' => [
'domain' => '<string>',
'mobile' => true,
'name' => '<string>',
'page' => '<string>',
'ref' => '<string>',
'search' => '<string>'
],
'targeting' => '<unknown>',
'user' => [
'gender' => 'M',
'id' => 'account-187acvbvz',
'yob' => 1988
]
]),
CURLOPT_HTTPHEADER => [
"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/app/v0/ad/{tagid}"
payload := strings.NewReader("{\n \"ad_size\": [\n [\n 123\n ]\n ],\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\n \"targeting\": \"<unknown>\",\n \"user\": {\n \"gender\": \"M\",\n \"id\": \"account-187acvbvz\",\n \"yob\": 1988\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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/app/v0/ad/{tagid}")
.header("Content-Type", "application/json")
.body("{\n \"ad_size\": [\n [\n 123\n ]\n ],\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\n \"targeting\": \"<unknown>\",\n \"user\": {\n \"gender\": \"M\",\n \"id\": \"account-187acvbvz\",\n \"yob\": 1988\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/app/v0/ad/{tagid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"ad_size\": [\n [\n 123\n ]\n ],\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\n \"targeting\": \"<unknown>\",\n \"user\": {\n \"gender\": \"M\",\n \"id\": \"account-187acvbvz\",\n \"yob\": 1988\n }\n}"
response = http.request(request)
puts response.read_body{
"ad": {
"display": {
"banner": {
"img": "https://example.com/image.jpg"
},
"h": 1024,
"w": 768
},
"id": "b56dc3bf-935d-4ee6-b1ed-f31bfc02be91"
},
"ext": {
"ad_log": "YTU2ZDY2ZjctNDM4ZS00OTVjLWJiYTAtMjI4Mzk2MjQ0ZWVkfDA2NDI4NjYwLWY2NDMtNGVmNS05MzgzLTZjZmE1OGYxOGI2OXxjNTZkYzNiZi05MzVkLTRlZTYtYjFlZC1mMzFiZmMwMmJlOTF8NGJlMmQ4ZTYtYThhMS00NzI2LWEzMjAtNjkyNTYzMDkwZTQyfDllZjY2ZGM4LTBlMmMtNDlmMS05NDU3LWFmYmUwZGQ2ZjU3M3w1NTgxNmIzOTcxMWY5YjVhY2YzYjkwZTMxM2VkMjllNTE2NjU2MjNm",
"message": "success"
},
"version": "0.1.0"
}"<string>""<string>""<string>"{
"version": "<string>",
"ad": {
"id": "<string>",
"cat": [
"<string>"
],
"cattax": 32767,
"display": {
"adm": "<string>",
"api": [
32767
],
"banner": {
"img": "<string>",
"ext": "<unknown>",
"link": {
"url": "<string>",
"ext": "<unknown>",
"trkr": [
"<string>"
],
"urlfb": "<string>"
}
},
"ctype": [
127
],
"curl": "<string>",
"event": [
{
"method": 1,
"type": 1,
"url": "<string>",
"api": [
32767
],
"cdata": "<unknown>",
"ext": "<unknown>"
}
],
"ext": "<unknown>",
"h": 1,
"hratio": 1,
"mime": "<string>",
"native": {
"asset": [
{
"data": {
"value": "<string>",
"ext": "<unknown>",
"len": 123,
"type": 1
},
"ext": "<unknown>",
"id": 123,
"image": {
"url": "<string>",
"ext": "<unknown>",
"h": 1,
"type": 1,
"w": 1
},
"link": {
"url": "<string>",
"ext": "<unknown>",
"trkr": [
"<string>"
],
"urlfb": "<string>"
},
"req": 0,
"title": {
"text": "<string>",
"ext": "<unknown>",
"len": 1
},
"video": {
"adm": "<string>",
"curl": "<string>",
"ext": "<unknown>"
}
}
],
"ext": "<unknown>",
"link": {
"url": "<string>",
"ext": "<unknown>",
"trkr": [
"<string>"
],
"urlfb": "<string>"
}
},
"priv": "<string>",
"w": 1,
"wratio": 1
},
"ext": "<unknown>",
"iurl": "<string>",
"lang": "<string>",
"video": {
"adm": "<string>",
"api": [
32767
],
"ctype": 32767,
"curl": "<string>",
"dur": 1,
"ext": "<unknown>",
"mime": [
"<string>"
]
}
},
"errorcode": "<string>",
"ext": "<unknown>",
"user": {
"buyeruid": "<string>",
"ext": "<unknown>",
"gender": "M",
"geo": {
"accuracy": 123,
"city": "<string>",
"country": "<string>",
"ext": "<unknown>",
"ipservice": 1,
"lastfix": 1,
"lat": 123,
"lon": 123,
"metro": "<string>",
"region": "<string>",
"regionfips104": "<string>",
"type": 1,
"utcoffset": 123,
"zip": "<string>"
},
"id": "<string>",
"keywords": "<string>",
"yob": 32767
}
}