Fetch legacy Paywall Builder paywalls in Android SDK

After you designed the visual part for your paywall with Paywall Builder in the Adapty Dashboard, you can display it in your Android app. The first step in this process is to get the paywall associated with the placement and its view configuration as described below.

warning

This guide is for legacy Paywall Builder paywalls only which require SDK v2.x or earlier. The process for fetching paywalls differs for paywalls designed with different versions of Paywall Builder and remote config paywalls.

• For fetching New Paywall Builder paywalls, check out Fetch new Paywall Builder paywalls and their configuration.
• For fetching Remote config paywalls, see Fetch paywalls and products for remote config paywalls.

Before you start displaying paywalls in your Android app (click to expand)

1. Create your products in the Adapty Dashboard.
2. Create a paywall and incorporate the products into it in the Adapty Dashboard.
3. Create placements and incorporate your paywall into it in the Adapty Dashboard.
4. Install Adapty SDK and AdaptyUI DSK in your Android app.

Fetch paywall designed with Paywall Builder

If you've designed a paywall using the Paywall Builder, you don't need to worry about rendering it in your Android app code to display it to the user. Such a paywall contains both what should be shown within the paywall and how it should be shown. Nevertheless, you need to get its ID via the placement, its view configuration, and then present it in your Android app.

To ensure optimal performance, it's crucial to retrieve the paywall and its view configuration as early as possible, allowing sufficient time for images to download before presenting them to the user.

To get a paywall, use the getPaywall method:

import com.adapty.utils.seconds

...

Adapty.getPaywall("YOUR_PLACEMENT_ID", locale = "en", loadTimeout = 10.seconds) { result ->
    when (result) {
        is AdaptyResult.Success -> {
            val paywall = result.value
            // the requested paywall
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}

For Java:

import com.adapty.utils.TimeInterval;

...

Adapty.getPaywall("YOUR_PLACEMENT_ID", "en", TimeInterval.seconds(10), result -> {
    if (result instanceof AdaptyResult.Success) {
        AdaptyPaywall paywall = ((AdaptyResult.Success<AdaptyPaywall>) result).getValue();
        // the requested paywall
      
    } else if (result instanceof AdaptyResult.Error) {
        AdaptyError error = ((AdaptyResult.Error) result).getError();
        // handle the error
      
    }
});

Parameter	Presence	Description
placementId	required	The identifier of the desired Placement. This is the value you specified when creating a placement in the Adapty Dashboard.
locale	optional default: en	The identifier of the paywall localization. This parameter is expected to be a language code composed of one or two subtags separated by the minus (-) character. The first subtag is for the language, the second one is for the region. Example: en means English, pt-br represents the Brazilian Portuguese language. See Localizations and locale codes for more information on locale codes and how we recommend using them.
loadTimeout	default: 5 sec	This value limits the timeout for this method. If the timeout is reached, cached data or local fallback will be returned. Note that in rare cases this method can timeout slightly later than specified in loadTimeout, since the operation may consist of different requests under the hood. For Android: You can create TimeInterval with extension functions (like 5.seconds, where .seconds is from import com.adapty.utils.seconds), or TimeInterval.seconds(5). To set no limitation, use TimeInterval.INFINITE.

Don't hardcode product IDs! Since paywalls are configured remotely, the available products, the number of products, and special offers (such as free trials) can change over time. Make sure your code handles these scenarios.
For example, if you initially retrieve 2 products, your app should display those 2 products. However, if you later retrieve 3 products, your app should display all 3 without requiring any code changes. The only thing you should hardcode is the placement ID.

Response parameters:

Parameter	Description
Paywall	An AdaptyPaywall object with a list of product IDs, the paywall identifier, remote config, and several other properties.

Fetch the view configuration of paywall designed using Paywall Builder

After fetching the paywall, check if it includes a viewConfiguration, which indicates that it was created using Paywall Builder. This will guide you on how to display the paywall. If the viewConfiguration is present, treat it as a Paywall Builder paywall; if not, handle it as a remote config paywall.

Use the getViewConfiguration method to load the view configuration.

if (!paywall.hasViewConfiguration) {
    // use your custom logic
    return
}

AdaptyUI.getViewConfiguration(paywall) { result ->
    when(result) {
        is AdaptyResult.Success -> {
            val viewConfiguration = result.value
            // use loaded configuration
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}