Ad Serving

Serving an ad

Serves an ad based on the placement tag (tagid) and request payload (AdRequest). Selects the most appropriate ad using campaign, creative, and bidding strategy data. Returns the final ad determined through DSP response and internal mediation logic.

curl --request POST \
  --url https://your_a2_service/app/v0/ad/{tagid} \
  --header 'Content-Type: application/json' \
  --data '{
  "user": {
    "gender": "M",
    "id": "account-187acvbvz",
    "yob": 1988
  },
  "version": "0.1.0"
}'

POST

app

{tagid}

Serving an ad

curl --request POST \
  --url https://your_a2_service/app/v0/ad/{tagid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "<string>",
  "device": {
    "ext": "<unknown>",
    "geo": {
      "accuracy": 123,
      "city": "<string>",
      "country": "<string>",
      "ext": "<unknown>",
      "lastfix": 1,
      "lat": 123,
      "lon": 123,
      "metro": "<string>",
      "region": "<string>",
      "regionfips104": "<string>",
      "utcoffset": 123,
      "zip": "<string>"
    },
    "ip": "<string>",
    "ua": "<string>"
  },
  "user": {
    "buyeruid": "<string>",
    "ext": "<unknown>",
    "geo": {
      "accuracy": 123,
      "city": "<string>",
      "country": "<string>",
      "ext": "<unknown>",
      "lastfix": 1,
      "lat": 123,
      "lon": 123,
      "metro": "<string>",
      "region": "<string>",
      "regionfips104": "<string>",
      "utcoffset": 123,
      "zip": "<string>"
    },
    "id": "<string>",
    "keywords": "<string>",
    "yob": 1
  }
}
'

import requests

url = "https://your_a2_service/app/v0/ad/{tagid}"

payload = {
    "version": "<string>",
    "device": {
        "ext": "<unknown>",
        "geo": {
            "accuracy": 123,
            "city": "<string>",
            "country": "<string>",
            "ext": "<unknown>",
            "lastfix": 1,
            "lat": 123,
            "lon": 123,
            "metro": "<string>",
            "region": "<string>",
            "regionfips104": "<string>",
            "utcoffset": 123,
            "zip": "<string>"
        },
        "ip": "<string>",
        "ua": "<string>"
    },
    "user": {
        "buyeruid": "<string>",
        "ext": "<unknown>",
        "geo": {
            "accuracy": 123,
            "city": "<string>",
            "country": "<string>",
            "ext": "<unknown>",
            "lastfix": 1,
            "lat": 123,
            "lon": 123,
            "metro": "<string>",
            "region": "<string>",
            "regionfips104": "<string>",
            "utcoffset": 123,
            "zip": "<string>"
        },
        "id": "<string>",
        "keywords": "<string>",
        "yob": 1
    }
}
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({
    version: '<string>',
    device: {
      ext: '<unknown>',
      geo: {
        accuracy: 123,
        city: '<string>',
        country: '<string>',
        ext: '<unknown>',
        lastfix: 1,
        lat: 123,
        lon: 123,
        metro: '<string>',
        region: '<string>',
        regionfips104: '<string>',
        utcoffset: 123,
        zip: '<string>'
      },
      ip: '<string>',
      ua: '<string>'
    },
    user: {
      buyeruid: '<string>',
      ext: '<unknown>',
      geo: {
        accuracy: 123,
        city: '<string>',
        country: '<string>',
        ext: '<unknown>',
        lastfix: 1,
        lat: 123,
        lon: 123,
        metro: '<string>',
        region: '<string>',
        regionfips104: '<string>',
        utcoffset: 123,
        zip: '<string>'
      },
      id: '<string>',
      keywords: '<string>',
      yob: 1
    }
  })
};

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([
    'version' => '<string>',
    'device' => [
        'ext' => '<unknown>',
        'geo' => [
                'accuracy' => 123,
                'city' => '<string>',
                'country' => '<string>',
                'ext' => '<unknown>',
                'lastfix' => 1,
                'lat' => 123,
                'lon' => 123,
                'metro' => '<string>',
                'region' => '<string>',
                'regionfips104' => '<string>',
                'utcoffset' => 123,
                'zip' => '<string>'
        ],
        'ip' => '<string>',
        'ua' => '<string>'
    ],
    'user' => [
        'buyeruid' => '<string>',
        'ext' => '<unknown>',
        'geo' => [
                'accuracy' => 123,
                'city' => '<string>',
                'country' => '<string>',
                'ext' => '<unknown>',
                'lastfix' => 1,
                'lat' => 123,
                'lon' => 123,
                'metro' => '<string>',
                'region' => '<string>',
                'regionfips104' => '<string>',
                'utcoffset' => 123,
                'zip' => '<string>'
        ],
        'id' => '<string>',
        'keywords' => '<string>',
        'yob' => 1
    ]
  ]),
  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  \"version\": \"<string>\",\n  \"device\": {\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"ip\": \"<string>\",\n    \"ua\": \"<string>\"\n  },\n  \"user\": {\n    \"buyeruid\": \"<string>\",\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"keywords\": \"<string>\",\n    \"yob\": 1\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  \"version\": \"<string>\",\n  \"device\": {\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"ip\": \"<string>\",\n    \"ua\": \"<string>\"\n  },\n  \"user\": {\n    \"buyeruid\": \"<string>\",\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"keywords\": \"<string>\",\n    \"yob\": 1\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  \"version\": \"<string>\",\n  \"device\": {\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"ip\": \"<string>\",\n    \"ua\": \"<string>\"\n  },\n  \"user\": {\n    \"buyeruid\": \"<string>\",\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"keywords\": \"<string>\",\n    \"yob\": 1\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"
}

