Reward Ad Activity
Reward player’s ad activity
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| ActionGroupNotFound | 1250 |
| AllAdPlacementViewsAlreadyConsumed | 1269 |
| InvalidAdPlacementAndReward | 1268 |
POST
/
Client
/
RewardAdActivity
Reward Ad Activity
curl --request POST \
--url https://{titleId}.playfabapi.com/Client/RewardAdActivity \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"PlacementId": "A124572382B",
"RewardId": "B2674981A"
}
'import requests
url = "https://{titleId}.playfabapi.com/Client/RewardAdActivity"
payload = {
"PlacementId": "A124572382B",
"RewardId": "B2674981A"
}
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({PlacementId: 'A124572382B', RewardId: 'B2674981A'})
};
fetch('https://{titleId}.playfabapi.com/Client/RewardAdActivity', 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/RewardAdActivity",
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([
'PlacementId' => 'A124572382B',
'RewardId' => 'B2674981A'
]),
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/RewardAdActivity"
payload := strings.NewReader("{\n \"PlacementId\": \"A124572382B\",\n \"RewardId\": \"B2674981A\"\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/RewardAdActivity")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PlacementId\": \"A124572382B\",\n \"RewardId\": \"B2674981A\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Client/RewardAdActivity")
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 \"PlacementId\": \"A124572382B\",\n \"RewardId\": \"B2674981A\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"AdActivityEventId": "1639167AGDJG",
"PlacementViewsRemaining": 0,
"PlacementViewsResetMinutes": 36,
"RewardResults": {
"GrantedItems": [
{
"ItemId": "PowerUpBonus5",
"CatalogId": "AdRewards",
"DisplayName": "Five Minute Power Up",
"InstanceId": "17937194371"
}
],
"GrantedVirtualCurrencies": {
"Gold": 5
},
"IncrementedStatistics": {
"AdViews": 1
}
},
"PlacementId": "A124572382B"
}
}{
"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
Details on which placement and reward to perform a grant on
Response
Result for rewarding an ad activity
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.
Result for rewarding an ad activity
Show child attributes
Show child attributes
Example:
{
"AdActivityEventId": "1639167AGDJG",
"PlacementViewsRemaining": 0,
"PlacementViewsResetMinutes": 36,
"RewardResults": {
"GrantedItems": [
{
"ItemId": "PowerUpBonus5",
"CatalogId": "AdRewards",
"DisplayName": "Five Minute Power Up",
"InstanceId": "17937194371"
}
],
"GrantedVirtualCurrencies": { "Gold": 5 },
"IncrementedStatistics": { "AdViews": 1 }
},
"PlacementId": "A124572382B"
}
Last modified on October 1, 2026
Was this page helpful?
⌘I
Reward Ad Activity
curl --request POST \
--url https://{titleId}.playfabapi.com/Client/RewardAdActivity \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"PlacementId": "A124572382B",
"RewardId": "B2674981A"
}
'import requests
url = "https://{titleId}.playfabapi.com/Client/RewardAdActivity"
payload = {
"PlacementId": "A124572382B",
"RewardId": "B2674981A"
}
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({PlacementId: 'A124572382B', RewardId: 'B2674981A'})
};
fetch('https://{titleId}.playfabapi.com/Client/RewardAdActivity', 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/RewardAdActivity",
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([
'PlacementId' => 'A124572382B',
'RewardId' => 'B2674981A'
]),
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/RewardAdActivity"
payload := strings.NewReader("{\n \"PlacementId\": \"A124572382B\",\n \"RewardId\": \"B2674981A\"\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/RewardAdActivity")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PlacementId\": \"A124572382B\",\n \"RewardId\": \"B2674981A\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Client/RewardAdActivity")
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 \"PlacementId\": \"A124572382B\",\n \"RewardId\": \"B2674981A\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"AdActivityEventId": "1639167AGDJG",
"PlacementViewsRemaining": 0,
"PlacementViewsResetMinutes": 36,
"RewardResults": {
"GrantedItems": [
{
"ItemId": "PowerUpBonus5",
"CatalogId": "AdRewards",
"DisplayName": "Five Minute Power Up",
"InstanceId": "17937194371"
}
],
"GrantedVirtualCurrencies": {
"Gold": 5
},
"IncrementedStatistics": {
"AdViews": 1
}
},
"PlacementId": "A124572382B"
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}