Ad Platform Integration
This guide is for developers applying the integration. You don’t need it to operate the Admin.
When integrating the Shoplive Player with an ad platform, check the following to collect ad tracking information accurately.
1. Passing ad tracking information as query parameters
When users go from an ad platform to a Shoplive link, the URL contains various tracking information as a query string.
Example ad link:
https://shoplive.show/player.html?ak={ACCESS_KEY}&ck={CAMPAIGN_KEY}&utm_source=targetads&ad_id={ad_id}&bz_tracking_id={bz_tracking_id}&package_name={package_name}
Key parameter examples:
- bz_tracking_id
- ad_id
- package_name
- utm_source
- Other tracking parameters required by ad platforms
These parameters are essential for measuring ad performance and retargeting, so they must always be passed along when the Shoplive Player launches.
2. Web
The Shoplive Web Player automatically parses all query parameters in the current page URL.
- We recommend building the ad landing page so that it launches the Shoplive Player immediately.
- Check that the Shoplive Player launches directly from the link address users reach when they click the ad.
3. Hybrid apps (WebView-based apps)
In a hybrid app, when the Shoplive Web Player page opens in a WebView or in-app browser after an ad click, pass along all query parameters in the ad link as they are.
Example code (Javascript)
const url = new URL('YOUR_APP://shoplive-player');
const sp = new URLSearchParams(location.search);
for (const key of sp.keys()) {
url.searchParams.set(key, sp.get(key));
}
window.open(url); // or WebView.open(url.href)
4. Native apps using the Shoplive SDK
When a native app launches the player directly through the Shoplive SDK, pass the ad tracking parameters when initializing the SDK.
📎 For integration details, see LINK.
Android LINK
iOS LINK
Flutter LINK