Path Parameters

tagid

string<uuid>

required

The ID of the placement.

Get from the advertising manager.

Body

application/json

AdRequest is used for requesting an ad.

version

string

required

Version of the SDK API.

device

object | null

Device object for the current ad request.

Show child attributes

user

object | null

User object for the current ad request.

Show child attributes

Response

Successfully served an ad

version

string

required

Version of the SDK API.

object | null

Ad object.

Show child attributes

errorcode

string | null

Error code if the request failed.

ext

any

Optional A2 specific extensions.

Serving an ad

curl --request POST \
  --url https://your_a2_service/app/v0/ad/{tagid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "<string>",
  "device": {
    "ext": "<unknown>",
    "geo": {
      "accuracy": 123,
      "city": "<string>",
      "country": "<string>",
      "ext": "<unknown>",
      "lastfix": 1,
      "lat": 123,
      "lon": 123,
      "metro": "<string>",
      "region": "<string>",
      "regionfips104": "<string>",
      "utcoffset": 123,
      "zip": "<string>"
    },
    "ip": "<string>",
    "ua": "<string>"
  },
  "user": {
    "buyeruid": "<string>",
    "ext": "<unknown>",
    "geo": {
      "accuracy": 123,
      "city": "<string>",
      "country": "<string>",
      "ext": "<unknown>",
      "lastfix": 1,
      "lat": 123,
      "lon": 123,
      "metro": "<string>",
      "region": "<string>",
      "regionfips104": "<string>",
      "utcoffset": 123,
      "zip": "<string>"
    },
    "id": "<string>",
    "keywords": "<string>",
    "yob": 1
  }
}
'

import requests

url = "https://your_a2_service/app/v0/ad/{tagid}"

