Managing Client App Banners from PC Dashboard¶
Client App Banners are banners of Client’s IOS and/or Android apps to be downloaded within Pointr’s IOS and Android Mobile SDKs. They are also directly configurable to be displayed from Pointr Maps applications as well since these applications are wrappers around Pointr Mobile SDKs. PC Dashboard Client Configuration section can be used to configure Client’s IOS and Android Application banners to be displayed on Pointr Maps IOS and Android apps as well as the WebSDK Fallback application which is displayed on express links in case Pointr Maps Android app is not installed (for Android) or for users running IOS < 16 (for IOS).
Go to Advanced Configuration section of Client on PC Dashboard to enter the following configuration items (please refer to table below for detailed explanation of the items)
Configuration Items¶
Client App Banners shall look like the following image on Pointr Maps App, Pointr Maps AppClip and WebSDK Fallback on browsers:
The parts of the App banner is as follows:
- Promotion Text: Text displayed on the top of the banner for promoting the client app download to end users
- App Icon: Icon to be displayed for the client app (typically the same icon for the main client app on App Store)
- App Name: Name of the client app to be downloaded
- App Description: A short description for the client app to be downloaded
- Button Title: The text to display for downloading and opening the client app
Parameters required for Pointr IOS SDK and/or Pointr Maps IOS App (including App Clip) to display Client IOS App Banner¶
| Parameter Name | Description | Type | Default | Example Value |
|---|---|---|---|---|
| bannerConfiguration_iosShouldDisplayBanner | Whether to show client app banner for iOS. | boolean | false | true |
| bannerConfiguration_iosPromotionText | Promotional text for the client app banner for iOS | string | “” | “Get the full experience” |
| bannerConfiguration_iosAppIcon | Client app banner icon for iOS | string | “” | “https://pointrmapstorage.blob.core.windows.net/pointr-assets/products/pointrmaps/appBanner/appBannerIconImage.png” |
| bannerConfiguration_iosAppId | Client app id for iOS | string | “” | tech.pointr.express |
| bannerConfiguration_iosDeepLinkUrlScheme | Client app deep link URL scheme for iOS | string | “” | - |
| bannerConfiguration_iosAppName | Client app name for iOS | string | “” | Pointr Maps |
| bannerConfiguration_iosAppDescription | Client app description for iOS | string | “” | “Enjoy rich-maps and wayfinding with real-time positioning” |
| bannerConfiguration_iosButtonTitle | Client app banner button title for iOS | string | “” | “INSTALL” |
Note
The resource identified by iosDeepLinkUrlScheme may be local to the current app or it may be one that must be provided by a different app. iOS supports many common schemes, including the http, https, tel, facetime, and mailto schemes. Also custom URL schemes associated with apps installed on the device can be employed. If the specified URL scheme is handled by another app, iOS launches that app and passes the URL to it (Launching the app brings the other app to the foreground). For more information you can refer to this link.
Parameters required for Pointr Android SDK and/or Pointr Maps Android app to display Client Android App Banner¶
| Parameter Name | Description | Type | Default | Example Value |
|---|---|---|---|---|
| bannerConfiguration_androidShouldDisplayBanner | Whether to show client app banner for Android | boolean | false | true |
| bannerConfiguration_androidPromotionText | Promotional text for the client app banner for Android | string | “” | “Get the full experience” |
| bannerConfiguration_androidAppIcon | Client app banner icon for Android | string | “” | “https://pointrmapstorage.blob.core.windows.net/pointr-assets/products/pointrmaps/appBanner/appBannerIconImage.png” |
| bannerConfiguration_androidAppId | Client app id for Android | string | “” | tech.pointr.express |
| bannerConfiguration_androidDeepLinkUrlScheme | Client app deep link URL scheme for Android | string | “” | - |
| bannerConfiguration_androidAppName | Client app name for Android | string | “” | Pointr Maps |
| bannerConfiguration_androidAppDescription | Client app description for Android | string | “” | “Enjoy rich-maps and wayfinding with real-time positioning” |
| bannerConfiguration_androidButtonTitle | Client app banner button title in Android | string | “” | “INSTALL” |
How to find iosAppId and androidAppId?¶
iosAppId¶
- Go to App Store Connect.
- Go to “Apps”.
- Select your application.
- Go to “Distribution” tab.
- From left panel select “General” / “App Information”.
- Notice “Apple ID” under “General Information” section.
androidAppId¶
- Go to the Google Play Store, search the App and click on it.
- Check the part on the link after “id=”.
- For example: androidAppId in the example below is tech.pointr.express
Note
Deeplink for IOS and Android
Use Deeplink to redirect the users to a different App. For example: youtube://[deeplink]
Parameters required for WebSDK (Express Fallback Webapp) to display Client App Banner on IOS¶
| Parameter Name | Description | Type | Default | Example Value |
|---|---|---|---|---|
| bannerConfiguration_webIosShouldDisplayBanner | Whether to show web app banner for IOS | boolean | false | true |
| bannerConfiguration_webIosButtonTitle | Web app banner button title for iOS | string | “” | “INSTALL” |
| bannerConfiguration_webIosAppDescription | Web app description for iOS | string | “” | “Enjoy rich-maps and wayfinding with real-time positioning” |
| bannerConfiguration_webIosAppName | Web app name for iOS | string | “” | “Pointr Maps” |
| bannerConfiguration_webIosDownloadUrl | Web app download URL for iOS | string | “” | https://apps.apple.com/tr/app/pointr-maps/id6467269505 |
| bannerConfiguration_webIosAppIcon | Web app banner icon for iOS | string | “” | “https://pointrmapstorage.blob.core.windows.net/pointr-assets/products/pointrmaps/appBanner/appBannerIconImage.png” |
| bannerConfiguration_webIosPromotionText | Promotional text for the web app banner for iOS | string | “” | “Get the full experience” |
Parameters required for WebSDK (Express Fallback Webapp) to display Client App Banner on Android¶
| Parameter Name | Description | Type | Default | Example Value |
|---|---|---|---|---|
| bannerConfiguration_webAndroidShouldDisplayBanner | Whether to show web app banner for Android | boolean | false | true |
| bannerConfiguration_webAndroidPromotionText | Promotional text for the web app banner for Android | string | “” | “Get the full experience” |
| bannerConfiguration_webAndroidAppIcon | Web app banner icon for Android | string | “” | “https://pointrmapstorage.blob.core.windows.net/pointr-assets/products/pointrmaps/appBanner/appBannerIconImage.png” |
| bannerConfiguration_webAndroidDownloadUrl | Web app download URL for Android | string | “” | “https://play.google.com/store/apps/details?id=tech.pointr.express&hl=en&gl=US” |
| bannerConfiguration_webAndroidAppName | Web app name for Android | string | “” | “Pointr Maps” |
| bannerConfiguration_webAndroidAppDescription | Web app description for Android | string | “” | “Enjoy rich-maps and wayfinding with real-time positioning” |
| bannerConfiguration_webAndroidButtonTitle | Web app banner button title for Android | string | “” | “INSTALL” |
| bannerConfiguration_isBluedotEnabled | Displays a pop-up on Express Fallback Web App (Android) to redirect users to the App for experiencing blue-dot | boolean | false | true |
Warning
- If the “DisplayBanner” parameter is set to “false,” the banner will not be displayed at all.
- Activation of the banner requires the completion of all parameters, all fields are mandatory.
Parameters required for WebSDK (Express Fallback Webapp) to display Pointr Maps Android App banner on Android (i.e. Client App = Pointr Maps Android App)¶
| Parameter Name | Description | Type | Example Value |
|---|---|---|---|
| bannerConfiguration_webAndroidShouldDisplayBanner | Whether to show web app banner for Android | boolean | true |
| bannerConfiguration_webAndroidPromotionText | Promotional text for the web app banner for Android | string | “Get the full experience” |
| bannerConfiguration_webAndroidAppIcon | Web app banner icon for Android | string | “https://pointrmapstorage.blob.core.windows.net/pointr-assets/products/pointrmaps/appBanner/appBannerIconImage.png” |
| bannerConfiguration_webAndroidDownloadUrl | Web app download URL for Android | string | “https://play.google.com/store/apps/details?id=tech.pointr.express&hl=en&gl=US” |
| bannerConfiguration_webAndroidAppName | Web app name for Android | string | “Pointr Maps” |
| bannerConfiguration_webAndroidAppDescription | Web app description for Android | string | “Enjoy rich-maps and wayfinding with real-time positioning” |
| bannerConfiguration_webAndroidButtonTitle | Web app banner button title for Android | string | “INSTALL” |
| bannerConfiguration_isBluedotEnabled | Displays a pop-up on Express Fallback Web App (Android) to redirect users to the App for experiencing blue-dot | boolean | true |
Last update: August 21, 2024