Get Ad Placements
Returns a list of ad placements and a reward for each
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| ProductDisabledForTitle | 1609 |
POST
/
Client
/
GetAdPlacements
Get Ad Placements
curl --request POST \
--url https://{titleId}.playfabapi.com/Client/GetAdPlacements \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"AppId": "A12784B",
"Identifier": {
"Name": "PowerBonusInterstitial"
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Client/GetAdPlacements"
payload = {
"AppId": "A12784B",
"Identifier": { "Name": "PowerBonusInterstitial" }
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({AppId: 'A12784B', Identifier: {Name: 'PowerBonusInterstitial'}})
};
fetch('https://{titleId}.playfabapi.com/Client/GetAdPlacements', 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://{titleId}.playfabapi.com/Client/GetAdPlacements",
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([
'AppId' => 'A12784B',
'Identifier' => [
'Name' => 'PowerBonusInterstitial'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization: <api-key>"
],
]);
$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://{titleId}.playfabapi.com/Client/GetAdPlacements"
payload := strings.NewReader("{\n \"AppId\": \"A12784B\",\n \"Identifier\": {\n \"Name\": \"PowerBonusInterstitial\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Authorization", "<api-key>")
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://{titleId}.playfabapi.com/Client/GetAdPlacements")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"AppId\": \"A12784B\",\n \"Identifier\": {\n \"Name\": \"PowerBonusInterstitial\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Client/GetAdPlacements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"AppId\": \"A12784B\",\n \"Identifier\": {\n \"Name\": \"PowerBonusInterstitial\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"AdPlacements": [
{
"PlacementId": "A124572382B",
"PlacementName": "PowerBonusInterstitial",
"RewardId": "B2674981A",
"RewardName": "PowerBonusReward",
"RewardAssetUrl": "https://cdn.test.com/PowerBonusReward.png",
"PlacementViewsRemaining": 1,
"PlacementViewsResetMinutes": 37
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires a client session ticket, available from any Client Login function.
Body
application/json
Using an AppId to return a list of valid ad placements for a player.
Using an AppId to return a list of valid ad placements for a player.
Response
Array of AdPlacementDetails
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Array of AdPlacementDetails
Show child attributes
Show child attributes
Example:
{
"AdPlacements": [
{
"PlacementId": "A124572382B",
"PlacementName": "PowerBonusInterstitial",
"RewardId": "B2674981A",
"RewardName": "PowerBonusReward",
"RewardAssetUrl": "https://cdn.test.com/PowerBonusReward.png",
"PlacementViewsRemaining": 1,
"PlacementViewsResetMinutes": 37
}
]
}
Last modified on October 1, 2026
Was this page helpful?
⌘I
Get Ad Placements
curl --request POST \
--url https://{titleId}.playfabapi.com/Client/GetAdPlacements \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"AppId": "A12784B",
"Identifier": {
"Name": "PowerBonusInterstitial"
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Client/GetAdPlacements"
payload = {
"AppId": "A12784B",
"Identifier": { "Name": "PowerBonusInterstitial" }
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({AppId: 'A12784B', Identifier: {Name: 'PowerBonusInterstitial'}})
};
fetch('https://{titleId}.playfabapi.com/Client/GetAdPlacements', 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://{titleId}.playfabapi.com/Client/GetAdPlacements",
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([
'AppId' => 'A12784B',
'Identifier' => [
'Name' => 'PowerBonusInterstitial'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization: <api-key>"
],
]);
$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://{titleId}.playfabapi.com/Client/GetAdPlacements"
payload := strings.NewReader("{\n \"AppId\": \"A12784B\",\n \"Identifier\": {\n \"Name\": \"PowerBonusInterstitial\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Authorization", "<api-key>")
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://{titleId}.playfabapi.com/Client/GetAdPlacements")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"AppId\": \"A12784B\",\n \"Identifier\": {\n \"Name\": \"PowerBonusInterstitial\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Client/GetAdPlacements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"AppId\": \"A12784B\",\n \"Identifier\": {\n \"Name\": \"PowerBonusInterstitial\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"AdPlacements": [
{
"PlacementId": "A124572382B",
"PlacementName": "PowerBonusInterstitial",
"RewardId": "B2674981A",
"RewardName": "PowerBonusReward",
"RewardAssetUrl": "https://cdn.test.com/PowerBonusReward.png",
"PlacementViewsRemaining": 1,
"PlacementViewsResetMinutes": 37
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}