Rewarded Video Ads

Introduction

Rewarded Video is an immersive, full-screen video advertisement that presents a value proposition to users by providing incentives upon watching the video. With Pangle's robust rewarded video ad offerings, publishers can tailor their ads to a variety of formats that best suit their specific needs. At present, the forms of Pangle rewarded video ads can:

Display an Endcard after the video.
Display a playable ad after the video.
Display a playable ad directly.

Precondition

Create an app and reward video ad placement on the Pangle platform

Create an application: [Application] -> [App] -> [Add App]Reference: How do I create a new App?
Create an ad placement：[Application] -> [Ad Placements] -> [Add Ad Placement] -> [Rewarded Video Ads]Reference: How do I create an ad placement?

Pangle Platform Parameter Setting：

Orientation: Select the orientation of the video.
Reward amount: Enter the number of reward items the user will receive. Must be a whole number.
Reward item: Enter the name of the reward item the user will receive. Examples: Coins, extra lives
Reward deliver setting： Validate each completed rewarded video ad view by the third-party server and ensure you're only rewarding users who have actually finished watching the video in your app.

Rewarded Video Implementation

Create the PAGRewardedRequest object

Load a Rewarded ad and Register PAGRewardedAdLoadListener callbacks.

Display the ad.

Load a Rewarded Ad

Loading an ad is accomplished using the load() method in the PAGRewardedAd class. The load() method requires an ad slot id, an instance object of PAGRewardedRequest, and a PAGRewardedAdLoadListener to be notified when ad loading succeeds or fails. The loaded PAGRewardedAd object is provided as a parameter in the success callback.

Create `PAGRewardedRequest` object

PAGRewardedRequest is an Ad Loading Manager. It is recommended to be the member variable of the Activity.

Load an ad and Register `PAGRewardedAdLoadListener` callback

Use the method of PAGRewardedAd to load the ad, and register the PAGRewardedAdLoadListener callback.

Note: After the waterfall rewarded Ad is displayed or closed, Pangle SDK will automatically start a new ad request for the next display chance, please turn off the self-built Pre-loading logic.

The description of `PAGRewardedAdLoadListener` callback

PAGRewardedAdLoadListener	description
onError	This method is invoked when an ad fails to load. It includes an error parameter of type Error that indicates what type of failure occurred. For more information, refer to the ErrorCode section
onAdLoaded	This method is executed when an ad material is loaded successfully.

Register Ad Event Callback

Ad event callbacks need to be registered before displaying an ad. Each method in the event callback corresponds to an event in the ad lifecycle.

The description of PAGRewardedAdInteractionListener callback

PAGRewardedAdInteractionListener	description
onAdShowed	This method is invoked when the ad is displayed, covering the device's screen.
onAdClicked	This method is invoked when the ad is clicked by the user.
onAdDismissed	This method is invoked when the ad disappears.
onUserEarnedReward	The method is invoked when the user should be rewarded.
onUserEarnedRewardFail	The method is invoked when the user rewarded failed.

Display the Ad

An instance of the PAGRewardedAd object will be returned when the ad is loaded successfully. Call the show()method of PAGRewardedAd to render the ad and it needs to pass in activity, and it must be called in the main thread.

Test with test ads

Upon completing the integration, it is essential to ensure that you test your app functionality prior to launching it to end users. It is highly recommended that you employ test ads rather than live ads.

To facilitate the testing process, Pangle offers a "test mode" that is specifically designed to generate test ads for every request. You can seamlessly implement this mode in your app during the coding, testing, and debugging phase, and gain confidence that your app's ad functionality is fully operational before deploying it to end users.

Refer to the How to add a test device? to add your device to the test devices on the Pangle platform.

Server-Side Reward Verification Callback

Note： Server-side verification is not necessary. Server-side verification acts as an additional layer of validation for rewarded ad views in your app. It’s performed in addition to the standard client-side callback. You can use server-side verification to validate each completed rewarded video ad view and ensure you're only rewarding users who have actually finished watching the video in your app.

The server-side verification callback will append query parameters to your postback URL describing the rewarded video interaction:trans_id=%s&reward_name=%s&reward_amount=%d&extra=%s&sign=%s

Field Name	Field Definition	Field Type	Remarks
sign	signSignature of the request	string	The signature of the request guarantees security
trans_id	Transaction id	string	Unique transaction ID for completing viewing the ad
reward_amount	number of rewards	int	Pangle platform configuration
reward_name	Name of rewards	string	Pangle platform configuration
extra	Extra	string	Call SDK input and pass-through, leave it empty if not needed.

Signature Generation：

appSecurityKey: The key you get for adding rewarded video ad code bit on the Pangle Network

transId: transaction id

sign: sha256(appSecurityKey:transId)

Python sample:

Return：

Returns json data with the following fields:

Field Definition	Field Name	Field Type	Remarks
isValid	Validation result	BOOL	determines the result, whether to award or not