Smart Banner SDK dynamic deep links

A deep link is a link that directs users to specific events or pages in your app. They offer a seamless experience by ensuring that users are directly routed to what they have seen in the smart banner. The Smart Banner SDK supports plain string dynamic deep links and deep link templates containing placeholders. Placeholders are filled by the SDK using provided deep link context or GET parameters of the web page URL.

There are two ways to configure a dynamic deep link in the Smart Banner SDK:

• Pass parameters to the AdjustSmartBanner.init function.
  • Provide context by configuring the context object.
• Call the setAndroidDeepLinkPath and setIosDeepLinkPath setters.
  • Provide context by calling the setContext setter
  • Provide context by using GET parameters

Configure your deep link path and context setters

Use these functions to configure your dynamic deep links and set dynamic context.

Set your deep link path

You must configure deep link paths for your target mobile platform using the setAndroidDeepLinkPath and setIosDeepLinkPath setter functions. These functions accept a string value that can be either an absolute path or a template path.

To set your deep link paths, call the AdjustSmartBanner.setIosDeepLinkPath and AdjustSmartBanner.setAndroidDeepLinkPath functions with the relevant paths to events or screens for each platform.

1
AdjustSmartBanner.setIosDeepLinkPath(
2
   "products/jeans/?product=cool-jeans&promo=spring_10",
3
);

The deep link path may contain any number of parameters enclosed in curly braces.

1
AdjustSmartBanner.setIosDeepLinkPath(
2
   "products/{category}/?product={product_id}&promo={promo}",
3
);

The Smart Banner SDK replaces these parameters with values from the context provided:

• In the init function
• By the setContext function
• From URL parameters

Set dynamic deep link context

You can add your dynamic deep link context by calling the AdjustSmartBanner.setContext function with an object containing key-value pairs of context values.

1
AdjustSmartBanner.setContext({
2
   category: "jeans",
3
   product_id: "cool-jeans",
4
   promo: "spring_10",
5
});

The Smart Banner SDK replaces any placeholder that matches a context key with the corresponding context value.

In this example, the resulting dynamic deep link path for iOS is products/jeans/?product=cool-jeans&promo=spring_10.

1
AdjustSmartBanner.setIosDeepLinkPath(
2
   "products/{category}/?product={product_id}&promo={promo}",
3
);
4
AdjustSmartBanner.setContext({
5
   category: "jeans",
6
   product_id: "cool-jeans",
7
   promo: "spring_10",
8
});

In this example, the resulting dynamic deep link path for Android is products/jeans/?product=&promo=.

1
AdjustSmartBanner.setAndroidDeepLinkPath(
2
   "products/{category}/?product={product_id}&promo={promo}",
3
);
4
AdjustSmartBanner.setContext({ category: "jeans" });

In this example, the second call to setContext overwrites the context from the first call. The resulting dynamic deep link path is products//?product_id=blue_jeans as a blank string is substituted for the non-matching {category} parameter.

1
AdjustSmartBanner.setIosDeepLinkPath(
2
   "products/{category}/?product={product_id}",
3
);
4
AdjustSmartBanner.setContext({ category: "jeans" });
5
AdjustSmartBanner.setContext({ product_id: "blue_jeans" });

In this example, the context is set correctly and the resulting dynamic deep link path is products/shoes/?product=red-sneakers.

1
AdjustSmartBanner.setIosDeepLinkPath(
2
   "products/{category}/?product={product_id}",
3
);
4
AdjustSmartBanner.setContext({
5
   category: "shoes",
6
   product_id: "red-sneakers",
7
});

Use GET parameters as context

If any of the parameters in your deep link path are missing in the context, the SDK will attempt to use parameters in the current page URL.

In the following example:

• The category parameter is filled out using the value provided in the setContext setter.
• The current page URL is https://my-shop.com/spring-promo?product_id=cool-jeans&promo=spring_10.

The SDK reads the values for product_id and promo from the page URL. The resulting dynamic deep link path is products/jeans/?product=cool-jeans&promo=spring_10.

1
AdjustSmartBanner.setAndroidDeepLinkPath(
2
   "products/{category}/?product={product_id}&promo={promo}",
3
);
4
AdjustSmartBanner.setContext({ category: "jeans" });

In the following example:

• The product_id parameter is set by the setContext setter.
• The current page URL is https://my-shop.com/spring-promo?product_id=cool-jeans&promo=spring_10.

Since the product_id value is set by the setContext setter, the value in the URL parameters is overridden. The resulting dynamic deep link path is products/jeans/?product=floral-jeans&promo=spring_10.

1
AdjustSmartBanner.setAndroidDeepLinkPath(
2
   "products/jeans/?product={product_id}&promo={promo}",
3
);
4
AdjustSmartBanner.setContext({ product_id: "floral-jeans" });