Recommendation
Request recommendations
Serves recommended items for the ad unit (tagid) using its recommendation policy.
The response includes the items to render and a tracking_token for recommendation events. It never includes user.
POST
/
app
/
v0
/
recommendation
/
{tagid}
Request recommendations
curl --request POST \
--url https://your_a2_service/app/v0/recommendation/{tagid} \
--header 'Content-Type: application/json' \
--data '
{
"app": {
"bundle": "<string>",
"domain": "<string>",
"name": "<string>",
"storeurl": "<string>",
"ver": "<string>"
},
"device": null,
"filter": {
"exclusion_tags": [
"tag:10",
"taste:N"
],
"rating": 2
},
"seed_item_id": "<string>",
"site": {
"domain": "<string>",
"mobile": true,
"name": "<string>",
"page": "<string>",
"ref": "<string>",
"search": "<string>"
},
"user": {
"gender": "M",
"id": "account-187acvbvz",
"yob": 1988
}
}
'import requests
url = "https://your_a2_service/app/v0/recommendation/{tagid}"
payload = {
"app": {
"bundle": "<string>",
"domain": "<string>",
"name": "<string>",
"storeurl": "<string>",
"ver": "<string>"
},
"device": None,
"filter": {
"exclusion_tags": ["tag:10", "taste:N"],
"rating": 2
},
"seed_item_id": "<string>",
"site": {
"domain": "<string>",
"mobile": True,
"name": "<string>",
"page": "<string>",
"ref": "<string>",
"search": "<string>"
},
"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({
app: {
bundle: '<string>',
domain: '<string>',
name: '<string>',
storeurl: '<string>',
ver: '<string>'
},
device: null,
filter: {exclusion_tags: ['tag:10', 'taste:N'], rating: 2},
seed_item_id: '<string>',
site: {
domain: '<string>',
mobile: true,
name: '<string>',
page: '<string>',
ref: '<string>',
search: '<string>'
},
user: {gender: 'M', id: 'account-187acvbvz', yob: 1988}
})
};
fetch('https://your_a2_service/app/v0/recommendation/{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/recommendation/{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([
'app' => [
'bundle' => '<string>',
'domain' => '<string>',
'name' => '<string>',
'storeurl' => '<string>',
'ver' => '<string>'
],
'device' => null,
'filter' => [
'exclusion_tags' => [
'tag:10',
'taste:N'
],
'rating' => 2
],
'seed_item_id' => '<string>',
'site' => [
'domain' => '<string>',
'mobile' => true,
'name' => '<string>',
'page' => '<string>',
'ref' => '<string>',
'search' => '<string>'
],
'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/recommendation/{tagid}"
payload := strings.NewReader("{\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"filter\": {\n \"exclusion_tags\": [\n \"tag:10\",\n \"taste:N\"\n ],\n \"rating\": 2\n },\n \"seed_item_id\": \"<string>\",\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\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/recommendation/{tagid}")
.header("Content-Type", "application/json")
.body("{\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"filter\": {\n \"exclusion_tags\": [\n \"tag:10\",\n \"taste:N\"\n ],\n \"rating\": 2\n },\n \"seed_item_id\": \"<string>\",\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\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/recommendation/{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 \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"filter\": {\n \"exclusion_tags\": [\n \"tag:10\",\n \"taste:N\"\n ],\n \"rating\": 2\n },\n \"seed_item_id\": \"<string>\",\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\n \"user\": {\n \"gender\": \"M\",\n \"id\": \"account-187acvbvz\",\n \"yob\": 1988\n }\n}"
response = http.request(request)
puts response.read_body{
"ext": {
"ad_log_tracking_mode": "on_ad_response"
},
"items": [
{
"catalog_id": "catalog-123",
"position": 0,
"score": 0.87
},
{
"catalog_id": "catalog-234",
"position": 1
}
],
"tracking_token": "opaque-recommendation-tracking-token",
"version": "0.1.0"
}{
"errorcode": "<string>",
"ext": {
"message": "<string>"
},
"items": [
{
"catalog_id": "<string>",
"position": 123,
"score": 123
}
],
"version": "<string>"
}{
"errorcode": "<string>",
"ext": {
"message": "<string>"
},
"items": [
{
"catalog_id": "<string>",
"position": 123,
"score": 123
}
],
"version": "<string>"
}<string>{
"errorcode": "<string>",
"ext": {
"message": "<string>"
},
"items": [
{
"catalog_id": "<string>",
"position": 123,
"score": 123
}
],
"version": "<string>"
}Path Parameters
The ID of the ad unit.
Get from the advertising manager.
Body
application/json
App 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
Optional exclusion conditions. For webtoon catalogs, rating excludes items above the supplied rating and exclusion_tags excludes items sharing any supplied tag. Conditions combine as exclusions: a match on either condition removes the item. Creative catalog filtering is not implemented. Unknown fields, null values, and empty arrays do not filter candidates. Every top-level array is limited to 100 values, including arrays under unknown fields; exceeding the limit returns HTTP 400 with errorcode 1304.
Example:
{
"exclusion_tags": ["tag:10", "taste:N"],
"rating": 2
}
Optional catalog ID used by seed-based sources, such as Association and Pinned.
Site object for the current serving request.
Show child attributes
Show child attributes
User object for the current serving request.
Show child attributes
Show child attributes
Example:
{
"gender": "M",
"id": "account-187acvbvz",
"yob": 1988
}
Response
Successfully served recommendation
Recommendation wire response. Unlike an ad response, it never echoes user.
Recommended catalog IDs, zero-based positions, and scores when supplied by the candidate source. Empty on error; success may also contain no items.
Show child attributes
Show child attributes
Version of the SDK API.
Application error code on an error response: 1300 invalid tagid; 1301 ad unit not found; 1302 recommendation disabled; 1303 no applicable delivery policy; 1304 filter array exceeds 100 values. Absent on success.
Tracking mode on success, or a message on an error response.
Show child attributes
Show child attributes
Opaque token for this recommendation result. Send it as tracking_token in recommendation log events. Absent on errors.
Was this page helpful?
⌘I
Request recommendations
curl --request POST \
--url https://your_a2_service/app/v0/recommendation/{tagid} \
--header 'Content-Type: application/json' \
--data '
{
"app": {
"bundle": "<string>",
"domain": "<string>",
"name": "<string>",
"storeurl": "<string>",
"ver": "<string>"
},
"device": null,
"filter": {
"exclusion_tags": [
"tag:10",
"taste:N"
],
"rating": 2
},
"seed_item_id": "<string>",
"site": {
"domain": "<string>",
"mobile": true,
"name": "<string>",
"page": "<string>",
"ref": "<string>",
"search": "<string>"
},
"user": {
"gender": "M",
"id": "account-187acvbvz",
"yob": 1988
}
}
'import requests
url = "https://your_a2_service/app/v0/recommendation/{tagid}"
payload = {
"app": {
"bundle": "<string>",
"domain": "<string>",
"name": "<string>",
"storeurl": "<string>",
"ver": "<string>"
},
"device": None,
"filter": {
"exclusion_tags": ["tag:10", "taste:N"],
"rating": 2
},
"seed_item_id": "<string>",
"site": {
"domain": "<string>",
"mobile": True,
"name": "<string>",
"page": "<string>",
"ref": "<string>",
"search": "<string>"
},
"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({
app: {
bundle: '<string>',
domain: '<string>',
name: '<string>',
storeurl: '<string>',
ver: '<string>'
},
device: null,
filter: {exclusion_tags: ['tag:10', 'taste:N'], rating: 2},
seed_item_id: '<string>',
site: {
domain: '<string>',
mobile: true,
name: '<string>',
page: '<string>',
ref: '<string>',
search: '<string>'
},
user: {gender: 'M', id: 'account-187acvbvz', yob: 1988}
})
};
fetch('https://your_a2_service/app/v0/recommendation/{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/recommendation/{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([
'app' => [
'bundle' => '<string>',
'domain' => '<string>',
'name' => '<string>',
'storeurl' => '<string>',
'ver' => '<string>'
],
'device' => null,
'filter' => [
'exclusion_tags' => [
'tag:10',
'taste:N'
],
'rating' => 2
],
'seed_item_id' => '<string>',
'site' => [
'domain' => '<string>',
'mobile' => true,
'name' => '<string>',
'page' => '<string>',
'ref' => '<string>',
'search' => '<string>'
],
'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/recommendation/{tagid}"
payload := strings.NewReader("{\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"filter\": {\n \"exclusion_tags\": [\n \"tag:10\",\n \"taste:N\"\n ],\n \"rating\": 2\n },\n \"seed_item_id\": \"<string>\",\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\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/recommendation/{tagid}")
.header("Content-Type", "application/json")
.body("{\n \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"filter\": {\n \"exclusion_tags\": [\n \"tag:10\",\n \"taste:N\"\n ],\n \"rating\": 2\n },\n \"seed_item_id\": \"<string>\",\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\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/recommendation/{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 \"app\": {\n \"bundle\": \"<string>\",\n \"domain\": \"<string>\",\n \"name\": \"<string>\",\n \"storeurl\": \"<string>\",\n \"ver\": \"<string>\"\n },\n \"device\": null,\n \"filter\": {\n \"exclusion_tags\": [\n \"tag:10\",\n \"taste:N\"\n ],\n \"rating\": 2\n },\n \"seed_item_id\": \"<string>\",\n \"site\": {\n \"domain\": \"<string>\",\n \"mobile\": true,\n \"name\": \"<string>\",\n \"page\": \"<string>\",\n \"ref\": \"<string>\",\n \"search\": \"<string>\"\n },\n \"user\": {\n \"gender\": \"M\",\n \"id\": \"account-187acvbvz\",\n \"yob\": 1988\n }\n}"
response = http.request(request)
puts response.read_body{
"ext": {
"ad_log_tracking_mode": "on_ad_response"
},
"items": [
{
"catalog_id": "catalog-123",
"position": 0,
"score": 0.87
},
{
"catalog_id": "catalog-234",
"position": 1
}
],
"tracking_token": "opaque-recommendation-tracking-token",
"version": "0.1.0"
}{
"errorcode": "<string>",
"ext": {
"message": "<string>"
},
"items": [
{
"catalog_id": "<string>",
"position": 123,
"score": 123
}
],
"version": "<string>"
}{
"errorcode": "<string>",
"ext": {
"message": "<string>"
},
"items": [
{
"catalog_id": "<string>",
"position": 123,
"score": 123
}
],
"version": "<string>"
}<string>{
"errorcode": "<string>",
"ext": {
"message": "<string>"
},
"items": [
{
"catalog_id": "<string>",
"position": 123,
"score": 123
}
],
"version": "<string>"
}