Skip to main content

deeplinking.bfgDeepLinkListener Interface

This class provides games with a callback for receiving deep link information. More...

Public Member Functions

void onDeepLinkReceived (@Nullable String deepLink, @Nullable Map< String, String > conversionData, @Nullable String error)
 Callback method invoked when a deep link, deferred deep link or an error is received. More...
 

Detailed Description

This class provides games with a callback for receiving deep link information. The listener needs to be set before initializing the BFG SDK to ensure deep links aren't lost on app launch. Deep links from all BFG SDK supported providers that have been enabled and registered URI schemes will trigger the listener. For more information on deep linking see the Deep Linking documentation: https://developer.bigfishgames.com/android_v6_9_html/reference_deep_linking.html#implementDDL
Since
6.9.1

Member Function Documentation

◆ onDeepLinkReceived()

void com.bigfishgames.bfglib.deeplinking.bfgDeepLinkListener.onDeepLinkReceived (@Nullable String deepLink,
@Nullable Map< String, String > conversionData,
@Nullable String error 
)
Callback method invoked when a deep link, deferred deep link or an error is received. The "deepLink" parameter should contain the actual deep link that needs to be acted upon, while the "conversionData" dictionary will contain other information (such as the deep link's source). In the event that the deep link is coming from a Facebook campaign the "deepLink" parameter will be null and the "conversionData" dictionary will need to be inspected for a key of "is_fb" and a value of "true", in which case the deep link need to be retrieved from the conversion data.This callback method will also be invoked on first launch of the game to report installation attribution. The deepLink parameter will be null and the conversionData collection will include a key of "af_status" and a value of "Organic" or "Non-organic", indicating whether the first launch resulted from a paid or organic install.For more information on deep links and expected payloads, see: https://support.appsflyer.com/hc/en-us/categories/201132293-Attribution-and-deep-linking or https://support.appsflyer.com/hc/en-us/articles/360000726098-Conversion-data-use-scenarios#introduction
Parameters
deepLinkDeep link string, null if an error occurred or if the deep link was delivered via Facebook.
conversionDataUnfiltered conversion data from the provider, null if no additional info is supplied by the provider.
errorError message, null if deep link received successfully
Since
6.9.1