DeepLink Plan - Flutter SDK (v4)

2024年11月13日に最終更新

Install the Airbridge Flutter SDK and implement the necessary settings following the steps below.

Install SDK

The Airbridge React Native SDK can be installed using the method below. After installation, you can verify whether the SDK has been properly installed through .

1. Add the following code to the dependencies block in the pubspec.yaml file.

123
dependencies:
  # Get the latest version from https://pub.dev/packages/airbridge_flutter_sdk/versions
  airbridge_flutter_sdk: HERE_LATEST_VERSION

2. Open Terminal at the root directory of the project and run the following command.

Note that the Airbridge Flutter SDK only works for Flutter versions 1.20.0 or later and Dart versions 2.12.0 or later.

Shell

1
flutter pub get

Install Restricted SDK

Attention
Install only one version of the SDK, either the general SDK or the restricted SDK.

Depending on policies and environments, restrictions on collecting device IDs like GAID and IDFA may be required. When installing the Restricted SDK version, the device IDs are not collected.

Install the Restricted SDK using the method below.

1. Add the following code to the dependencies block in the pubspec.yaml file.

123
dependencies:
  # Get the latest version from https://pub.dev/packages/airbridge_flutter_sdk_restricted/versions
  airbridge_flutter_sdk_restricted: HERE_LATEST_VERSION

2. Open Terminal at the root directory of the project and run the following command.

Shell

1
flutter pub get

Initialize SDK

The initialization methods for iOS and Android are different. Refer to the methods described below.

Note that the YOUR_APP_NAME and YOUR_APP_SDK_TOKEN can be found on the [Settings]>[Tokens] page in the Airbridge dashboard.

iOS

Add the following code to the AppDelegate class file in the iOS module of the project.

12345678
import airbridge_flutter_sdk

override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    AirbridgeFlutter.initializeSDK(appName: "YOUR_APP_NAME", appToken: "YOUR_APP_SDK_TOKEN")
}

12345
#import <airbridge_flutter_sdk/AirbridgeFlutter.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AirbridgeFlutter initializeSDKWithAppName:@"YOUR_APP_NAME" appToken:@"YOUR_APP_SDK_TOKEN"];
}

Android

If an application class is not defined in the Android module of the project, create one.

Add the following code to the android/app/src/main/java/.../MainApplication.kt file.

123456789
import co.ab180.airbridge.flutter.AirbridgeFlutter
import io.flutter.app.FlutterApplication

class MainApplication: FlutterApplication() {
    override fun onCreate() {
        super.onCreate()
        AirbridgeFlutter.initializeSDK(this, "YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
    }
}

12345678910
import co.ab180.airbridge.flutter.AirbridgeFlutter;
import io.flutter.app.FlutterApplication;

public class MainApplication extends FlutterApplication {
    @Override
    public void onCreate() {
        super.onCreate();
        AirbridgeFlutter.initializeSDK(this, "YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN");
    }
}

Register the application class created earlier in the AndroidManifest.xml file of the Android module of the project as follows.

12345
<application
    android:name=".MainApplication"
    ...>
    ...
</application>

Deep Linking

Deep linking allows you to redirect users from ads to specific locations within your app. The data collected from the tracking link enables you to monitor the performance of the deep link in Airbridge.

How Airbridge deep links work

When Airbridge generates a tracking link, it automatically selects and utilizes the optimal Airbridge deep link, depending on the environment.

Example)

Airbridge Deeplink: https://YOUR_APP_NAME.airbridge.io/~~~
Scheme Deeplink: YOUR_SCHEME://product/12345

When the app is installed on a device and the user clicks the tracking link, the app opens through the Airbridge deep link. The Airbridge SDK converts the Airbridge deep link into a scheme deep link set on the tracking link. The converted scheme deep link is sent to the app.

When the app is not installed on a device and the user clicks the tracking link, the Airbridge deep link is saved. After the user moves to the app store or website and the app is installed and launched, the Airbridge SDK converts the saved Airbridge deep link into a scheme deep link. The converted scheme deep link is sent to the app.

Set up deep linking

For the deep linking setup, the deep link information entered to the Airbridge dashboard and the in-app location address for user redirection is required.

First, enter the deep link information into the Airbridge dashboard.

For the deep linking setup, the following information must be entered into the Airbridge dashboard.

iOS

iOS URI scheme: The Airbridge deep link is converted to a scheme deep link using the iOS URI scheme.
iOS App ID: The universal link domain of the Airbridge deep link is set using the iOS App ID.

