---
description: >-
  Offerwalls are in-app ads that incentivize users to take particular actions.
  In return, the user gets an in-app reward and the developer gets paid by the
  advertiser.
---

# React Native



{% hint style="warning" %}
**Before you start**&#x20;

To set up the PubScale Offerwall, you’ll need to add your app to our platform. Follow this guide for instructions on [how to set up your app](setting-up-your-app). Once completed, you will receive a unique 8-digit app ID.
{% endhint %}

{% hint style="info" %}
You can download the Sample integration from [GitHub](https://github.com/GreedyGame/demo-offerwall-react-native)
{% endhint %}

## 1. Add this to your build.gradle file

Add the below line inside the **dependencies** block in your build.gradle file

{% tabs %}
{% tab title="Kotlin Script" %}
```kts
implementation("com.pubscale.sdkone:offerwall:1.0.11")
```
{% endtab %}

{% tab title="Groovy" %}
```groovy
implementation 'com.pubscale.sdkone:offerwall:1.0.11'
```
{% endtab %}
{% endtabs %}

## 2. Configure proguard rules

For the SDK to work properly in release(obfuscated/minified) builds, add the following rules in your proguard-rules.pro file.

{% code title="proguard-rules.pro" %}
```properties
-keep class com.pubscale.sdkone.offerwall.** {*;}
-keep class com.pubscale.caterpillar.analytics.** {*;}
#Supporting R8 full mode
-keep,allowobfuscation,allowshrinking class kotlin.coroutines.Continuation
-keep,allowobfuscation,allowshrinking interface retrofit2.Call
-keep,allowobfuscation,allowshrinking class retrofit2.Response

```
{% endcode %}

We have added the SDK to the project. Learn how to initialize the SDK in the next step

## 3. Add native module files

Add the files in the zip file to your app's android module under app folder.&#x20;

{% tabs %}
{% tab title="Java" %}
Download the **pubscale\_ow\_java.zip** from the below link

[https://github.com/greedyraagava/demo-offerwall-react-native/releases/latest](https://github.com/greedyraagava/demo-offerwall-react-native/releases/latest)
{% endtab %}

{% tab title="Kotlin" %}
Download the **pubscale\_ow\_kotlin.zip** from the below link

[https://github.com/greedyraagava/demo-offerwall-react-native/releases/latest](https://github.com/greedyraagava/demo-offerwall-react-native/releases/latest)
{% endtab %}
{% endtabs %}

### 3.1. Link the module



{% tabs %}
{% tab title="Java" %}
Add the following line inside the getPackages() method of MainApplication class

```java
packages.add(new PubscaleOfferwallPackage())
```

<figure><img src="https://95496035-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx0ylFv11SuG05Xj0pGLn%2Fuploads%2FlbZziwDNTCnpD2Zb8VOV%2FScreenshot%202025-07-02%20at%205.16.36%E2%80%AFPM.png?alt=media&#x26;token=cc29cd68-30cc-49e7-af41-307e301c1c6b" alt=""><figcaption><p>Adding PubscaleOfferwallSdkPackage to React packages</p></figcaption></figure>
{% endtab %}

{% tab title="Kotlin" %}
Add the following line inside the getPackages() method of MainApplication class

```kotlin
packages.add(PubscaleOfferwallPackage())
```

<figure><img src="https://95496035-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx0ylFv11SuG05Xj0pGLn%2Fuploads%2FopMj9KYcDGUJzab8PJBo%2FScreenshot%202025-07-02%20at%205.11.06%E2%80%AFPM.png?alt=media&#x26;token=d6fe7593-dba2-4685-b671-bb79a387fef1" alt=""><figcaption><p>Adding PubscaleOfferwallSdkPackage to React packages</p></figcaption></figure>
{% endtab %}
{% endtabs %}

## 4. Initialize the SDK

To initialize the SDK, call the PubscaleOfferwall.init() method.

Pass the app\_id (generated from the console) as the first parameter of the init method. Make sure to call the init method as soon as your app starts up, ideally in app.js or index.js.

{% hint style="info" %}
Obtain your **app\_id** from the [PubScale Dashboard](https://dashboard.pubscale.com) by [adding your app and configuring the offerwall.](setting-up-your-app) Once completed, you will receive a unique 8-digit app ID.
{% endhint %}

#### Optional Parameters:

| Parameter              | Description                                                                                                                                                               |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **user\_id**           | Pass your user's id in this field to tag your user. This id will be sent along with the S2S callback. Make sure to call the init function every time the user id changes. |
| **background\_Base64** | An image that will be displayed as a banner on top of the offer wall. Pass the image in base64 encoded format. The background will be black by default.                   |
| **appicon\_Base64**    | An image that will be displayed in the center on the top banner of the offerwall. Pass the image in base64 encoded format. Default value is the app icon.                 |
| **sandbox**            | Enables the sandbox environment for the Offerwall Session                                                                                                                 |

### 4.1. Making the Init call

{% hint style="info" %}
Use sandbox parameter for testing purposes.&#x20;

[sandbox-environment](../sandbox-environment/sandbox-environment "mention") - Learn how to setup Sandbox environment
{% endhint %}

```jsx
import {NativeModules, Alert} from 'react-native';
const {PubscaleOfferwall} = NativeModules;

//Initializes the SDK
//call init once the user is logged in

PubscaleOfferwall.init( "app_id", {
    "user_id": "test-user", //optional, but require to tag user to offer completion.
    "sandbox": false, //set it to true to enable sandbox mode
    "background_Base64": base64Image, //optional
    "appicon_Base64": app64Image, //optional
}, () => { //onSuccess Callback
    console.log("success")
}, (errMsg)=>{ //onFailure Callback
    console.log(errMsg)
})
```

## 5. Start the OfferWall

To start the offerwall, just call, `PubscaleOfferwall.launch()` method.

```jsx
PubscaleOfferwall.launch(
  () => {
    // Offerwall Showed Callback
    console.log("Offerwall launched");
  },
  () => {
    // Offerwall Closed Callback
    console.log("Offerwall closed");
  },
  (amt, curr, token) => {
    // Offerwall Rewarded Callback
    console.log("Reward:", amt, curr, token);
  },
  (err) => {
    // Offerwall Error Callback
    console.log("Launch error:", err);
  }
);
```

## 6. Setup S2S callbacks <a href="#id-3.-test-the-offerwall" id="id-3.-test-the-offerwall"></a>

Setup the S2S callbacks to get instant updates whenever the user gets the reward. You can use this callback to reward the user in your application. [Learn more.](../server-to-server-s2s-callback-configuration)

## 7. Test the OfferWall <a href="#id-3.-test-the-offerwall" id="id-3.-test-the-offerwall"></a>

{% hint style="info" %}
Please use the sandbox environment for testing purposes to get instant callbacks and rewards. To learn how to enable the Sandbox environment, [click here](../sandbox-environment/sandbox-environment).
{% endhint %}

Finally, To test the offerwall, build the application to an actual device. Check if you can launch the Offerwall and get the appropriate callbacks.
