Rewarded video ads

With rewarded video ads, you can implement a reward mechanism inside your experience to incentivize users to watch click-to-play video ads.

Implement rewarded video ads

To implement a rewarded video ad, you must set up the video ad inside your experience, create a client-side script that checks if a video ad is available to be played to the user, and then create a server-side script that turns a developer product into a reward, shows the user the video ad, and grants the user their reward.

Video ad setup

To set up a rewarded video ad inside your experience:

1. Open the experience in Studio and select the location where you want to trigger the video ad.
2. Insert a click-to-play video ad unit in that location.
3. Go to the Game Settings menu and check the Enable Rewarded Video Ads checkbox.
4. Select the reward you want to grant the user. If the reward doesn't already exist, create a new developer product in the Creator Hub.
5. Insert a button that the user must press before the video ad starts playing.

Client-side implementation

To implement the rewarded video ad on the client-side:

1. Add a new LocalScript to the button you just implemented.
2. Use the GetAdAvailabilityNowAsync method to make sure the button is only visible to the user if an ad is available.

Code example for rewarded video ad (Client)
-- Client (LocalScript in a UI button)
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local AdService = game:GetService("AdService")
local requestShowAdEvent = ReplicatedStorage:WaitForChild("RequestShowAdEvent")
local recheckAdAvailabilityEvent = ReplicatedStorage:WaitForChild("RecheckAdAvailabilityEvent")

-- Assume the script is a child of the button
local adButton = script.Parent

-- Hide the UI button until the video ad availability is confirmed
adButton.Visible = false
local function checkAdAvailability()
   local adAvailability = AdService:GetAdAvailabilityNowAsync(Enum.AdFormat.RewardedVideo)
   if adAvailability.AdAvailabilityResult == Enum.AdAvailabilityResult.IsAvailable then

      -- If the video ad is available, show the UI button
      adButton.Visible = true
   else
      -- If the video ad is not available, hide the UI button
      adButton.Visible = false
      -- Recheck ad availability after 60 seconds
      task.delay(60, checkAdAvailability)
   end
end

-- Check if the video ad is available
checkAdAvailability()

-- Use Activated event
adButton.Activated:Connect(function()
   requestShowAdEvent:FireServer()
end)

recheckAdAvailabilityEvent.OnClientEvent:Connect(function()
	checkAdAvailability()
end)

Server-side implementation

To implement the rewarded video ad on the server-side:

1. Create a new Script under ServerScriptService.
2. Use the CreateAdRewardFromDevProductId method to pass the developer product ID of the reward and create an AdReward object.
3. Use the ShowRewardedVideoAsync method to play the video ad to the user.

   • (Optional) Add a placementId to track individual video ad placements inside your experience.
4. Use the ProcessReceipt method to grant the user their reward if they have watched the entire video ad.

Code example for rewarded video ad (Server)
-- Server (Script in ServerScriptService)
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local AdService = game:GetService("AdService")
local MarketplaceService = game:GetService("MarketplaceService")
local Players = game:GetService("Players")

-- Confirm that the EnableRewardedVideoAds setting is enabled in the experience settings
local requestShowAdEvent = Instance.new("RemoteEvent")
requestShowAdEvent.Name = "RequestShowAdEvent"
requestShowAdEvent.Parent = ReplicatedStorage
local recheckAdAvailabilityEvent = Instance.new("RemoteEvent")
recheckAdAvailabilityEvent.Name = "RecheckAdAvailabilityEvent"
recheckAdAvailabilityEvent.Parent = ReplicatedStorage

-- Provide a developer product ID for the video ad reward
local rewardDevProductId = 12345
local function processReceipt(receiptInfo)
	local player = Players:GetPlayerByUserId(receiptInfo.PlayerId)
		if not player then
     		return Enum.ProductPurchaseDecision.NotProcessedYet
 	end
 		if receiptInfo.ProductId == rewardDevProductId then
     		print(player.Name .. " earned the reward!")

     		-- Include the logic for granting rewards here

     		return Enum.ProductPurchaseDecision.PurchaseGranted
 	end
 	return Enum.ProductPurchaseDecision.NotProcessedYet
end

MarketplaceService.ProcessReceipt = processReceipt
requestShowAdEvent.OnServerEvent:Connect(function(player)
	local reward = AdService:CreateAdRewardFromDevProductId(rewardDevProductId)
	local result = AdService:ShowRewardedVideoAdAsync(player, reward, placementId)

	-- Handle specific ad result cases
	if result == Enum.ShowAdResult.AdNotReady then
		warn("Ad not ready for player: " .. player.Name)
	elseif result == Enum.ShowAdResult.InternalError then
		warn("Internal error showing ad for player: " .. player.Name)

	-- Add more cases as needed (for example, ShowInterrupted, AdAlreadyShowing, etc)
	...
	end

	-- Signal the Client to recheck if video ad is available
	recheckAdAvailabilityEvent:FireClient(player)
end)

Placements

Use placements to track the performance of individual rewarded video ads inside your experience.

To create a rewarded video ad placement:

1. In the Creator Dashboard, go to Creations and select an experience.
2. Go to Monetization > Ads > Placements.
3. Click Create Placement.
4. Enter a name for the placement and click Create.

The new placement populates on the Placement table with a unique Placement ID. You can use this Placement ID in the ShowRewardedVideoAsync method to differentiate between and track metrics for the individual video ads inside your experience.

Analytics

Use analytics metrics to evaluate the effectiveness of your rewarded video ads, test different reward types to identify the ones that best resonate with your audience, and measure how often users watch entire video ads to claim rewards.

To access your rewarded video ad metrics:

1. In the Creator Dashboard, go to Creations and select an experience.
2. Go to Monetization > Ads > Analytics.
3. Filter by Rewarded Video to see all of the available metrics.

Eligibility requirements

To prevent abuse of the rewarded ad system and to provide the best user experience possible, you must follow the eligibility requirements when you implement rewarded video ads.

Any violation of the eligilibity requirements can result in account suspension, removal of content, revocation of ad payouts, or loss of eligibility to earn from ads.

Best practices

To get the most out of your rewarded video ad, make sure to:

• Scale rewards so that they remain valuable to your users as they advance through the experience.
• Adjust the frequency of rewards based on user engagement and feedback.
• Use analytics to identify the best placement for video ads to encourage user engagement without disrupting gameplay.