Skip to content

Latest commit

 

History

History
207 lines (162 loc) · 8.03 KB

DeepLink.md

File metadata and controls

207 lines (162 loc) · 8.03 KB
Raw

Deep linking

alt text

The 3 Deep Linking Types:

Since users may or may not have the mobile app installed, there are 2 types of deep linking:

  1. Deferred Deep Linking (Legacy APIs) - Serving personalized content to new or former users, directly after the installation. -
  2. Direct Deep Linking (Legacy APIs) - Directly serving personalized content to existing users, which already have the mobile app installed.
  3. Unified deep linking - Unified deep linking sends new and existing users to a specific in-app activity as soon as the app is opened.

For more info about Deferred Deep Linking please check out the OneLink™ Deferred deep linking Guide.
For more info about Direct Deep linking please check out the OneLink™ Direct Deep Linking Guide.
For more info about Unified Deep Linking please check out the OneLink™ Direct Deep Linking Guide.

❗️Important!

  • Deferred deep linking using the legacy method of onConversionDataSuccess may not work for iOS 14.5+, since it requires attribution data that may not be available due to privacy protection. We recommend using unified deep linking (UDL). UDL conforms to the iOS 14.5+ privacy standards and only returns parameters relevant to deep linking and deferred deep linking: deep_link_value and deep_link_sub1. Attribution parameters (such as media_source, campaign, af_sub1-5, etc.), return null and can’t be used for deep linking purposes.

1. Deferred Deep Linking (Get Conversion Data) - Legacy APIs

Check out the deferred deeplinkg guide from the AppFlyer knowledge base here

Code Sample to handle the conversion data:

  constructor(public platform: Platform) {
    this.platform.ready().then(() => {
.....
.....
      this.setConversions();
      AppsFlyer.initSDK(options).then(res => alert(JSON.stringify(res))).catch(e =>alert(e));
    });
  }
	
  // set a listener
  setConversions() {
    AppsFlyer.addListener(AFConstants.CONVERSION_CALLBACK, event => {
      alert('CONVERSION_CALLBACK ~~>' + JSON.stringify(event));
      if (event.callbackName === AFConstants.onConversionDataSuccess){
        if(event.data.af_status === 'Non-organic' ){
          if(event.data.is_first_launch === true ){
              const deepLinkValue = event.data.deep_link_value;
              this.handleLink(deepLinkValue);
          }
        }
      }
    });
  }

2. Direct Deeplinking (onAppOpenAttribution) Legacy APIs

In order to implement deeplink with AppsFlyer, you must call register the listener before initSDK
For more information on deeplinks, please read here

  constructor(public platform: Platform) {
    this.platform.ready().then(() => {
.....
.....
      this.setOAOA();
      AppsFlyer.initSDK(options).then(res => alert(JSON.stringify(res))).catch(e =>alert(e));
    });
  }
  
  // set a listener
  setOAOA() {
    AppsFlyer.addListener(AFConstants.OAOA_CALLBACK, res => {
      alert('OAOA_CALLBACK ~~>' + JSON.stringify(event));
      if(res.callbackName === AFConstants.onAppOpenAttribution){
        const deepLinkValue = res.data.deep_link_value;
        this.handleLink(deepLinkValue);
      }else{
        console.log(res.errorMessage);
      }
    });
  }

3. Unified deep linking

In order to use the unified deep link you need to send the registerOnDeepLink: true flag inside the object that sent to the sdk.
NOTE: when sending this flag, the sdk will ignore onAppOpenAttribution!
For more information about this api, please check OneLink Guide Here

  constructor(public platform: Platform) {
    this.platform.ready().then(() => {
.....
.....
      this.setUDL();
      AppsFlyer.initSDK(options).then(res => alert(JSON.stringify(res))).catch(e =>alert(e));
    });
  }
  
  // set a listener
  setUDL() {
    AppsFlyer.addListener(AFConstants.UDL_CALLBACK, res => {
      alert('UDL_CALLBACK ~~>' + JSON.stringify(res));
      if (res.status === 'FOUND') {
        const deepLinkValue = res.deepLink.deep_link_value;
        this.handleLink(deepLinkValue);
      } else if (res.status === 'ERROR') {
        console.log('udl error: ' + res.error);
      }
    });
  }

Note: The code implementation for onDeepLink must be made prior to the initialization code of the SDK.

Android Deeplink Setup

URI Scheme

Please follow the instructions here
In your app’s manifest add the following intent-filter to your relevant activity:

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="your unique scheme" />
</intent-filter>

App Links

Please follow the instructions here
In your app’s manifest add the following intent-filter to your relevant activity:

<intent-filter android:autoVerify="true">
    <action android:name="android.intent.action.VIEW" />

    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data
        android:host="onelink-basic-app.onelink.me"
        android:pathPrefix="/H5hv"
        android:scheme="https" />
</intent-filter>

iOS Deeplink Setup

The plugin consumes the deep link from Capacitor's notification. Do not delete or override the auto-generated code in AppDelegate.swift

URI Scheme

For more on URI-schemes check out the guide here

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<array>
	<dict>
		<key>CFBundleTypeRole</key>
		<string>None</string>
		<key>CFBundleURLName</key>
		<string>YOUR_Bundle_ID</string>
		<key>CFBundleURLSchemes</key>
		<array>
			<string>scheme1</string>
			<string>scheme2</string>
		</array>
	</dict>
</array>
</plist>

Universal Links

For more on Universal Links check out the guide here.

Essentially, the Universal Links method links between an iOS mobile app and an associate website/domain, such as AppsFlyer’s OneLink domain (xxx.onelink.me). To do so, it is required to:

  1. Configure OneLink sub-domain and link to mobile app (by hosting the ‘apple-app-site-association’ file - AppsFlyer takes care of this part in the onelink setup on your dashboard)
  2. Configure the mobile app to register approved domains:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>com.apple.developer.associated-domains</key>
        <array>
            <string>applinks:test.onelink.me</string>
        </array>
    </dict>
</plist>