Tapjoy Offerwall¶
Non-Visible component| Category | Requires | Version |
|---|---|---|
| Monetization > Advertising | API 21, Android 5.0 Lollipop | 1 |
Overview¶
A component for displaying an offerwall from Tapjoy with virtual currency management.
Permissions
Events¶
Currency Awarded¶
Called when currency has been successfully awarded.
| Params | |
|---|---|
| amount | Number |
| totalBalance | Number |
Currency Balance Received¶
Called when the currency balance has been received.
| Params | |
|---|---|
| currencyName | Text |
| balance | Number |
Currency Earned¶
Called when the user earns currency by completing an offer.
| Params | |
|---|---|
| currencyName | Text |
| amount | Number |
| totalBalance | Number |
Currency Request Failed¶
Called when a currency request fails.
| Params | |
|---|---|
| error | Text |
Currency Spent¶
Called when currency has been successfully spent.
| Params | |
|---|---|
| amount | Number |
| totalBalance | Number |
Offerwall Clicked¶
Called when the user clicks on an offer.
Offerwall Closed¶
Called when the offerwall is closed.
Offerwall Failed To Load¶
Called when the offerwall fails to load.
| Params | |
|---|---|
| error Code | Number |
| error Message | Text |
Offerwall Loaded¶
Called when the offerwall has been loaded.
Offerwall Shown¶
Called when the offerwall is displayed.
Methods¶
Award Currency¶
Awards the specified amount of virtual currency.
| Params | |
|---|---|
| amount | Number |
Dismiss Content¶
Dismisses any currently displayed Tapjoy content.
Get Currency Balance¶
Requests the current virtual currency balance. Fires CurrencyBalanceReceived event.
Is Content Ready¶
Returns: Boolean
Returns true if the offerwall content is ready to be shown.
Is European User¶
Returns: Boolean
Returns true if the user is in Europe (GDPR applies).
Load Offerwall¶
Loads the offerwall.
Set Privacy Policy¶
Configures privacy policy settings. Parameters are: subjectToGdpr (true/false), userConsent (true/false), belowConsentAge (true/false), and usPrivacy (a US privacy string, e.g. '1YNN').
| Params | |
|---|---|
| subjectToGdpr | Boolean |
| userConsent | Boolean |
| belowConsentAge | Boolean |
| usPrivacy | Text |
Show Offerwall¶
Shows the loaded offerwall.
Spend Currency¶
Spends the specified amount of virtual currency.
| Params | |
|---|---|
| amount | Number |
Properties¶
Ad Enabled¶
Boolean Default: True 
Read Write - Designer Blocks
Specifies whether ads should be enabled.
Currency Name¶
Text Read Write - Designer Blocks
Optional display name for the virtual currency.
Entry Point¶
Text Default: unknown Write - Designer
Sets the entry point for ad placements. Valid values: unknown, other, main_menu, hud, exit, fail, complete, inbox, init, store.
Placement Name¶
Text Write - Designer
Property for PlacementName
SDK Key¶
Text Write - Designer
Property for SdkKey
Test Mode¶
Boolean Default: False Write - Designer
If enabled, test mode is activated. Always enabled in companion.
User ID¶
Text Write - Designer
Sets the user ID for Tapjoy. Should be set before loading ads.