Install airbridge-expo-sdk and airbridge-react-native-sdk using npm.

npm install --save airbridge-expo-sdk
npm install --save airbridge-react-native-sdk

Attention

Airbridge Expo SDK does not support expo go environments. Please use it with expo prebuild or eas build.

Add following setting to your app.json file.

{
  "expo": {
    ...
    "plugins": [
      ...
      [
        "airbridge-expo-sdk",
        {
          "appName": "APP_NAME",
          "appToken": "APP_TOKEN"
        }
      ]
    ]
  }
}

Attention

APP_NAME can be found at the "Airbridge dashboard → Settings → Tokens → App Name". APP_TOKEN can be found at the "Airbridge dashboard → Settings → Tokens → App SDK Token".

1. Create an airbridge.jsonfile in the project folder.

2. Configure settings in JSON format.

{
    "sessionTimeoutSeconds": 300,
    "autoStartTrackingEnabled": true,
    "userInfoHashEnabled": true,
    "trackAirbridgeLinkOnly": false,
    "facebookDeferredAppLinkEnabled": false,
    "locationCollectionEnabled": false,
    "trackingAuthorizeTimeoutSeconds": 30,
    "sdkSignatureSecretID": "YOUR_SDK_SIGNATURE_SECRET_ID",
    "sdkSignatureSecret": "YOUR_SDK_SIGNATURE_SECRET",
    "logLevel": "warning"
}

Check if install events are sent when the application is installed and opened.

Events from the Airbridge SDK are shown at the "Airbridge Dashboard → Raw Data → App Real-time Logs".

1. Go to "Airbridge Dashboard → Raw Data → App Real-time Logs".

2. Search for the device's ADID (IDFA, IDFV, GAID).

Attention

Logs may be delayed for up to 5 minutes.

Please refer to the guides below to setup your deep links in the Airbridge dashboard.

• iOS Deep Link Dashboard Setup Guide

• Android Deep Link Dashboard Setup Guide

Add the following settings to your app.json file.

{
  "expo": {
    ...
    "scheme": "YOUR_SCHEME",
    "android": {
      ...
      "intentFilters": [{
        "autoVerify": true,
        "action": "VIEW",
        "data": { "scheme": "https", "host": "APP_NAME.airbridge.io" },
        "category": ["BROWSABLE", "DEFAULT"]
      }, {
        "autoVerify": true,
        "action": "VIEW",
        "data": { "scheme": "https", "host": "APP_NAME.deeplink.page" },
        "category": ["BROWSABLE", "DEFAULT"]
      }, {
        "autoVerify": true,
        "action": "VIEW",
        "data": { "scheme": "http", "host": "APP_NAME.airbridge.io" },
        "category": ["BROWSABLE", "DEFAULT"]
      }, {
        "autoVerify": true,
        "action": "VIEW",
        "data": { "scheme": "http", "host": "APP_NAME.deeplink.page" },
        "category": ["BROWSABLE", "DEFAULT"]
      }]
    },
    "ios": {
      ...
      "associatedDomains": [
        "applinks:APP_NAME.airbridge.io",
        "applinks:APP_NAME.deeplink.page"
      ]
    }
  }
}

YOUR_SCHEME can be found at the "Airbridge dashboard → Tracking Link → Deep Link → URI Scheme".

Register a function that will be called whenever a deep link or a deferred deep link opens the application.

import Airbridge from 'airbridge-react-native-sdk'

Airbridge.deeplink.setDeeplinkListener((deeplink) => {
    // code that will run when app is opened with deep-link or deferred-deep-link
    // deeplink = YOUR_SCHEME://...
    console.log(deeplink)
})

Attention

If you call setDeeplinkListener multiply, only last listener will receive deeplink.

Add the following settings to your app.json file.

