SDK APIs

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.

To download the app, click on the relevant platform tab.

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 User ID, you will need to use the following API before starting the SDK:

Kotlin

OfferWall.userId = "userId"

Java

OfferWall.setUserId("userId");

The User ID is stored across SDK sessions.

This API can be called at any point after starting the SDK. The new user ID will be associated with any future action by the user.

Privacy and Compliance

The General Data Protection Regulation requires you to scope your user's consent.

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:

Kotlin

OfferWall.setConsent(
    OfferWallPrivacyConsent.GDPR(true)
)

Java

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

Swift

let GDPRDataUseConsent = OfferWallDataUseConsent.GDPR(.given)
OfferWall.setConsent(GDPRDataUseConsent)

Objective-C

OFWDataUseConsent *gdprConsent = [OFWDataUseConsentGDPR
    dataUseConsentGDPRWithConsent:OFWGDPRConsentGiven];

[OfferWall setConsent:gdprConsent];

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 consider the user's consent when initializing. In the following sessions, you must only call the API if the user updates their consent.

For more information about DT and GDPR, refer to DT's GDPR Resource Page.

CCPA

The California Consumer Privacy Act of 2018 (CCPA) is intended to protect the personal information of California residents. CCPA applies to all companies doing business in California. If a California resident uses a mobile app developer's 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 about DT and CCPA, refer to DT's CCPA Resource Page.

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

Kotlin

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

Java

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

Swift

let CCPADataUseConsent = OfferWallDataUseConsent.CCPA(
    privacyString: "1YYN"
)
OfferWall.setConsent(CCPADataUseConsent)

Objective-C

OFWDataUseConsent *ccpaConsent = [OFWDataUseConsentCCPA
    dataUseConsentCCPAWithPrivacyString:"1YNN"];
[OfferWall setConsent:ccpaConsent];

Google Play Families Ads Program

To comply with the Google Play Family Program, you must instruct the SDK not to track the Google Ad ID in any requests for users covered by the program. By default, the DT Offer Wall SDK includes the Google Ad ID in all communications with our backend; however, to prevent this and align with the Family Program requirements, you can pass an optional boolean parameter when you start the SDK.

Kotlin

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

Java

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

Starting the SDK

Starting from FairBid 3.63.0, you will need to pass the saltToken when starting the SDK. Contact your DT Representative for information on how to set it up.

The SDK will throw a Runtime Exception if the saltToken value is null or empty.

Start the SDK using the following API to show the Offer Wall or request Virtual currency:

Kotlin

OfferWall.start(activity = activity,
    appId = appId,
    offerWallListener = offerWallListener,
    saltToken = saltToken)

Java

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

The 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. For more information about these callbacks and how to show the Offer Wall, see Showing the Offer Wall.

Swift

/*API parameter updated (from 3.42.0): virtualCurrencyStartOptions -> virtualCurrencySettings */
OfferWall.start(with: appIdText, 
    delegate: self, 
    virtualCurrencySettings: nil,
    saltToken: saltToken) { [self] error in }

Objective-C

/*API parameter updated (from 3.42.0): virtualCurrencyStartOptions -> virtualCurrencySettings */
[OfferWall startWithAppId:appId 
    delegate:self 
    virtualCurrencySettings:nil 
    saltToken:saltToken 
    completion:^(OFWError * _Nullable error) {}];

The delegate needs to be defined and passed to the start API.

// Basic start with salt token
OfferWall.StartSDK(appId, saltToken);

// With virtual currency security token
OfferWall.StartSDK(appId, saltToken, token);

// With disableAdvertisingId for family-friendly apps  
OfferWall.StartSDK(appId, saltToken, null, true);

// Complete example with all parameters
OfferWall.StartSDK(appId, saltToken, token, false);

Implement lifecycle callbacks to inform the integration when the Offer Wall is opened and closed so you can pause and resume your app accordingly.

Showing the Offer Wall

To Show the Offer Wall, simply use the OfferWall.show API:

Kotlin

OfferWall.show()

Java

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

Show Options enables you to specify the placement ID, change the default behavior of the Offer Wall, or introduce tracking parameters.

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 to the app: either the Offer Wall again or your app. This value is false by default, meaning the user will return to the Offer Wall.

Use the showOptions API to define the desired behavior:

Kotlin

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

Java

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

Swift

let showOptions = ShowOptions(
    closeOnRedirect: true,
    viewController: nil,
    animated: true,
    customParams: nil
)
OfferWall.show(with: showOptions)

Objective-C

OFWShowOptions *options = [OFWShowOptions optionsWithCloseOnRedirect:YES
    viewController:nil
    animated:NO
    customParams:nil];
[OfferWall showWithOptions:options];

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, use the customParams API:

Kotlin

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

OfferWall.show(showOptions)

Java

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);

Swift

let customParams = [
    "pub0": "tracking_value_0",
    "pub1": "tracking_value_1"
]
let showOptions = ShowOptions(
    viewController: nil,
    customParams: customParams
)
OfferWall.show(with: showOptions)

Objective-C

NSDictionary *customParams = @{
    @"pub0": @"tracking_value_0",
    @"pub1": @"tracking_value_1"
};
OFWShowOptions *showOptions = [OFWShowOptions
    optionsWithViewController:self
    customParams:customParams];
[OfferWall showWithOptions:showOptions];

var customParams = new Dictionary<string, string>
{
    { "pub0", "tracking_value_0" },
    { "pub1", "tracking_value_1" }
};
OfferWallShowOptions showOptions = new OfferWallShowOptions(customParams: customParams);
OfferWall.Show(offerWallShowOptions: 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:

Kotlin

OfferWall.show(placementId = "placementId")

Java

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

Offer Wall Lifecycle Callbacks

Following Starting the SDK, you will need to set up a listener to be notified of the following Offer Wall lifecycle events:

Offer Wall is about to be shown.
The user closed the Offer Wall.
Offer Wall was closed unexpectedly due to an error.

Implement the listener with the OfferWallListener API:

Kotlin

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.
    }
}

Java

OfferWallListener offerWallListener = new OfferWallListener() {
    @Override
    public void onShowError(@Nullable String placementId, @NonNull OfferWallError error) {
        // Handle the error, assuming Offer Wall not displayed, resume app.
    }
    @Override
    public void onShow(@Nullable String placementId) {
        // Offer Wall shown, pause app here.
    }
    @Override
    public void onClose(@Nullable String placementId) {
        // Offer Wall closed, resume app here.
    }
};

Swift

class OfferWallListener: OfferWallDelegate {
    func didShow(_ placementId: String?) {
        // You can assume the Offer Wall is being displayed and pause your app.
    }
    func didFailToShow(_ 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.
    }
    func didDismiss(_ placementId: String?) {
        // You can assume the Offer Wall is not being displayed and resume your app.
    }
}

Objective-C

@interface OfferWallListener: NSObject  {
}
@end
@implementation OfferWallListener
- (void)didShow:(NSString * _Nullable)placementId {
    // You can assume the Offer Wall is being displayed and pause your app.
}
- (void)didFailToShow:(NSString * _Nullable)placementId error:(OFWError * _Nonnull)error {
    // This is not expected to take place.
    // You can assume the Offer Wall is not being displayed and resume your app.
}
- (void)didDismiss:(NSString * _Nullable)placementId {
    // You can assume the Offer Wall is not being displayed and resume your app.
}
@end

OfferWall.OfferWallShownEvent += OnOfwShown;
OfferWall.OfferWallClosedEvent += OnOfwClosed;
OfferWall.OfferWallFailedToShowEvent += OnOfwFailedToShow;

Where the events comply with the following delegates:

public delegate void OfferWallShownCallback(string? placementId);
public delegate void OfferWallClosedCallback(string? placementId);
public delegate void OfferWallFailedToShowCallback(string? placementId, OfferWallError error);

See Errors to assess any problems that may occur (typically an integration mistake).

Rewarding the User

If you are interested in using your server to handle virtual rewards to your users, DT can interact with it after you've set up your server. For further information, see Server-Side Hosting.

Virtual Currency Settings assumes you do not run your servers and prefer relying on DT's virtual currency hosting. This is the default setting for mobile applications in the developer Dashboard.

Virtual Currency Settings

First, you must implement a VirtualCurrencySettings object and pass it to the SDK start.

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

Kotlin

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,
    saltToken = saltToken,
    virtualCurrencySettings = virtualCurrencySettings)

Java

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,
    saltToken,
    virtualCurrencySettings);

Swift

func didReceive(_ response: VirtualCurrencyResponse) {
    let amount = response.deltaOfCoins
    // Reward users accordingly.
}

func didFail(with errorResponse: VirtualCurrencyErrorResponse) {
    // Something went wrong. Make sure the security token is correct.
}

Start the Offer Wall with a security token and delegate

Swift

/* Class name updated (from 3.42.0): VirtualCurrencyStartOptions - VirtualCurrencySettings */
var vcSettings = VirtualCurrencySettings(securityToken:
    "security_token", delegate: self)
OfferWall.start(with: appId, 
    delegate: self,
    virtualCurrencySettings: vcSettings,
    saltToken: saltToken) { [self] error in }

Objective-C

- (void)didReceiveResponse:(OFWVirtualCurrencyResponse *_Nonnull)response {
    double amount = [response deltaOfCoins];
    // Reward users accordingly.
}

- (void)didFailWithError:(OFWVirtualCurrencyErrorResponse *_Nonnull)errorResponse {
    // Something went wrong. Make sure the security token is correct.
}

Start the Offer Wall with a security token and delegate.

Objective-C

/* Class name updated (from 3.42.0): OFWVirtualCurrencyStartOptions - OFWVirtualCurrencySettings */
OFWVirtualCurrencySettings *vcSettings = [OFWVirtualCurrencySettings
    optionsWithSecurityToken:@"security_token"
    delegate:self];
      
[OfferWall startWithAppId:appId 
    delegate:self 
    virtualCurrencySettings:vcSettings 
    saltToken:saltToken 
    completion:^(OFWError * _Nullable error) {
    }];

The VirtualCurrencySettings object is not supported for Unity.

However, you will first need to pass a security token to the SDK start as well as set up the respective virtual currency delegates before you can request virtual currencies:

OfferWall.VirtualCurrencyResponseEvent += OnVirtualCurrencySuccess;
OfferWall.VirtualCurrencyErrorEvent += OnVirtualCurrencyError;

Where the events comply to the following delegates (in the same order)

public delegate void VirtualCurrencyResponseHandler(VirtualCurrencySuccessfulResponse response);
public delegate void VirtualCurrencyErrorHandler(VirtualCurrencyErrorResponse response);

OfferWall.StartSDK(appId: "appId", token: "secret_token");

Requesting Virtual Currency

Run the requestCurrency API to request Virtual Currency:

Kotlin

OfferWall.requestCurrency()

Java

OfferWall.requestCurrency();

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

Virtual Currency Options

The request may include the following additional configurations:

Specify the currency ID if using multiple currencies in your app.
Specify if the SDK should show a Toast notification of the virtual currency amount received (shown by default).

Kotlin

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

OfferWall.requestCurrency(options)

Java

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

Swift

let options = VirtualCurrencyRequestOptions(
    currencyId: "currency_id",
    toastOnReward: false
)

OfferWall.requestCurrency(withOptions: options)

Objective-C

OFWVirtualCurrencyRequestOptions *options = [OFWVirtualCurrencyRequestOptions
    optionsWithCurrencyId:@"currency_id"
    toastOnReward:NO];
        
[OfferWall requestCurrencyWithOptions:options];

Handling a 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 VirtualCurrencySuccessfulResponse object:

Kotlin

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

Java

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

Swift

func didReceive(_ response: VirtualCurrencyResponse) {
    let amount = response.deltaOfCoins
    let currencyId = response.currencyId
    let currencyName = response.currencyName
    // Reward users accordingly.
}

Objective-C

- (void)didReceiveResponse:(OFWVirtualCurrencyResponse *_Nonnull)response {
    double amount = [response deltaOfCoins];
    NSString *currencyId = [response currencyId];
    NSString *currencyName = [response currencyName];
    // Reward users accordingly.
}

public void OnVirtualCurrencySuccess(VirtualCurrencySuccessfulResponse response) {
    double amountReceived = response.DeltaOfCoins;
    string currencyId = response.CurrencyId;
    string currencyName = response.CurrencyName;
    // Reward users accordingly.
}

Virtual Currency Errors

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

Kotlin

override fun onVirtualCurrencyError(errResponse: VirtualCurrencyErrorResponse) {
    val currencyId = errResponse.currencyId
    val message = errResponse.serverErrorMessage
    val errorDetail = errResponse.error
    // Handle the error appropriately.    
}

Java

@Override
public void onVirtualCurrencyError(@NonNull VirtualCurrencyErrorResponse error) {
    String currencyId = error.getCurrencyId();
    String message = error.getServerErrorMessage();
    OfferWallError errorDetail = error.getError();
    // Handle the error appropriately.
}

Swift

func didFail(with errorResponse: VirtualCurrencyErrorResponse) {
    let currencyId = errorResponse.currencyId
    let message = errorResponse.serverErrorMessage
    let errorDetail = errorResponse.error
    // Handle the error appropriately.
}

Objective-C

- (void)didFailWithError:(OFWVirtualCurrencyErrorResponse *_Nonnull)errorResponse {
    NSString *currencyId = errorResponse.currencyId;
    NSString *message = errorResponse.serverErrorMessage;
    OFWError *errorDetail = errorResponse.error;
    // Handle the error appropriately.
}

public void OnVirtualCurrencyError(VirtualCurrencyErrorResponse errorResponse) {
    string currencyId = errorResponse.CurrencyId;
    string message = errorResponse.ServerErrorMessage;
    OfferWallError errorDetail = errorResponse.Error;
    // Handle the error appropriately.
}

Errors

The following table describes some of the possible errors that might occur when you show the Offer Wall or request virtual currency:

ERROR

DESCRIPTION

CONNECTION_ERROR

It can occur when either showing the Offer Wall or requesting virtual currency when the device is offline.

INVALID_VIRTUAL_CURRENCY_RESPONSE

If the virtual currency request is successful but not in the expected format, this may be a consequence of an integration mistake or a system problem. If this occurs, please contact an account manager or Solution Engineer.

INVALID_VIRTUAL_CURRENCY_RESPONSE_SIGNATURE

If the virtual currency response is incorrectly signed. This may indicate either an interference with the SDK<>backend communication (e.g., a man in the middle) or a system problem. Please contact an account manager or solution engineer if you detect this error in production.

VIRTUAL_CURRENCY_SERVER_RETURNED_ERROR

This typically indicates that the backend rejected the virtual currency request due to missing parameters or a wrong signature. Double-check your integration. If the problem persists, contact an account manager or Solution engineer.

DEVICE_NOT_SUPPORTED

Android Only: If you are trying to run the SDK on a device running Android OS lower than 4 (API 16 - Jelly Bean).

UNKNOWN_ERROR

The server returned an error that the SDK does not recognize.

Last updated 1 month ago

Good night

hashtagDT Offer Wall Sample App

hashtagBefore Starting the SDK

hashtagUser ID

hashtagPrivacy and Compliance

hashtagGDPR

hashtagCCPA

hashtagGoogle Play Families Ads Program

hashtagStarting the SDK

hashtagShowing the Offer Wall

hashtagShow Options

hashtagClose on Redirect

hashtagCustom Parameters (Server Side Rewarding)

hashtagShow With Placement ID

hashtagOffer Wall Lifecycle Callbacks

hashtagRewarding the User

hashtagVirtual Currency Settings

hashtagRequesting Virtual Currency

hashtagVirtual Currency Options

hashtagHandling a Virtual Currency Success Response

hashtagVirtual Currency Errors

hashtagErrors

DT Offer Wall Sample App

Before Starting the SDK

User ID

Privacy and Compliance

GDPR

CCPA

Google Play Families Ads Program

Starting the SDK

Showing the Offer Wall

Show Options

Close on Redirect

Custom Parameters (Server Side Rewarding)

Show With Placement ID

Offer Wall Lifecycle Callbacks

Rewarding the User

Virtual Currency Settings

Requesting Virtual Currency

Virtual Currency Options

Handling a Virtual Currency Success Response

Virtual Currency Errors

Errors