Android

Android URI scheme: The Airbridge deep link is converted to a schema deep link using the Android URI scheme. This information is necessary for the App Link and URI scheme.
Package name: This is the Android app identifier necessary for the App Link and URI scheme.
Android sha256_cert_fingerprints: This is used for setting the App Link domain. This information is necessary for the App Link.

Attention
To properly redirect users as intended, submit different information for the production app and the development app.

Follow the steps below to enter the above information into the Airbridge dashboard.

iOS

1. Go to [Tracking Link]>[Deep Links] in the Airbridge dashboard.

2. Enter the iOS URI scheme in the iOS URI Scheme field. Include ://. For example, if the iOS URI scheme is demo, you enter it as demo://.

3. In the Apple Developer Dashboard, go to [Identifier] of the app you want to set up the deep link. Find the App ID Prefix and Bundle ID.

4. The iOS App ID is in the format of App ID Prefix+ .+ Bundle ID. Enter the iOS App ID into the iOS App ID field. For example, if the App ID Prefix is prefix and the Bundle ID is example, the iOS App ID is prefix.example.

Android

1. Go to [Tracking Link]>[Deep Links] in the Airbridge dashboard.

2. Enter the Android URI scheme into the Android URI Scheme field. Include ://. For example, if the URI scheme is demo, you must enter it as demo://.

3. Enter the package name in the Package name field.

4. You need to find the sha256_cert_fingerprints. Run the following command from the keystore file you are deploying.

1
keytool -list -v -keystore YOUR_KEYSTORE.keystore

Find the SHA256 value in the results. The SHA256 value is the sha256_cert_fingerprints.

1234
Certificate fingerprints:
    MD5:  4C:65:04:52:F0:3F:F8:65:08:D3:71:86:FC:EF:C3:49
    SHA1: C8:BF:B7:B8:94:EA:5D:9D:38:59:FE:99:63:ED:47:B2:D9:5A:4E:CC
    SHA256: B5:EF:4D:F9:DC:95:E6:9B:F3:9A:5E:E9:D6:E0:D8:F6:7B:AB:79:C8:78:67:34:D9:A7:01:AB:6A:86:01:0E:99

5. Enter the SHA256 value into the sha256_cert_fingerprints field.

After entering the deep link information into the Airbridge dashboard, an additional setup is required to enable the following.

App launch with Airbridge deep links
Airbridge deep link event collection
User redirection with Airbridge deep links

For detailed instructions, refer to the information below.

Configure the app to launch with an Airbridge deep link when the user clicks on a tracking link.

iOS

1. To set up the scheme deep link to your app, go to [YOUR_PROJECT]>[Info]>[URL Types] in Xcode.

2. Click + and enter the iOS URI scheme you submitted in the Airbridge dashboard in the URL Schemes field.

Attention
When entering the iOS URL scheme, exclude ://.

3. To set up the universal link to your app, go to [YOUR_PROJECT]>[Signing & Capabilities] in Xcode.

4. Click + Capability to add Associated Domains.

5. Add applinks:YOUR_APP_NAME.airbridge.io and applinks:YOUR_APP_NAME.abr.ge to Associated Domains.

YOUR_APP_NAME is the Airbridge app name.

Attention
If you are using or plan to use the Password AutoFill feature, you must add the Webcredentials domain. A situation may arise where the domain of the password saved through the Password AutoFill feature appears as airbridge.io or abr.ge to your app users.
Refer to thisarticle for more details.

Android

1. To set up the scheme deep link to your app, add an intent filter to the Activity that handles deep links in the AndroidManifest.xml.

The intent filter you add must use the Android URI Scheme you entered into the Airbridge dashboard.

123456789101112
<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_SCHEME" />
    </intent-filter>
    ...
</activity>

Attention
When entering the Android URI Scheme, exclude ://.

2. To set up the App Links to your app, add an intent filter under the Activity that handles the deep link in the AndroidManifest.xml.

YOUR_APP_NAME is the Airbridge app name.

12345678910111213141516171819202122
<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:scheme="http" android:host="YOUR_APP_NAME.abr.ge" />
        <data android:scheme="https" android:host="YOUR_APP_NAME.abr.ge" />
    </intent-filter>
    <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:scheme="http" android:host="YOUR_APP_NAME.airbridge.io" />
        <data android:scheme="https" android:host="YOUR_APP_NAME.airbridge.io" />
    </intent-filter>
    ...