{
  "expo": {
    ...
    "android": {
      ...
      "intentFilters": [{
        "autoVerify": true,
        "action": "VIEW",
        "data": { "scheme": "https", "host": "YOUR_DOMAIN.YOUR_DOMAIN.example" },
        "category": ["BROWSABLE", "DEFAULT"]
      }, {
        "autoVerify": true,
        "action": "VIEW",
        "data": { "scheme": "http", "host": "YOUR_DOMAIN.YOUR_DOMAIN.example" },
        "category": ["BROWSABLE", "DEFAULT"]
      }]
    },
    "ios": {
      ...
      "associatedDomains": [
        "applinks:YOUR_DOMAIN.YOUR_DOMAIN.example"
      ]
    },
    "plugins": [
      ...
      [
        "airbridge-expo-sdk",
        {
          ...
          "customDomains": [
            "YOUR_DOMAIN.YOUR_DOMAIN.example"
          ]
        }
      ]
    ]
  }
}

YOUR_DOMAIN.YOUR_DOMAIN.example can be found at the "Airbridge dashboard → Tracking Link → Domain Setting → Custom Domain".

Click on your URI scheme to test if your deep link has been properly set up in the Airbridge SDK.

• YOUR_SCHEME://

The results will show on the "Airbridge dashboard → Raw Data → App Real-time Log" tab if everything is working.

Please refer to this guide.

Please refer to this guide.

Please refer to this guide.

Protection against SDK spoofing is possible once you set your SDK Signature.
This feature is available for the Airbridge Expo SDK v2.2.0 and Airbridge React Native SDK v2.3.0 and above.

Add the following lines in the airbridge.json file.

{
    "sdkSignatureSecretID": "YOUR_SDK_SIGNATURE_SECRET_ID",
    "sdkSignatureSecret": "YOUR_SDK_SIGNATURE_SECRET"
}

The SDK Signature Credentials are required for the SDK Signature setup. Refer to this article to learn how to create them.

Please refer to this guide.

If you are already using the expo-route, it will not work after installing the SDK.

When entering the app through the Airbridge tracking link, the link you entered must be converted to a scheme deeplink through Airbridge and then routed. However, due to the expo-router, routing may be processed in the wrong direction such as duplication, wrong movement, etc.

Therefore, the Airbridge Expo SDK has been designed to route the Deeplink.

Please process it to route in the airbridge.deeplink.setDeeplinkListener as in the following code.

import * as Router from 'expo-router';

const router = Router.useRouter();

airbridge.deeplink.setDeeplinkListener((_deeplink) => {
  // route deeplink
  router.push(...);
});

If you use the Autofill feature in the App to save passwords, and if the webcredentials:... setting is not set, the password will be saved in the domain of applinks:YOUR_APP_NAME.airbridge.io or applinks:YOUR_APP_NAME.abr.ge.

If you want to change the domain where the password is saved, please replace example.com with the domain you want to set as shown below.

1. https://example.com/.well-known/apple-app-site-associationThe following content is hosted at the address.

   12345

   {
       "webcredentials": {
           "apps": ["TEAM_ID.APP_BUNDLE_ID"]
       }
   }

   예) 9JA89QQLNQ.com.apple.wwdc

2. Please add webcredentials:example.com to app.json.

   123456789

   {
     "expo": {
       "ios": {
         "associatedDomains": [
           "webcredentials:example.com"
         ]
       }
     }
   }

When updating the SDK, please consider the contents corresponding to the versions between `previous version` and `subsequent version`.

For Airbridge apps created after September 4, 2023, the issue where the deep link URL provided in the deep link callback decodes the content entered in the Airbridge dashboard twice has been resolved in versions v2.5.0 ~ v2.5.2.

For Airbridge apps created after September 4, 2023, the deep link URL provided in the deep link callback no longer adds the airbridge_referrer.

When updating the iOS app, it is determined by the last calculated SKAdNetwork Conversion Value and no additional calculations are made.

• In versions below 2.5.1, the SKAdNetwork Conversion Value is calculated for up to 24 hours only.

• This will not be a problem for new installs.

deeplink.page has been deprecated. From version 2.5.1, we recommend writing code using the deep link domain abr.ge

• deeplink.page is still supported and operates for backward compatibility.

The default value of "trackingAuthorizeTimeout" is changed to 30 seconds.

The event transmission API that existed in the previous version 1 is deleted and replaced with the following API.

/**
 * Send event to server.
 * @param {string} category event name
 * @param {EventOption} [option={}] event options
 */
trackEvent(category: string, option?: EventOption): void;

Please refer to the guide below.

• Migration guide

Please refer to the guide below.

• Migration guide