Smart Banner SDK initialization options

Set the following parameters to control the behavior of the Smart Banner SDK.

Required parameters

Set your app token

To initialize the Smart Banner SDK, call the AdjustSmartBanner.init method.

1
AdjustSmartBanner.init({
2
   appToken: "APP_TOKEN",
3
});

When you call this method, the SDK detects the device platform. If the device is a mobile platform, the SDK loads available smart banners. Available banners are displayed immediately after initialization.

If your project targets single-platform apps, pass each platform token as a key in the appToken object.

1
AdjustSmartBanner.init({
2
   appToken: {
3
      ios: "IOS_APP_TOKEN",
4
      android: "ANDROID_APP_TOKEN",
5
   },
6
});

Optional parameters

Set your log level

Configure the verbosity of logging performed by the SDK.

1
AdjustSmartBanner.init({
2
   logLevel: "verbose",
3
});

Set your banner locale

Set the language parameter to control which locale is used when displaying the banner.

1
AdjustSmartBanner.init({
2
   language: "fr",
3
});

Configure deep links

Configure deep links to specify where a user will land in your app when they interact with the smart banner.

Use the following parameters to control deep linking with your smart banners:

• context (Object): An object containing data to fill placeholders ({}) in the deep link path.
• androidDeepLinkPath (String): The location in the app to which the user is redirected on Android devices.
• iosDeepLinkPath (String): The location in the app to which the user is redirected on iOS devices.
• context (Object): An object containing values that are interpolated in the androidDeepLinkPath and iosDeepLinkPath paths.

Examples

In this example, the banner redirects iOS users to a deep link path at products/product=cool_jeans_123 by interpolating the item_id from the context object.

1
AdjustSmartBanner.init({
2
   // other initialisation parameters including mandatory ones
3
   iosDeepLinkPath: "products/product={item_id}",
4
   context: {
5
      item_id: "cool_jeans_123",
6
   },
7
});

In this example, the banner redirects Android users to a deep link path at products/product=cool_jeans_123 by interpolating the item_id from the context object.

1
AdjustSmartBanner.init({
2
   // other initialisation parameters including mandatory ones
3
   androidDeepLinkPath: "products/{item_id}",
4
   context: {
5
      item_id: "cool_jeans_123",
6
   },
7
});

In this example, the banner redirects both iOS users and Android users to a deep link path at products/product=cool_jeans_123 by interpolating the item_id from the context object.

1
AdjustSmartBanner.init({
2
   // other initialisation parameters including mandatory ones
3
   androidDeepLinkPath: "products/{item_id}",
4
   iosDeepLinkPath: "products/product={item_id}",
5
   context: {
6
      item_id: "cool_jeans_123",
7
   },
8
});

You can use the context object to define different context variables for different platforms. In this example:

• Android users are directed to promo/new_user.
• iOS users are directed to main/registrationFinished.
• The unused_variable is ignored.

1
AdjustSmartBanner.init({
2
   // other initialisation parameters including mandatory ones
3
   androidDeepLinkPath: "promo/{android_promo}",
4
   iosDeepLinkPath: "main/{ios_promo}",
5
   context: {
6
      android_promo: "new_user",
7
      ios_promo: "registrationFinished",
8
      unused_variable: "this will be ignored",
9
   },
10
});

Set the banner parent element

You can configure where a smart banner is located by specifying a parent element. By default, the banner is attached to document.body. You can override this by specifying an existing HTMLElement.

In this example, the smart banner is attached to an element with the ID root-for-banner.

1
const element = document.querySelector("#root-for-banner");
2

3
AdjustSmartBanner.init({
4
   bannerParent: element,
5
});

Run a function when the banner is created

Use the onCreated parameter to configure a function that runs as soon as the smart banner is created.

In this example, a log is output to the console when the banner is created.

1
AdjustSmartBanner.init({
2
   onCreated: () => console.log("Smart banner shown"),
3
});

Run a function when the banner is dismissed

Use the onDismissed parameter to configure a function that runs any time the smart banner is dismissed.

In this example, a log is output to the console when the banner is dismissed.

1
AdjustSmartBanner.init({
2
   onDismissed: () => console.log("Smart banner dismissed"),
3
});