payload = {
    "version": "<string>",
    "device": {
        "ext": "<unknown>",
        "geo": {
            "accuracy": 123,
            "city": "<string>",
            "country": "<string>",
            "ext": "<unknown>",
            "lastfix": 1,
            "lat": 123,
            "lon": 123,
            "metro": "<string>",
            "region": "<string>",
            "regionfips104": "<string>",
            "utcoffset": 123,
            "zip": "<string>"
        },
        "ip": "<string>",
        "ua": "<string>"
    },
    "user": {
        "buyeruid": "<string>",
        "ext": "<unknown>",
        "geo": {
            "accuracy": 123,
            "city": "<string>",
            "country": "<string>",
            "ext": "<unknown>",
            "lastfix": 1,
            "lat": 123,
            "lon": 123,
            "metro": "<string>",
            "region": "<string>",
            "regionfips104": "<string>",
            "utcoffset": 123,
            "zip": "<string>"
        },
        "id": "<string>",
        "keywords": "<string>",
        "yob": 1
    }
}
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({
    version: '<string>',
    device: {
      ext: '<unknown>',
      geo: {
        accuracy: 123,
        city: '<string>',
        country: '<string>',
        ext: '<unknown>',
        lastfix: 1,
        lat: 123,
        lon: 123,
        metro: '<string>',
        region: '<string>',
        regionfips104: '<string>',
        utcoffset: 123,
        zip: '<string>'
      },
      ip: '<string>',
      ua: '<string>'
    },
    user: {
      buyeruid: '<string>',
      ext: '<unknown>',
      geo: {
        accuracy: 123,
        city: '<string>',
        country: '<string>',
        ext: '<unknown>',
        lastfix: 1,
        lat: 123,
        lon: 123,
        metro: '<string>',
        region: '<string>',
        regionfips104: '<string>',
        utcoffset: 123,
        zip: '<string>'
      },
      id: '<string>',
      keywords: '<string>',
      yob: 1
    }
  })
};

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([
    'version' => '<string>',
    'device' => [
        'ext' => '<unknown>',
        'geo' => [
                'accuracy' => 123,
                'city' => '<string>',
                'country' => '<string>',
                'ext' => '<unknown>',
                'lastfix' => 1,
                'lat' => 123,
                'lon' => 123,
                'metro' => '<string>',
                'region' => '<string>',
                'regionfips104' => '<string>',
                'utcoffset' => 123,
                'zip' => '<string>'
        ],
        'ip' => '<string>',
        'ua' => '<string>'
    ],
    'user' => [
        'buyeruid' => '<string>',
        'ext' => '<unknown>',
        'geo' => [
                'accuracy' => 123,
                'city' => '<string>',
                'country' => '<string>',
                'ext' => '<unknown>',
                'lastfix' => 1,
                'lat' => 123,
                'lon' => 123,
                'metro' => '<string>',
                'region' => '<string>',
                'regionfips104' => '<string>',
                'utcoffset' => 123,
                'zip' => '<string>'
        ],
        'id' => '<string>',
        'keywords' => '<string>',
        'yob' => 1
    ]
  ]),
  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  \"version\": \"<string>\",\n  \"device\": {\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"ip\": \"<string>\",\n    \"ua\": \"<string>\"\n  },\n  \"user\": {\n    \"buyeruid\": \"<string>\",\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"keywords\": \"<string>\",\n    \"yob\": 1\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  \"version\": \"<string>\",\n  \"device\": {\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"ip\": \"<string>\",\n    \"ua\": \"<string>\"\n  },\n  \"user\": {\n    \"buyeruid\": \"<string>\",\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"keywords\": \"<string>\",\n    \"yob\": 1\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  \"version\": \"<string>\",\n  \"device\": {\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"ip\": \"<string>\",\n    \"ua\": \"<string>\"\n  },\n  \"user\": {\n    \"buyeruid\": \"<string>\",\n    \"ext\": \"<unknown>\",\n    \"geo\": {\n      \"accuracy\": 123,\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"ext\": \"<unknown>\",\n      \"lastfix\": 1,\n      \"lat\": 123,\n      \"lon\": 123,\n      \"metro\": \"<string>\",\n      \"region\": \"<string>\",\n      \"regionfips104\": \"<string>\",\n      \"utcoffset\": 123,\n      \"zip\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"keywords\": \"<string>\",\n    \"yob\": 1\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"
}

Data Management APIs

Decision APIs

Serving an ad

Path Parameters

Body

Response