Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Offerwall

Offerwall Android SDK

Offerwall iOS SDK

Offerwall Unity SDK

Unity Offerwall

Tapjoy Offerwall
​
​
Integration
  • Quickstart
Displaying Offerwall
  • Deep linking
  • Custom js integration
Advanced
  • API reference
  • Installation and authentication
  • User privacy
Testing
  • Test devices
  1. Grow your game
  2. Unity Offerwall
  3. Web Offerwall

Deep links

Implement deep linking to integrate the Web Offerwall into your website or mobile app.
Read time 4 minutes
Last updated 2 months ago

Direct links provide a very simple method of linking your website to the offerwall. Wherever you want to show the offerwall, you can link to the following URL:
https://rewards.unity.com/owp/web/link/<SDK_KEY>/u/<USER_ID>

Required parameters

  • SDK_KEY - SDK Key provided by Tapjoy
  • USER_ID - User ID needs to be provided by you so we can properly reward users. For more information, refer to Self-managed currency.
Note
Because it's a part of URL, USER_ID must be URL-safe or URL-encoded.

Optional parameters

User privacy

User privacy can be implemented by adding query parameters to the URL. For more information about each flag, refer to User privacy.
https://rewards.unity.com/owp/web/link/<SDK_KEY>/u/<USER_ID>?gdpr=1&cgdpr=1&...

Option

Query Parameter Name

Default Value

Description

Is user subject to GDPR
gdpr
0
Value must be
1
if user is subject to GDPR
GDPR Consent
cgdpr
0
0
means user does not consent,
1
means user consents
Below Consent Age
below_consent_age
0
1
and
0
values respectively represents whether the user is below consent age
US Privacy
us_privacy
1---
For value descriptions, refer to User privacy

Event name

The
event_name
parameter selects which placement to load in your website or mobile app. By loading a placement, Tapjoy renders the content card associated with that placement.
If you omit
event_name
, Tapjoy loads the standard offerwall by default.
Important
If you omit the
event_name
parameter, create a
#WebOfferwall
placement in the Tapjoy dashboard and link it to a content card before you use the URL. For instructions, refer to the Create a placement section of the Placements documentation and the Create an offerwall section of the Offerwall cards documentation.
Use the following deep link format to specify a placement with event_name.
https://rewards.unity.com/owp/web/link/<SDK_KEY>/u/<USER_ID>?event_name=<PLACEMENT_NAME>

User tags

Web offerwall supports segment targeting with User Tags. You can pass multiple user tags by using
user_tags[]=
.
https://rewards.unity.com/owp/web/link/<SDK_KEY>/u/<USER_ID>?user_tags[]=<TAG1>&user_tags[]=<TAG2>

Custom parameter

You can use the custom parameter
cp
to pass user-defined values to track specific details about clicks and conversion.
https://rewards.unity.com/owp/web/link/<SDK_KEY>/u/<USER_ID>?cp=xxx

Embedding with iframe

When embedding the Web Offerwall in an iframe, it is critical to ensure the size of the iframe does not exceed the device's screen viewport. Otherwise, it results in the Instruction CTA Button appearing outside of the visible viewport and users need to scroll all the way down to access the button.
An example of a Web Offerwall embedded in an iframe, illustrating how an oversized iframe can push the Instruction CTA Button outside the visible viewport.
By following these guidelines, developers can maximize the usability and user engagement of the Web Offerwall product, ensuring important UI elements are readily accessible.

Web offerwall from mobile apps

Web Offerwall is also available in mobile apps by loading the link into the WebView.

Examples

Android

Because Web Offerwall does not yet fully handle the Android back button, it is recommended that you override the Android back button and implement your own UI to close the WebView. This prevents users from unintentionally closing the WebView and allows them to use the navigation UI within the OW instead.
void showWebOfferwall() { final WebView webView = new WebView(requireContext()); webView.getSettings().setJavaScriptEnabled(true); webView.getSettings().setDomStorageEnabled(true); webView.getSettings().setMediaPlaybackRequiresUserGesture(false); webView.setBackgroundColor(Color.TRANSPARENT); webView.loadUrl("https://rewards.unity.com/owp/web/link/sdk_key/u/user_id"); RelativeLayout.LayoutParams paramsWebView = new RelativeLayout.LayoutParams(RelativeLayout.LayoutParams.MATCH_PARENT, RelativeLayout.LayoutParams.MATCH_PARENT); Dialog dialog = new Dialog(requireContext(), android.R.style.Theme_Black_NoTitleBar_Fullscreen); dialog.addContentView(webView, paramsWebView); // Handle backbutton dialog.setOnKeyListener(new DialogInterface.OnKeyListener() { @Override public boolean onKey(DialogInterface dialogInterface, int keyCode, KeyEvent event) { if (keyCode == KeyEvent.KEYCODE_BACK && event.getAction() == KeyEvent.ACTION_UP) { if (webView.canGoBack()) { webView.goBack(); } } // return true to prevent closing the WebView return true; } }); dialog.show();}
- (IBAction)showOfferwallAction:(id)sender { WKWebViewConfiguration* configuration = [[WKWebViewConfiguration alloc] init]; configuration.allowsInlineMediaPlayback = YES; configuration.allowsAirPlayForMediaPlayback = NO; WKWebView* webview = [[WKWebView alloc] initWithFrame:self.view.frame configuration:configuration]; [webview setUIDelegate:self]; [webview loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"https://rewards.unity.com/owp/web/link/sdk_key/u/user_id"]]]; [self.view addSubview:webview];}// Open external browser for window.open() or target = _blank- (WKWebView *)webView:(WKWebView *)webViewcreateWebViewWithConfiguration:(WKWebViewConfiguration *)configuration forNavigationAction:(WKNavigationAction *)navigationAction windowFeatures:(WKWindowFeatures *)windowFeatures { NSURL *url = navigationAction.request.URL; [[UIApplication sharedApplication] openURL:url options:@{} completionHandler:^(BOOL success) { if(!success) { NSLog(@"Failed to open URL: %@", [url absoluteString]); } }]; return nil;}

Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page
    • Required parameters

    • Optional parameters

      • User privacy

      • Event name

      • User tags

      • Custom parameter

    • Embedding with iframe

    • Web offerwall from mobile apps

      • Examples

        • Android


Report a problem with this page