</activity>

Pass deep link events to the Airbridge SDK for collection. Call the Airbridge.trackDeeplink function at the top of the OS callback that is called when the app is opened with a deep link.

iOS

Please add the following code to the ios/YOUR_PROJECT_NAME/AppDelegate.m file.

1234567891011121314151617
#import <airbridge_flutter_sdk/AirbridgeFlutter.h>
...
// when app is opened with scheme deeplink
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    // track deeplink
    [AirbridgeFlutter trackDeeplinkWithUrl:url];

    return YES;
}
...
// when app is opened with universal links
- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler {
    // track deeplink
    [AirbridgeFlutter trackDeeplinkWithUserActivity:userActivity];

    return YES;
}

12345678910111213141516171819202122232425
import airbridge_flutter_sdk
...
// when app is opened with scheme deeplink
func application(
    _ app: UIApplication,
    open url: URL,
    options: [UIApplication.OpenURLOptionsKey : Any] = [:]
) -> Bool {
    // track deeplink
    AirbridgeFlutter.trackDeeplink(url: url)

    return true
}
...
// when app is opened with universal links
func application(
    _ application: UIApplication,
    continue userActivity: NSUserActivity,
    restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void
) -> Bool {
    // track deeplink
    AirbridgeFlutter.trackDeeplink(userActivity: userActivity)

    return true
}

Android

Please add the following code to the android/app/src/main/java/.../MainApplication.kt file.

1234567891011
import co.ab180.airbridge.flutter.AirbridgeFlutter
...
override fun onResume() {
    super.onResume()
    AirbridgeFlutter.trackDeeplink(intent)
}
...
override fun onNewIntent(intent: Intent?) {
    super.onNewIntent(intent)
    setIntent(intent)
}

12345678910111213
import co.ab180.airbridge.flutter.AirbridgeFlutter;
...
@Override
protected void onResume() {
    super.onResume();
    AirbridgeFlutter.trackDeeplink(intent);
}
...
@Override
public void onNewIntent(Intent intent) {
    super.onNewIntent(intent);
    setIntent(intent);
}

When the Airbridge deeplink is executed, it is converted into a scheme deeplink and passed on to the OnDeeplinkReceived callback. And if a deeplink that is not an Airbridge deeplink is executed, it is delivered to the callback without conversion.

Utilize the received deeplink to send the user to the set destination.

123
Airbridge.setOnDeeplinkReceived((deeplink) {
    // show proper content using url
});

If you only need to receive the Airbridge Deeplink, you can only receive the Airbridge Deeplink through a callback by setting isHandleAirbridgeDeeplinkOnly to true in Configure SDK. For more information, please refer to the section on receiving only the Airbridge Deeplink

Set up deferred deep linking

When a user clicks on a tracking link with deferred deep linking capabilities and your app is not installed on the device, the Airbridge SDK retrieves the deep link as follows.

Deferred deep links are automatically passed to OnDeeplinkReceived, so no additional setup is required.

Testing

The SDK functionality test and deep link test allow you to check whether the SDK and deep linking work as intended.

このページは役に立ちましたか？

ご質問やご提案はありますか？

DeepLink Plan - Flutter SDK (v4)

Install SDK

Install Restricted SDK

Attention

Initialize SDK

iOS

Android

Deep Linking

How Airbridge deep links work

Set up deep linking

Enter the deep link information into Airbridge dashboard

iOS

Android

Attention

iOS

Android

Enable app launch with Airbridge deep links

iOS

Attention

Attention

Android

Attention

Collecting deep link events in the app

iOS

Android

Redirect the user through the collected Airbridge Deeplink

Set up deferred deep linking

How the Airbridge SDK retrieves deferred deep links

Testing

DeepLink Plan - Flutter SDK (v4)self.__wrap_n!=1&&self.__wrap_b(":R29jtt7ppjtsba:",0.5)

Install SDK

Install Restricted SDK

Attention

Initialize SDK

iOS

Android

Deep Linking

How Airbridge deep links work

Set up deep linking

Enter the deep link information into Airbridge dashboard

iOS

Android

Attention

iOS

Android

Enable app launch with Airbridge deep links

iOS

Attention

Attention

Android

Attention

Collecting deep link events in the app

iOS

Android

Redirect the user through the collected Airbridge Deeplink

Set up deferred deep linking

How the Airbridge SDK retrieves deferred deep links

Testing

DeepLink Plan - Flutter SDK (v4)