To work with the DT Offer Wall you must ensure that you have:

• Successfully set up your app,
• Integrated the DT Offer Wall via the SDK and implemented the APIs

DT Offer Wall Sample App

If you prefer to jump straight to the code DT's sample app can assist you in using DT Offer Wall within your app. In addition, use the DT sample app as a reference during implementation to troubleshoot possible integration issues.

https://github.com/fyber-engineering/offerwall-sample-app-android

Before Starting the SDK

User Id

DT Offer Wall SDK will generate a unique user ID upon starting the SDK.
If instead you want to provide the SDK with your own user id, you will need to use the following API before starting the SDK:

OfferWall.userId = "userId"

OfferWall.setUserId("userId");

The user id is stored across SDK sessions.
This API can be called at any point after starting the SDK. Any future action by the user will be associated with the new user id.

Privacy and compliance

GDPR

The General Data Protection Regulation requires you to scope your user's consent. For more information on GDPR, click here.
A user is within the GDPR scope for your app when one or all of the following apply:

• The user is currently located in the EU
• The user has registered with the app as an EU resident
• The app is specifically targeted to EU users

Once you have collected the user’s consent, you can pass it onto the SDK using the following API:

OfferWall.setConsent(OfferWallPrivacyConsent.GDPR(true))

OfferWall.setConsent(new OfferWallPrivacyConsent.GDPR(true));

We recommend that the first time you gather the user’s consent, you pass it onto the SDK before starting the SDK. The SDK will then take the user’s consent into consideration when initializing. In the following sessions, you will only need to call the API if the user updates his or her consent.
More information on GDPR can be found under the GDPR Resource Page and FAQs.

CCPA

The intention of the California Consumer Privacy Act of 2018 (CCPA) is to protect the personal information of California residents. CCPA applies to all companies doing business in California. If a California resident uses an app developer’s mobile app, CCPA applies to the developer and every company that processes the personal information of the app’s users.
CCPA came into effect on 1 January 2020.

For more information on DT and CCPA, refer to DT’s CCPA Resource Page.
For more information about CCPA, refer to the IAB CCPA Compliance Framework.

Once you have collected the user’s opt-out, you can pass it onto the SDK using the following API:

OfferWall.setConsent(OfferWallPrivacyConsent.CCPA("1YNN"))

OfferWall.setConsent(new OfferWallPrivacyConsent.CCPA("1YNN"));

Google Play’s Families Ads Program

If you want to achieve full compliance with Google Family Program you will need to let the SDK know that it should not track the google Ad ID in any of its requests for each and every user for which the Google Family Program applies. More information here.

To achieve this, you will need to pass an optional boolean parameter when starting the SDK (see below).

Starting the SDK

Before showing the Offer Wall or requesting Virtual currency you will need to start the SDK using the following API:

OfferWall.start(activity, appId, offerWallListener)

OfferWall.start(activity, appId, offerWallListener);

offerWallListener needs to be defined and passed to the start API.
It will let the integration know when the Offer Wall is opened and closed so you can pause and resume your app accordingly. More information about these callbacks and how to show the Offer Wall here.

Optional Starting parameters

Google Play’s Families Ads Program

By default, the DT Offer Wall SDK will send the Google Ad ID in all communications to our backend.
To prevent that, in alignment with Google Family Program, you can pass an extra optional boolean when starting the SDK:

OfferWall.start(activity = activity, appId = appId, offerWallListener = offerWallListener, disableAdvertisingId = true)

OfferWall.start(activity, appId, offerWallListener, true);

Showing the Offer Wall

To Show the Offer Wall simply use the following API:

OfferWall.show()

OfferWall.show();

This will show the Offer Wall for the default placement with the default behavior (keep the Offer Wall open when the user clicks on an offer and gets redirected out of your app).

Show Options

If you want to specify the placement ID, change the default behavior of the Offer Wall or introduce tracking parameters you can use ‘Show Options’

Close on Redirect

You can specify whether the Offer Wall should be closed once a user clicks on an offer. This will determine what the user sees when returning back to the app: either the Offer Wall again or your app.
By default, this value is false meaning the user will come back to the Offer Wall.
Use the following API to define the desired behavior:

val showOptions = ShowOptions(closeOnRedirect = true)
OfferWall.show(showOptions)

boolean closeOnRedirect = true;
ShowOptions showOptions = new ShowOptions(closeOnRedirect);
OfferWall.show(showOptions);

Custom parameters (server side rewarding)

When using server side rewarding (see Integrating via REST API - Rewards), you may want to associate additional parameters to the Offer Wall being shown for a given user/placement so that you can perform additional tracking. These custom parameters will be passed back to your system during the reward callback.
Note that these parameters’ keys are limited to pub0, pub1, ... , pub9

To add these custom parameters when showing the Offer Wall, using the following API:

val customParams = mapOf("pub0" to "tracking_value_0", "pub1" to "tracking_value_1")
val showOptions = ShowOptions(customParams = customParams)
OfferWall.show(showOptions)

boolean closeOnRedirect = false;
Map<String,String> customParams = new HashMap<>();
customParams.put("pub0", "tracking_value_0");
customParams.put("pub1", "tracking_value_1");
ShowOptions showOptions = new ShowOptions(closeOnRedirect, customParams);
OfferWall.show(showOptions);

Show With Placement ID

If you’re using placements in your integration, you can specify for which placement ID you want to show the Offer Wall:

OfferWall.show(placementId = "placementId")

OfferWall.show(new ShowOptions(), "placementId");

Offer Wall Lifecycle Callbacks

As mentioned in the "Starting the SDK" section, you will need to set up a listener to be notified of Offer Wall lifecycle events:

• Offer Wall is about to be shown
• User closed the Offer Wall
• Offer Wall was closed unexpectedly due to an error

This is how you implement the listener:

val offerWallListener = object: OfferWallListener {
    override fun onShowError(placementId: String?, error: OfferWallError) {
        // This is not expected to take place.
        // You can assume the Offer Wall is not being displayed and resume your app
    }

    override fun onShow(placementId: String?) {
        // You can assume the Offer Wall is being displayed and pause your app
    }

    override fun onClose(placementId: String?) {
        // You can assume the Offer Wall is not being displayed and resume your app
    }
}

OfferWallListener offerWallListener = new OfferWallListener() {
    @Override
    public void onShowError(@Nullable String placementId, @NonNull OfferWallError error) {
        // This is not expected to take place.
        // You can assume the Offer Wall is not being displayed and resume your app
    }

    @Override
    public void onShow(@Nullable String placementId) {
        // You can assume the Offer Wall is being displayed and pause your app
    }

    @Override
    public void onClose(@Nullable String placementId) {
        // You can assume the Offer Wall is not being displayed and resume your app
    }
};

Check the "Errors" section to assess which problem took place (typically an integration mistake).

Rewarding the User

If you are interested in using your own server to handle virtual rewards to your users, DT can interact with it after you've set up your own server.

Click here for more details on Server-Side Hosting.

The section below assumes you do not run your own servers and you prefer to rely on DT's virtual currency hosting. This is the default setting for mobile applications in the developer Dashboard.

You will first need to implement a VirtualCurrencySettings object and pass it to the SDK start.

Virtual Currency Settings

The VirtualCurrencySettings holds the security token and callbacks that allow for the complete client side rewarding:

val virtualCurrencySettings = VirtualCurrencySettings("security_token", object: VirtualCurrencyListener {
    override fun onVirtualCurrencySuccess(response: VirtualCurrencySuccessfulResponse) {
        val amountReceived = response.deltaOfCoins
        // reward users accordingly
    }

    override fun onVirtualCurrencyError(error: VirtualCurrencyErrorResponse) {
        // something went wrong. Make sure the security token is correct
    }
})
OfferWall.start(activity = activity, appId =  "appId", offerWallListener = ofwListener, virtualCurrencySettings = virtualCurrencySettings)

VirtualCurrencySettings virtualCurrencySettings = new VirtualCurrencySettings("security_token", new VirtualCurrencyListener() {
    @Override
    public void onVirtualCurrencySuccess(@NonNull VirtualCurrencySuccessfulResponse response) {
        double amountReceived = response.getDeltaOfCoins();
        // reward users accordingly
    }

    @Override
    public void onVirtualCurrencyError(@NonNull VirtualCurrencyErrorResponse error) {
        // something went wrong. Make sure the security token is correct
    }
});

OfferWall.start(activity, "appId", ofwListener, false, virtualCurrencySettings);

Requesting Virtual Currency

For requesting Virtual Currency use the following API:

OfferWall.requestCurrency()

OfferWall.requestCurrency();

This will request the server for the delta (amount since last transaction) of default virtual currency the current user is eligible for.

Virtual Currency Options

The request can be additionally configured in order to:

• Specify the currency ID you want to request for (in case you are using multiple currencies in your app)
• Specify whether the SDK should show a Toast to the user notifying them of the amount of virtual currency received. (it is shown by default)

val options = VirtualCurrencyRequestOptions(toastOnReward = false,currencyId = "currency_id")
OfferWall.requestCurrency(options)

VirtualCurrencyRequestOptions options = new VirtualCurrencyRequestOptions(false, "currency_id");
OfferWall.requestCurrency(options);

Handling Virtual Currency Success response

You can extract the delta of coins received by the user as well as the currency name and id from the the VirtualCurrencySuccessfulResponse object:

override fun onVirtualCurrencySuccess(response: VirtualCurrencySuccessfulResponse) {
    val amountReceived = response.deltaOfCoins
    val currencyId = response.currencyId
    val coinsEarned = response.currencyName
    // reward users accordingly
}

@Override
public void onVirtualCurrencySuccess(@NonNull VirtualCurrencySuccessfulResponse response) {
    double c = response.getDeltaOfCoins();
    String currencyId = response.getCurrencyId();
    String currencyName = response.getCurrencyName();
    // reward users accordingly
}

Virtual Currency Error

When there is a problem with the request you can assess what’s wrong by inspecting the VirtualCurrencyErrorResponse object:

override fun onVirtualCurrencyError(error: VirtualCurrencyErrorResponse) {
    // something went wrong. Make sure the security token is correct
    val currencyId = error.currencyId
    val message = error.serverErrorMessage
    val error = error.error
}

@Override
public void onVirtualCurrencyError(@NonNull VirtualCurrencyErrorResponse error) {
    // something went wrong. Make sure the security token is correct
    String currencyId = error.getCurrencyId();
    String message = error.getServerErrorMessage();
    OfferWallError error = error.getError();
}

Errors

Some issues may arise when either showing the Offer Wall or requesting virtual currency.

Here is a list of the possible errors: