Requesting Paywalls

Instructions for displaying a paywall via Deepwall SDKs

You can raise a paywall in your app using Deepwall SDK without the need for UI development or the need for storing product codes or prices on the client app.

Before starting to display a paywall, you need to activate a display on the Deepwall management console.

If you have not activated your displays yet, please refer to the guide for displaying paywalls:

pageDisplaying Paywalls

Request Paywall

After you have initialized and configured the SDK with user properties, you are ready to request a paywall anywhere in your app.

Use the request paywall method to raise a paywall in your app and send the action key.

Swift

// SomeUIViewController.swift

DeepWall.shared.requestPaywall(action: "{ACTION_KEY}", in: self)

Kotlin

DeepWall.showPaywall(
  activity = this,
  action = “{ACTION_KEY}”,
  orientation = PaywallOrientation.PORTRAIT
)

React Native

DeepWall.getInstance().requestPaywall('{ACTION_KEY}');

Flutter

DeepwallFlutterPlugin.requestPaywall(​'{ACTION_KEY}'​, null​);

Cordova

cordova.DeepwallCordovaPlugin.requestPaywall('{ACTION_KEY}',{}, function(response){
    console.log(response);
}, function(error){
    console.log(error);
});

Unity

string actionKey = "{ACTION_KEY}"; //Your ActionKey is here 
DeepWall.RequestPaywall(actionKey, null);

/* You can send extra parameter if needed as below: */
DeepWall.RequestPaywall(actionKey, "{\"sliderIndex\": 2, \"title\": \"Deepwall\"}"); 

Replace {ACTION_KEY} with one of the action keys created in the Deepwall management console for your app.

In-app Action Key

In-app actions in Deepwall are the checkpoints where you want to raise a paywall in your app which can be a startup action if you want to raise a paywall after the app launch or it can be an action triggered to unlock premium content. The number of in-app actions depends on the app.

You need to replace {ACTION_KEY} with one of your app-specific action keys created in the Deepwall management console while you are requesting a paywall. You can get those keys from the Deepwall management console, from the App Settings page on the App Settings tab. You can also add new in-app actions anytime you need.

Don't forget to activate default displays for the newly added in-app actions after you have added new in-app actions.

Sending Extra Data

Depending on the theme used, some paywalls can receive extra parameters from the app layer and can display/hide some data or actions for users. Extra data is used for sending parameters in such cases.

Swift

// SomeUIViewController.swift

let deepwallExtraData: DeepWallExtraDataType = [
    "some": "value"
]
DeepWall.shared.requestPaywall(action: "{ACTION_KEY}", in: self, extraData: deepwallExtraData)

Kotlin

val extraDataBundle = Bundle()
extraDataBundle.putString(“Name”, example.name)
extraDataBundle.putInt(“Id”, example.id)

DeepWall.showPaywall(
activity = this,
action = “{ACTION_KEY}”,
extraData = bundle
)

React Native

DeepWall.getInstance().requestPaywall('{ACTION_KEY}');

// You can send extra parameter if needed as below:
DeepwallFlutterPlugin.requestPaywall(​'{ACTION_KEY}'​, {'sliderIndex': 2, 'title': 'Deepwall'});

Flutter

// or you can send extra parameters as:
Map​<​String​, ​Object​> extraData = ​new​ HashMap(); userProperties[​'key'​] = ​'Value'​;
DeepwallFlutterPlugin.requestPaywall(​'{ACTION_KEY}'​, extraData);

Unity

/* You can send extra parameter if needed as below: */
DeepWall.RequestPaywall(actionKey, "{\"sliderIndex\": 2, \"title\": \"Deepwall\"}");

Using Paywall Display Events

The Deepwall SDK triggers various events while displaying paywalls, which gives you the ability to take the necessary actions in your app workflow.

Event for Paywall Requests

iOS Event	Android Event
deepwallPaywallRequested Parameters : N/A	PAYWALL_REQUESTED Parameters : N/A

Deepwall sends the deepwallPaywallRequested event for iOS and PAYWALL_REQUESTEDevent for Android whenever a paywall is requested.

We recommend you use this event to start displaying a loading indicator while the paywall is opening which can take 1-1,5 secs or more depending on the connection speed.

Event for Paywall Response Receive

iOS Event	Android Event
deepwallPaywallResponseReceived Parameters : N/A	PAYWALL_RESPONSE_RECEIVED Parameters : N/A

Deepwall sends the deepwallPaywallResponseReceived event for iOS and PAYWALL_RESPONSE_RECEIVED event for Android whenever a paywall display success or failure response is received after a paywall request.

We recommend you to use this event for hiding the loading indicator if you have started to display it when a paywall is requested.

Event for Paywall Open

iOS Event	Android Event
deepwallPaywallOpened Parameters : pageId: Int	PAYWALL_OPENED Parameters : PaywallOpenedInfo pageId: Int

Deepwall sends the deepwallPaywallOpenedevent for iOS and PAYWALL_OPENED event for Android whenever a paywall is opened successfully.

Event for Disabled Paywall Display

iOS Event	Android Event
deepwallPaywallActionShowDisabled Parameters : pageId: Int	DO_NOT_SHOW Parameters : PaywallActionShowDisabledInfo pageId: Int

Deepwall sends the deepwallPaywallActionShowDisabledevent for iOS and DO_NOT_SHOW event for Android whenever a paywall cannot be displayed due to display rules or paywall display is set as None in the Deepwall management console.

None selection means you don't want to display a paywall for the selected action and/or display type. If this is not you want, you need to check related display settings and set a paywall to display for first or next displays.

A paywall may not be displayed due to enabled display rules and paywall display frequency or maximum display count limitation.

See the guide for more information about display rules :

pageDisplay Rules

Events for Duplicated Paywall Requests

iOS Event	Android Event
deepwallPaywallNotOpened Parameters : pageId: Int	PAYWALL_NOT_OPENED Parameters : N/A

Deepwall sends the deepwallPaywallNotOpenedevent for iOS and PAYWALL_NOT_OPENED event for Android whenever a paywall cannot be displayed due to duplicated requests which means this paywall request has been sent while a previous request is being processed.

Important Note

If this event is triggered, you should check your code and rearrange it so that it will not send a second paywall request before a response is received for the previous request.

Event for Paywall Response Failure

iOS Event	Android Event
deepwallPaywallResponseFailure Parameters : errorCode: String reason: String	PAYWALL_RESPONSE_FAILURE Parameters : PaywallFailureResponse errorCode: String reason: String

Deepwall sends the deepwallPaywallResponseFailureevent for iOS and PAYWALL_RESPONSE_FAILURE event for Android whenever a paywall display has failed due to an error.

The Deepwall SDK provides error codes and reasons to help you locate and eliminate issues.

Error Code	Description
10101	Server response is invalid
10102	Products empty
10201	Gzip data is invalid
10202	String data is invalid
10203	Available products empty
10204	Available products invalid

You can check out the following guide to learn about listening to all the SDK events and parameters:

pageListening SDK Events

You can also check out the following guide for troubleshooting the most common errors while setting up the in-app purchases and Deepwall SDK:

pageTroubleshooting