React Native SDK

﻿
Custom HTML
(Script tags will be stripped)
​x
 
​
<head>
  <link rel="alternate" hreflang="en" href="https://developers.airbridge.io/v1.1-en/docs/react-native-sdk" />
  <link rel="alternate" hreflang="ko" href="https://developers.airbridge.io/docs/react-native-sdk" />
</head>
## SDK Installation
﻿
xxxxxxxxxx
 
<hr/>
### Package Installation
#### npm
Install `airbridge-react-native-sdk` using npm.
﻿
xxxxxxxxxx
 
npm install --save airbridge-react-native-sdk
#### React-native link or cocoapods
Execute the following command.
﻿
xxxxxxxxxx
 
cd ios
pod install
﻿
### Project Setup
#### Import
Add the following code to the `index.js` file of the project to import the Airbridge SDK.
﻿
xxxxxxxxxx
 
import Airbridge from 'airbridge-react-native-sdk';
﻿
### Project Setup (Android)
#### MainApplication.java
Add the following code to the `onCreate` function within the `android/app/src/main/java/.../MainApplication.java` file.
﻿
xxxxxxxxxx
 
import co.ab180.airbridge.reactnative.AirbridgeRN;
​
//...
​
@Override
public void onCreate() {
    super.onCreate();
    AirbridgeRN.init(this, "YOUR_APP_NAME", "YOUR_APP_TOKEN");
    ...
}
`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"**.
﻿
### Project Setup (iOS)
#### `AppDelegate.m`
Add the following code to the import section of the `ios/[Project Name]/AppDelegate.m` file.
﻿
xxxxxxxxxx
 
#import <AirbridgeRN/AirbridgeRN.h>
﻿
Use a bridge header if you are using Swift.
Add the following code to the `application:idFinishLaunchingWithOptions:` function within the `ios/[Project Name]/AppDelegate.m` file.
﻿
xxxxxxxxxx
 
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AirbridgeRN getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];
    ...
}
`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"**.
﻿
### React Native Settings
#### `airbridge.json`
Create an `airbridge.json` file in the project folder.
Configure settings in JSON format.
When using React Native 0.59.X or lower with iOS, the below setup is needed for iOS.
Go to "Xcode → Project file → Build Phases → Copy Bundle Resources".
Click "+" and add airbridge.json file.
#### Example
﻿
xxxxxxxxxx
 
{
    "sessionTimeoutSeconds": 300,
    "autoStartTrackingEnabled": true,
    "userInfoHashEnabled": true,
    "trackAirbridgeLinkOnly": false,
    "facebookDeferredAppLinkEnabled": false,
    "locationCollectionEnabled": false,
    "trackingAuthorizeTimeoutSeconds": 30000,
    "sdkSignatureSecretID": "YOUR_SDK_SIGNATURE_SECRET_ID",
    "sdkSignatureSecret": "YOUR_SDK_SIGNATURE_SECRET",
    "logLevel": "warning"
}
﻿
`trackingAuthorizeTimeoutSeconds` in the above code is the default value. Please adjust accordingly depending on your user experience and ATT prompt settings. Please refer to [Tracking Authorize Timeout Settings](🔗﻿) for more details.
NameTypeDefaultDescription
sessionTimeoutSecondsNumber300An app open event will not be sent when the app is reopened within the designated period.
autoStartTrackingEnabledBooleantrueWhen set to false, no events will be sent until `Airbridge.state.startTracking()` is called.
userInfoHashEnabledBooleantrueWhen set to false, user email and user phone information are sent without being hashed.
trackAirbridgeLinkOnlyBooleanfalseWhen set to true, deep link events are sent only when app is opened with an Airbridge deep link.
facebookDeferredAppLinkEnabledBooleanfalseWhen set to true and the Facebook SDK is installed, Facebook Deferred App Link data is collected.
locationCollectionEnabledBooleanfalseWhen set to true, location information is collected. (Android Only)

Two permissions must be allowed in AndroidManifest.xml
android.permission.ACCESS_FINE_LOCATION
android.permission.ACCESS_COARSE_LOCATION
trackingAuthorizeTimeoutSecondsNumber0When timeout is set, Install event is delayed until `Request tracking authorization alert` is clicked. (iOS only)
sdkSignatureSecretIDStringnullProtects against SDK spoofing. Both sdkSignatureSecretID and sdkSignatureSecret values must be applied.
sdkSignatureSecretStringnullProtects against SDK spoofing. Both sdkSignatureSecretID and sdkSignatureSecret values must be applied.
logLevelStringWarningAdjusts the log record level for Airbridge.
logLevel: "debug" | "info" | "warning" | "error" | "fault"
﻿
### Testing the SDK
Check if install events are sent when the application is installed and opened.
#### Check in the Airbridge Dashboard
Events from the Airbridge SDK are shown at the "Airbridge Dashboard → Raw Data → App Real-time Logs".
Go to the "Airbridge Dashboard → Raw Data → App Real-time Logs".
Search for the device's ADID (IDFA, IDFV, GAID).
Logs may be delayed for up to 5 minutes.
<br><br>
## Deep Link Setup
﻿
xxxxxxxxxx
 
<hr/>
### Dashboard Setup
Please refer to the following guides for setting up deep links in the Airbridge dashboard.
﻿[Deep link setup for Android](🔗﻿)﻿
﻿[Deep link setup for iOS](🔗﻿)﻿
﻿
### Project Setup
#### setDeeplinkListener
Register a function that will be called whenever a deep link or a deferred deep link opens the application.
﻿
xxxxxxxxxx
 
Airbridge.deeplink.setDeeplinkListener((deeplink) => {
    // code that will run when a deep link or deferred deep link occurs
    // deeplink = YOUR_SCHEME://...
​
    console.log(deeplink);
});
All deep links that open apps are sent to `DeeplinkCallback`
Of those deep links, "Airbridge deep links" will be sent using the URI Scheme (`YOUR_SCHEME://...`) that was set in the Airbridge dashboard.
﻿
### Project Setup (Android)
#### AndroidManifest.xml
In the `MainActivity` section of the `android/app/src/main/AndroidManifest.xml` file, add `android:LaunchMode` and `intent-filter` parameters as below.
﻿
xxxxxxxxxx
<activity/>
 
<activity android:name=".MainActivity"
    android:launchMode="singleTask"
    ...>
    <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.deeplink.page" />
        <data android:scheme="https" android:host="YOUR_APP_NAME.deeplink.page" />
    </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>
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
​
        <category android:name="android.intent.category.DEFAULT" />
Enter your app name at `APP_NAME`.
Enter your scheme value set in the Airbridge dashboard at `YOUR_SCHEME`. (e.g. `abc://`)
#### MainActivity.java
Insert the following code in the `android/app/src/main/java/.../MainActivity.java` file.
﻿
xxxxxxxxxx
 
@Override
protected void onResume() {
    super.onResume();
​
    AirbridgeRN.processDeeplinkData(getIntent());
}
​
@Override
public void onNewIntent(Intent intent) {
    super.onNewIntent(intent);
    setIntent(intent);
}
﻿
### Project Setup (iOS)
#### Scheme
Go to "Xcode → Project file → Info → URL Types".
From the Airbridge dashboard, copy "iOS URI Scheme" to Xcode's "URL Schemes". (Do not include `://`)
﻿
#### Universal Link
Go to "Xcode → Project file → Signing & Capabilities".
Click "+ Capability" and add "Associated Domains".
Add `applinks:YOUR_APP_NAME.airbridge.io` to "Associated Domains".
Add `applinks:YOUR_APP_NAME.deeplink.page` to "Associated Domains".
`YOUR_APP_NAME` can be found at the "Airbridge dashboard → Settings → Tokens → App Name".
Please refer to [Troubleshooting → Webcredentials](🔗﻿) if you want to use the autofill feature.
#### Send Deep Link Information to SDK
Open `ios/[Project name]/AppDelegate`.
Send deeplink information to the SDK when the application is opened through schemes by calling the `handleURLSchemeDeeplink` method at the beginning of the following function.
﻿
xxxxxxxxxx
 
- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id>*)options
{
    NSLog(@"openURL : %@", url);
​
    [AirbridgeRN.deeplink handleURLSchemeDeeplink:url];
​
    return YES;
}
When targeting iOS 8.x or earlier, also call the `handleURLSchemeDeeplink` method at the beginning of the following function.
﻿
xxxxxxxxxx
 
- (BOOL)application:(UIApplication*)application
            openURL:(NSURL*)url
  sourceApplication:(NSString*)sourceApplication 
         annotation:(id)annotation
{
    NSLog(@"openURL : %@", url);
​
    [AirbridgeRN.deeplink handleURLSchemeDeeplink:url];
​
    return YES;
}
Send deep link information to the SDK when the application is opened through an universal link by calling the `handleUniversalLink` method at the beginning of the following function.
﻿
xxxxxxxxxx
 
-  (BOOL)application:(UIApplication*)application
continueUserActivity:(NSUserActivity*)userActivity
  restorationHandler:(void (^)(NSArray* _Nullable))restorationHandler
{
    NSLog(@"continueUserActivity : %@", userActivity.webpageURL);
​
    [AirbridgeRN.deeplink handleUniversalLink:userActivity.webpageURL];
​
    return YES;
}
﻿
### Custom Domain Setup (Optional)
Please refer to the below guides to setup your custom domain with Airbridge.
iOS: [Guide](🔗﻿)
Android: [Guide](🔗﻿)﻿
﻿
### Test Deep Link
Click on your URI scheme to test if your deep link has been properly set up in the Airbridge SDK.
`YOUR_APP_URI_SCHEME://`
The results will show on the "Airbridge dashboard → Row Data → App Real-time Log" tab if everything is working.
<br><br>
## User Setup
﻿
xxxxxxxxxx
 
<hr/>
### User Identifier Setup
Once a user identifier information is sent to the SDK, all events thereafter will contain the corresponding user identifier information.
NameDescriptionLimitations
IDUser ID-
emailUser EmailHashed by default
(SHA256, can be disabled)
phoneUser phone numberHashed by default
(SHA256, can be disabled)
attributesUser attributes- Maximum 100 attributes
- "key" type is string, maximum 128 characters
- "key" must satisfy `^[a-z_][a-z0-9_]*$` regex
- "value" type is primitive or string
- Maximum 1024 characters when "value" is string
aliasAnother User ID- Maximum 10 aliases
- `"key"` type is String, maximum 128 characters
- `"key"` must satisfy `^[a-z_][a-z0-9_]*$` regex
- \`"value" type is String, maximum 1024 characters
#### Example
﻿
xxxxxxxxxx
 
Airbridge.state.setUser({
    ID: 'personID1',
    email: 'persondoe1@airbridge.io',
});
​
Airbridge.state.setUser({
    email: 'persondoe2@airbridge.io',
    phone: '1(123)123-1234',
});
​
Airbridge.state.updateUser({
    ID: 'personID3',
});
The above code operates in the following order.
User = { ID: 'personID1', email: '[persondoe1@airbridge.io](🔗﻿)' }
User = { ID: 'personID1', email: '[persondoe1@airbridge.io](🔗﻿)', phone: '1(123)123-1234' }
User = { ID: 'personID3', email: '[persondoe2@airbridge.io](🔗﻿)', phone: '1(123)123-1234)' }
﻿
### User Attribute Setup
Additional user attributes can be set for various purposes such as MTA (Multi-Touch Attribution) analysis, internal data analysis and 3rd party solution integrations.
﻿
xxxxxxxxxx
 
Airbridge.state.updateUser({
    attributes: {
      age_group: "30",
      gender: "Female"
    }
});
﻿
### Testing
Make sure that your user information settings are being properly sent through the SDK.
Configure user identifier information.
Send an event using the SDK.
Click the event at "Airbridge dashboard → Raw Data → App Real-time Logs"
Check if the user information is correctly sent under the `user` block.
<br><br>
## Device Setup
﻿
xxxxxxxxxx
 
<hr/>
### Setup Device Alias
Setup a device alias through the Airbridge SDK. The alias will be sustained even after the app closes, unless otherwise deleted.
﻿
xxxxxxxxxx
 
Airbridge.setDeviceAlias("ADD_YOUR_KEY", "AND_YOUR_VALUE");
Airbridge.removeDeviceAlias("DELETE_THIS_KEY");
Airbridge.clearDeviceAlias();
﻿
﻿
`setDeviceAlias(key: string, value: string)`Add the key value pair to the device identifier.
`removeDeviceAlias(key: string)`Delete the corresponding device alias.
`clearDeviceAlias()`Delete all device aliases.
<br><br>
## Event Setup
﻿
xxxxxxxxxx
 
<hr/>
When important user actions occur, in-app events can be sent to measure the performance of each channel.
All event parameters are optional. However, more information about the event will help provide a more accurate analysis.
`action`, `label`, `value`, `customAttributes` and `semanticAttributes` can be used for event options.
﻿
xxxxxxxxxx
 
/**
 * Send event to server.
 * @param {string} category event name
 * @param {EventOption} [option={}] event options
 */
trackEvent(category: string, option?: EventOption): void;
﻿
### User Events
Send user events with the SDK.
`action`, `label`, `value`, `customAttributes` and `semanticAttributes` can be used for user events.
#### Sign Up
User identifiers are set with `setUser` and then sent with `AirbridgeCategory.SIGN_UP` for user sign ups.
﻿
xxxxxxxxxx
 
Airbridge.state.setUser({
    ID: 'personID1',
    email: 'persondoe@airbridge.io',
    phone: '1(123)123-1234',
});
Airbridge.trackEvent(AirbridgeCategory.SIGN_UP);
#### Sign In
User identifiers are set with `setUser` and then sent with `AirbridgeCategory.SIGN_IN` for user logins.
﻿
xxxxxxxxxx
 
Airbridge.state.setUser({
    ID: 'personID1',
    email: 'persondoe@airbridge.io',
    phone: '1(123)123-1234',
});
Airbridge.trackEvent(AirbridgeCategory.SIGN_IN);
#### Sign Out
 Send the sign out event with `AirbridgeCategory.SIGN_OUT`, and then reset the user identifiers with `Airbridge.state.setUser({})`.
﻿
xxxxxxxxxx
 
Airbridge.trackEvent(AirbridgeCategory.SIGN_OUT);
Airbridge.state.setUser({});
﻿
### E-commerce Events
#### Send e-commerce events with the SDK.
`action`, `label`, `value`, `customAttributes` and `semanticAttributes` can be used for e-commerce events.
It is possible to include product information using `semanticAttributes`. Custom key values can be used along with the pre-defined values.
#### View Home Screen
﻿
xxxxxxxxxx
 
Airbridge.trackEvent(AirbridgeCategory.HOME_VIEW);
#### View Product Detail
﻿
xxxxxxxxxx
 
Airbridge.trackEvent(AirbridgeCategory.PRODUCT_DETAILS_VIEW, {
    semanticAttributes: {
        [AirbridgeAttributes.PRODUCTS]: [
            {
                [AirbridgeProduct.PRODUCT_ID]: 'coke_zero',
                [AirbridgeProduct.NAME]: 'Coke Zero',
                [AirbridgeProduct.PRICE]: 1.99,
                [AirbridgeProduct.CURRENCY]: 'USD',
                [AirbridgeProduct.POSITION]: 1,
                [AirbridgeProduct.QUANTITY]: 1,
            },
        ]
    }
});
#### View Product List
﻿
xxxxxxxxxx
 
Airbridge.trackEvent(AirbridgeCategory.PRODUCT_LIST_VIEW, {
    semanticAttributes: {
        [AirbridgeAttributes.PRODUCT_LIST_ID]: 'ID-1234567890'
        [AirbridgeAttributes.PRODUCTS]: [
            {
                [AirbridgeProduct.PRODUCT_ID]: 'coke_zero',
                [AirbridgeProduct.NAME]: 'Coke Zero',
                [AirbridgeProduct.PRICE]: 1.99,
                [AirbridgeProduct.CURRENCY]: 'USD',
                [AirbridgeProduct.POSITION]: 1,
                [AirbridgeProduct.QUANTITY]: 1,
            },
            {
                [AirbridgeProduct.PRODUCT_ID]: 'burger_cheese_double',
                [AirbridgeProduct.NAME]: 'Double Cheeseburger',
                [AirbridgeProduct.PRICE]: 3.99,
                [AirbridgeProduct.CURRENCY]: 'USD',
                [AirbridgeProduct.POSITION]: 2,
                [AirbridgeProduct.QUANTITY]: 1,
            },
        ]
    }
});
#### View Search Result
﻿
xxxxxxxxxx
 
Airbridge.trackEvent(AirbridgeCategory.SEARCH_RESULT_VIEW, {
    semanticAttributes: {
        [AirbridgeAttributes.QUERY]: 'product'
        [AirbridgeAttributes.PRODUCTS]: [
            {
                [AirbridgeProduct.PRODUCT_ID]: 'coke_zero',
                [AirbridgeProduct.NAME]: 'Coke Zero',
                [AirbridgeProduct.PRICE]: 1.99,
                [AirbridgeProduct.CURRENCY]: 'USD',
                [AirbridgeProduct.POSITION]: 1,
                [AirbridgeProduct.QUANTITY]: 1,
            },
            {
                [AirbridgeProduct.PRODUCT_ID]: 'burger_cheese_double',
                [AirbridgeProduct.NAME]: 'Double Cheeseburger',
                [AirbridgeProduct.PRICE]: 3.99,
                [AirbridgeProduct.CURRENCY]: 'USD',
                [AirbridgeProduct.POSITION]: 2,
                [AirbridgeProduct.QUANTITY]: 1,
            },
        ]
    }
});
#### Add to cart
﻿
xxxxxxxxxx
 
Airbridge.trackEvent(AirbridgeCategory.ADD_TO_CART, {
    semanticAttributes: {
        [AirbridgeAttributes.CART_ID]: 'ID-1234567890',
        [AirbridgeAttributes.CURRENCY]: 'USD',
        [AirbridgeAttributes.TOTAL_VALUE]: 5.98,
        [AirbridgeAttributes.PRODUCTS]: [
            {
                [AirbridgeProduct.PRODUCT_ID]: 'coke_zero',
                [AirbridgeProduct.NAME]: 'Coke Zero',
                [AirbridgeProduct.PRICE]: 1.99,
                [AirbridgeProduct.CURRENCY]: 'USD',
                [AirbridgeProduct.POSITION]: 1,
                [AirbridgeProduct.QUANTITY]: 1,
            },
            {
                [AirbridgeProduct.PRODUCT_ID]: 'burger_cheese_double',
                [AirbridgeProduct.NAME]: 'Double Cheeseburger',
                [AirbridgeProduct.PRICE]: 3.99,
                [AirbridgeProduct.CURRENCY]: 'USD',
                [AirbridgeProduct.POSITION]: 2,
                [AirbridgeProduct.QUANTITY]: 1,
            },
        ]
    }
});
#### Purchase
﻿
xxxxxxxxxx
});
 
Airbridge.trackEvent(AirbridgeCategory.ORDER_COMPLETED, {
    semanticAttributes: {
        [AirbridgeAttributes.TRANSACTION_ID]: 'transactionID-purchase',
        [AirbridgeAttributes.CURRENCY]: 'USD',
        [AirbridgeAttributes.TOTAL_VALUE]: 5.98,
        [AirbridgeAttributes.IN_APP_PURCHASED]: true,
        [AirbridgeAttributes.PRODUCTS]: [
            {
                [AirbridgeProduct.PRODUCT_ID]: 'coke_zero',
                [AirbridgeProduct.NAME]: 'Coke Zero',
                [AirbridgeProduct.PRICE]: 1.99,
                [AirbridgeProduct.CURRENCY]: 'USD',
                [AirbridgeProduct.POSITION]: 1,
                [AirbridgeProduct.QUANTITY]: 1,
            },
            {
                [AirbridgeProduct.PRODUCT_ID]: 'burger_cheese_double',
                [AirbridgeProduct.NAME]: 'Double Cheeseburger',
                [AirbridgeProduct.PRICE]: 3.99,
                [AirbridgeProduct.CURRENCY]: 'USD',
                [AirbridgeProduct.POSITION]: 2,
                [AirbridgeProduct.QUANTITY]: 1,
            },
        ]
    }
﻿
### Verify Event Transmission
Make sure that the events are being properly sent through the SDK.
Send an event with the SDK.
Check if the event shows up at "Airbridge dashboard → Raw Data → Web Real-time Logs".
<br><br>
## Advanced Setup
﻿
xxxxxxxxxx
 
<hr/>
### SDK Signature Setup
Protection against SDK spoofing is possible once you set your SDK Signature.
This feature is available for the Airbridge React Native SDK v2.3.0 and above.
Add the following lines in the airbridge.json file.
﻿
xxxxxxxxxx
 
{
    "sdkSignatureSecretID": "YOUR_SDK_SIGNATURE_SECRET_ID",
    "sdkSignatureSecret": "YOUR_SDK_SIGNATURE_SECRET"
}
﻿
Please ask your CSM for the "SDK Signature Secret ID" and "SDK Signature Secret" values.
﻿
### Session Timeout
Configure the `sessionTimeoutSeconds` parameter of [airbridge.json](🔗﻿). App open events will not be sent again if the user re-opens the app within the `sessionTimeoutSeconds` value.
Session timeout is in milliseconds and must range between 0 and 604800000 (7 days).
Default value is 1000 _ 60 _ 5 (5 minutes).
﻿
### Hash User Indentifier
Email addresses and phone numbers are hashed by default. (SHA256)
You can stop hashing email and phone information by configuring the `userInfoHashEnabled` parameter of [airbridge.json](🔗﻿).
﻿
You must take appropriate measures internally when personal information is not hashed.
﻿
### Track Facebook Deferred App Links
The Airbridge SDK can track Facebook Deferred App Links by utilizing the `facebookDeferredAppLinkEnabled`  parameter of [airbridge.json](🔗﻿).
Install the Facebook SDK: <https://developers.facebook.com/docs/ios/getting-started>.
Set `facebookDeferredAppLinkEnabled` of [airbridge.json](🔗﻿) to `true`.
﻿
The Facebook SDK must be configured beforehand. [Reference](🔗﻿)﻿
﻿
### Track Airbridge Deep Links Only
The SDK will send all deep link events when the app is opened using a deep link.
If you're having difficulty tracking the re-engagement performance due to various deep link actions within the app, set `trackAirbridgeLinkOnly` of [Airbridge API Reference](🔗﻿) to true. The SDK will only send deep link events that use Airbridge deep links.
Airbridge deep links are defined as...
Deep links registered on the Airbridge dashboard
`airbridge.io` deep links
`deeplink.page` deep links
Contains the `airbridge_referrer` query information
﻿
### Privacy Protection (Opt-Out)
When `autoStartTrackingEnabled` of [airbridge.json](🔗﻿) is set to false, the Airbridge SDK will not send events to the Airbridge server until the `Airbridge.state.startTracking` method is called.
This feature is useful for compliances such as [GDPR](🔗﻿) and [CCPA](🔗﻿). 
﻿
### Tracking Authorize Timeout (iOS only)
When the [AppTrackingTransparency.framework](🔗﻿) is used to present an app-tracking authorization request to the user, IDFA will not be collected when the install event occurs because the install event occurs before the selection.
When `trackingAuthorizeTimeoutSeconds` of [airbridge.json](🔗﻿) is set to true, the install event will be sent after the `timeout` period or delayed until an ATT option is selected. 
﻿
### Location Tracking (Android Only)
Track a user's location through the `locationCollectionEnabled` parameter of the [airbridge.json](🔗﻿) file.
﻿
Location information must be collected for legal purposes only.
﻿
This function is available for Android only, and the following permissions must be allowed in `AndroidManifest.xml`.
`uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /`
`uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /`
### Tracking Link Execution
Use the code below to execute and track deep links in the app.
﻿
xxxxxxxxxx
 
Airbridge.placement.click('https://abr.ge/~~~', 'ablog://main', 'https://airbridge.io');
Airbridge.placement.impression('https://abr.ge/~~~');
#### `click`
The `click` function adds a "click" statistic to the corresponding tracking link, then moves to the pre-set app, web or fallback.
Call the `click` function when the tracking link is clicked on.
The deep link and fallback are "backup links" used when there is no Internet connection.
Deep link parameters are only available in Custom URL Scheme format.
(All these parameters are optional)
#### `impression`
The `impression` function adds an "impression" statistic to the corresponding tracking link.
Call the `impression` function when the tracking is displayed.
If you are using a "custom domain" for your tracking link, it can not be used with a "custom short ID".
example: `http://deeplink.customdomain.com/custom` -> Not possible
example: `http://deeplink.customdomain.co/autogenerated` -> Possible
example: `https://abr.ge/autogenerated` -> Possible
﻿
### Get deviceUUID
﻿
xxxxxxxxxx
 
await Airbridge.state.deviceUUID()
﻿
### Uninstall tracking
﻿
This feature is available only for React Native SDK v2.1.0+.
Airbridge Android SDK v2.6.0+
Airbridge iOS SDK v1.28.2+
Please refer to [this guide](🔗﻿) for details.
#### Send Push Token
﻿
xxxxxxxxxx
 
Airbridge.registerPushToken(token);
Forward the push token to Airbridge using the `registerPushToken` method.
Make sure the notification is not shown on the device if the remote message value is `airbridge-uninstall-tracking`.
<br><br>
## Hybrid App Setup
﻿
xxxxxxxxxx
 
<hr/>
Additional events such as app installs, app open and deep link opens can't be tracked with just the web SDK. The following simple setup allows in-app events to be called for a hybrid app.
﻿
xxxxxxxxxx
 
let webInterface = Airbridge.createWebInterface(
        'YOUR_WEB_TOKEN',
        (command) => { 
            return `...`;
        }
    )
`Airbridge.CreateWebInterface` allows you to control the web interface.
Please refer to the [React Native Hybird App Integration Guide](🔗﻿) for more information.
<br><br>
## Troubleshooting
﻿
xxxxxxxxxx
 
<hr/>
### Update 1.X.X → 2.X.X
The event API has been replaced to the below.
﻿
xxxxxxxxxx
 
/**
 * Send event to server.
 * @param {string} category event name
 * @param {EventOption} [option={}] event options
 */
trackEvent(category: string, option?: EventOption): void;
Refer to the [React native 2.X.X migration guide](🔗﻿) for details.
﻿
### Bitcode Compile Error
An error like below may occur when creating iOS builds with React Native SDK v1.5.0+.
﻿
xxxxxxxxxx
 
ld: XCFrameworkIntermediates/AirBridge/AirBridge.framework/AirBridge(AirBridge-arm64-master.o)' does not contain bitcode. You must rebuild it with bitcode enabled (Xcode setting ENABLE_BITCODE)
Since React Native SDK v1.5.0+ uses Airbridge iOS SDK v1.28.0+, Bitcode is no longer supported. Please refer to the [Bitcode compile error guide](🔗﻿) for more details.
﻿
### Update 1.1.X → 1.2.X
#### npm
Change version of Airbridge React Native SDK in `package.json`.
﻿
xxxxxxxxxx
 
...
    "airbridge-react-native-sdk": "1.2.1",
...
Execute the following command.
﻿
xxxxxxxxxx
 
npm install
cd ios
pod install
#### Android
Modify `android/app/src/main/java/.../MainActivity`
﻿
xxxxxxxxxx
 
-     AirbridgeRN.getDeeplink().fetch(getIntent())
+     AirbridgeRN.processDeeplinkData(getIntent())
#### iOS
Modify `ios/[Project Name]/AppDelegate`
﻿
xxxxxxxxxx
 
-     AirbridgeRN.deeplink()?.handleURLSchemeDeeplink(url, withSourceBundle: sourceApplication)
+     AirbridgeRN.deeplink()?.handleURLSchemeDeeplink(url)
#### Settings
Add an `airbridge.json` file to the project folder.
Add the parameters shown in the example below in JSON format.
﻿
xxxxxxxxxx
 
{
    "sessionTimeoutSeconds": 300,
    "autoStartTrackingEnabled": true,
    "userInfoHashEnabled": true,
    "trackAirbridgeLinkOnly": false,
    "facebookDeferredAppLinkEnabled": false,
    "locationCollectionEnabled": false
    "trackingAuthorizeTimeoutSeconds": 0
}
##### Description
NameTypeDefaultDescription
sessionTimeoutSecondsnumber300An app open event will not be sent when the app is reopened within the designated period.
autoStartTrackingEnabledbooleantrueWhen set to false, no events will be sent until `airbridge.state.startTracking()` is called.
userInfoHashEnabledbooleantrueWhen set to false, user email and user phone information are sent without being hashed.
trackAirbridgeLinkOnlybooleanfalseWhen set to true, deep link events are sent only when app is opened with an Airbridge deep link.
facebookDeferredAppLinkEnabledbooleanfalseWhen set to true and the Facebook SDK is installed, Facebook Deferred App Link data is collected.
locationCollectionEnabledbooleanfalseWhen set to true, location information is collected. (Android Only)

Two permissions must be allowed in `AndroidManifest.xml`
android.permission.ACCESS_FINE_LOCATION
android.permission.ACCESS_COARSE_LOCATION
trackingAuthorizeTimeoutSecondsnumber0When set timeout, Install event is delayed until Request tracking authorization alert is clicked. (iOS only)
﻿
### Update 1.0.X → 1.1.X
#### Installation
Uninstall the old version of the Airbridge SDK.
﻿
xxxxxxxxxx
 
npm uninstall react-native-airbridge-bridge
Install the new version of the Airbridge SDK.
﻿
xxxxxxxxxx
 
npm install --save airbridge-react-native-sdk
After Installation, execute the following command.
﻿
xxxxxxxxxx
 
cd ios
pod install
#### `setDeeplinkListener`
Remove the `getInitialDeeplink` function and use the `setDeeplinkListener` function only.
﻿
xxxxxxxxxx
 
- Airbridge.deeplink.getInitialDeeplink().then((deeplink) => {
-
- });
. 
. Airbridge.deeplink.setDeeplinkListner((deeplink) => {
. 
. });
#### Android
##### `AndroidManifest.xml`
In the `MainActivity` section of the `android/app/src/main/AndroidManifest.xml` file, add `intent-filter` parameters as below.
﻿
xxxxxxxxxx
. </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="APP_NAME.deeplink.page" />
+     <data android:scheme="https" android:host="APP_NAME.deeplink.page" />
+ </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="APP_NAME.airbridge.io" />
.     <data android:scheme="https" android:host="APP_NAME.airbridge.io" />
. </intent-filter>
. <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="EXAMPLE_SCHEME" />
##### `MainActivity.java`
Modify `android/app/src/main/java/.../MainActivity.java` as below.
﻿
xxxxxxxxxx
 
. import co.ab180.airbridge.reactnative.AirbridgeRN;
. 
. public class MainActivity extends ReactActivity {
+     @Override
+     protected void onResume() {
+         super.onResume();
+ 
+         AirbridgeRN.getDeeplink().fetch(getIntent());
+     }
+  
.     @Override
.     public void onNewIntent(Intent intent) {
.         super.onNewIntent(intent);
.         setIntent(intent);
.     }
. }
#### iOS
##### Universal Link
Go to "Xcode → Project file → Signing & Capabilities".
Click "+ Capability" and add "Associated Domains".
Add `applinks:YOUR_APP_NAME.deeplink.page` to "Associated Domains".
`YOUR_APP_NAME` can be found at the "Airbridge dashboard → Settings → Tokens → App Name".
##### AppDelegate.m\`
Modify `ios/.../AppDelegate.m` as below.
﻿
xxxxxxxxxx
 
. - (BOOL)application:(UIApplication *)application
.             openURL:(NSURL *)url
.             options:(NSDictionary<UIApplicationOpenURLOptionsKey, id>*)options
. {
-     [AirbridgeRN.instance handleURLSchemeDeeplink:url
-                                withSourceBundle:options[UIApplicationOpenURLOptionsSourceApplicationKey]];
+     [AirbridgeRN.deeplink handleURLSchemeDeeplink:url
+                                withSourceBundle:options[UIApplicationOpenURLOptionsSourceApplicationKey]];
. 
.     return YES;
. }
. 
. - (BOOL)application:(UIApplication*)application
.             openURL:(NSURL*)url
.   sourceApplication:(NSString*)sourceApplication 
.          annotation:(id)annotation
. {
-     [AirbridgeRN.instance handleURLSchemeDeeplink:url
-                                withSourceBundle:sourceApplication];
+     [AirbridgeRN.deeplink handleURLSchemeDeeplink:url
+                                withSourceBundle:sourceApplication];
. 
.     return YES;
. }
When targeting iOS 8.x or earlier, also make the following changes.
﻿
xxxxxxxxxx
 
. -  (BOOL)application:(UIApplication*)application
. continueUserActivity:(NSUserActivity*)userActivity
.   restorationHandler:(void (^)(NSArray* _Nullable))restorationHandler
. {
-     [AirbridgeRN.instance handleUniversalDeeplink:userActivity.webpageURL];
+     [AirbridgeRN.deeplink handleUniversalLink:userActivity.webpageURL];
. 
.     return YES;
. }
﻿
### Update 0.2.X → 1.X.X
#### Reinstalling the Airbridge SDK
Unlink the old version of the SDK.
﻿
xxxxxxxxxx
 
react-native unlink react-native-airbridge-bridge
Follow the steps below when an error occurs with `react-native unlink react-native-airbridge-bridge`
(Android) Modify `android/app/src/main/java/.../MainApplication.java` as below. 
﻿
xxxxxxxxxx
 
- import com.reactlibrary.AirbridgeBridgePackage;
﻿
xxxxxxxxxx
 
. @Override
. protected List<ReactPackage> getPackages() {
.     return Arrays.<ReactPackage>asList(
+         new MainReactPackage()
-         new MainReactPackage(),
-         new AirbridgeBridgePackage()
.     );
. }
(iOS) Open `ios/xxx.xcodeproj`. 
(iOS) Remove `AirbridgeBridge.xcodeproj` in `Libraries`
Uninstall the old version of the SDK.
﻿
xxxxxxxxxx
 
npm uninstall react-native-airbridge-bridge
Install the new version of the SDK.
﻿
xxxxxxxxxx
 
npm install --save airbridge-react-native-sdk
Link the new version of the SDK.
﻿
xxxxxxxxxx
 
react-native link airbridge-react-native-sdk
#### `index.js`
Modify `index.js` as below.
﻿
xxxxxxxxxx
 
- const Airbridge = require('react-native-airbridge-bridge');
+ import Airbridge from 'airbridge-react-native-sdk';
#### `build.gradle` (Android)
Modify `android/app/build.gradle` as below.
﻿
xxxxxxxxxx
 
. dependencies {
.     ...
-     implementation 'io.airbridge:sdk-android:1.5.+'
-     implementation 'com.android.installreferrer:installreferrer:1.0'
.     ...
. }
#### `AndroidManifest.xml` (Android)
Modify `android/app/src/main/AndroidManifest.xml` as below.
##### `permission` (Android)
﻿
xxxxxxxxxx
 
-     <uses-permission android:name="android.permission.INTERNET" />
-     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
##### `MainActivity`
﻿
xxxxxxxxxx
 
.     <activity android:name=".MainActivity"
          ...
+         android:launchMode="singleTask">
#### `MainApplication.java` (Android)
Modify `android/app/src/main/java/.../MainApplication.java` as below.
﻿
xxxxxxxxxx
 
- import io.airbridge.*;
﻿
xxxxxxxxxx
 
. @Override
. public void onCreate() {
.     super.onCreate();
-     AirBridge.init(this, "[APP_NAME]", "[APP_TOKEN]");
+     AirbridgeRN.init(this, "[APP_NAME]", "[APP_TOKEN]");
.     ...
. }
#### `MainActivity.java` (Android)
Modify `android/app/src/main/java/.../MainActivity.java` as below.
﻿
xxxxxxxxxx
 
+ import co.ab180.airbridge.reactnative.AirbridgeRN;
​
+ public class MainActivity extends ReactActivity {
+   @Override
+   public void onNewIntent(Intent intent) {
+       super.onNewIntent(intent);
+       setIntent(intent);
+   }
#### `Podfile` (iOS)
Modify `ios/Podfile` as below.
﻿
xxxxxxxxxx
 
target '[프로젝트 이름]' do
-   pod 'AirBridge', '1.6.2'
end
Run the command below in terminal.
﻿
xxxxxxxxxx
 
pod install
#### `AppDelegate.m` (iOS)
Modify `ios/.../AppDelegate.m` as below.
﻿
xxxxxxxxxx
 
- #import <AirBridge/AirBridge.h>
+ #import <AirbridgeRN/AirbridgeRN.h>
﻿
xxxxxxxxxx
 
.           - (BOOL)application:(UIApplication *)application 
. didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 
. {
-     [AirBridge getInstance:@"APP_TOKEN" appName:@"APP_NAME" withLaunchOptions:launchOptions];
+     [AirbridgeRN getInstance:@"APP_TOKEN" appName:@"APP_NAME" withLaunchOptions:launchOptions];
.     ...
. }
﻿
xxxxxxxxxx
 
. - (BOOL)application:(UIApplication *)application
.             openURL:(NSURL *)url
.             options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
. {
-     [[AirBridge instance] handleURL:url];
+     [AirbridgeRN.instance handleURLSchemeDeeplink:url withSourceBundle:options[UIApplicationOpenURLOptionsSourceApplicationKey]];.
.
.     return YES;
. }
﻿
xxxxxxxxxx
 
. - (BOOL)application:(UIApplication *)application 
.             openURL:(NSURL *)url
.   sourceApplication:(NSString *)sourceApplication 
.          annotation:(id)annotation
. {
-     [[AirBridge instance] handleURL:url];
+     [AirbridgeRN.instance handleURLSchemeDeeplink:url withSourceBundle:options[UIApplicationOpenURLOptionsSourceApplicationKey]];
. 
.     return YES;
. }
When targeting iOS 8.x or earlier, also make the following changes.
﻿
xxxxxxxxxx
 
.   - (BOOL)application:(UIApplication *)application 
.  continueUserActivity:(NSUserActivity *)userActivity
.    restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler
. {
-     [[AirBridge instance] handleURL:url];
+     [AirbridgeRN.instance handleUniversalDeeplink:userActivity.webpageURL];
. 
.     return YES;
. }
﻿
## SDK Installation

### Package Installation

#### npm

#### React-native link or cocoapods

### Project Setup

#### Import

### Project Setup (Android)

#### MainApplication.java

### Project Setup (iOS)

#### `AppDelegate.m`

🚧﻿

### React Native Settings

#### `airbridge.json`

#### Example

🚧﻿

### Testing the SDK

#### Check in the Airbridge Dashboard

## Deep Link Setup

### Dashboard Setup

### Project Setup

#### setDeeplinkListener

### Project Setup (Android)

#### AndroidManifest.xml

#### MainActivity.java

### Project Setup (iOS)

#### Scheme

#### Universal Link

#### Send Deep Link Information to SDK

### Custom Domain Setup (Optional)

### Test Deep Link

## User Setup

### User Identifier Setup

#### Example

### User Attribute Setup

### Testing

## Device Setup

### Setup Device Alias

## Event Setup

### User Events

#### Sign Up

#### Sign In

#### Sign Out

### E-commerce Events

#### Send e-commerce events with the SDK.

#### View Home Screen

#### View Product Detail

#### View Product List

#### View Search Result

#### Add to cart

#### Purchase

### Verify Event Transmission

## Advanced Setup

### SDK Signature Setup

📘﻿

### Session Timeout

### Hash User Indentifier

❗️﻿

### Track Facebook Deferred App Links

🚧﻿

### Track Airbridge Deep Links Only

### Privacy Protection (Opt-Out)

### Tracking Authorize Timeout (iOS only)

### Location Tracking (Android Only)

❗️﻿

❗️﻿

### Tracking Link Execution

#### `click`

#### `impression`

### Get deviceUUID

### Uninstall tracking

📘﻿

#### Send Push Token

## Hybrid App Setup

## Troubleshooting

### Update 1.X.X → 2.X.X

### Bitcode Compile Error

### Update 1.1.X → 1.2.X

#### npm

#### Android

#### iOS

#### ``AppDelegate.m``

#### ``airbridge.json``

#### ``click``

#### ``impression``

#### ``setDeeplinkListener``

##### ``AndroidManifest.xml``

##### ``MainActivity.java``

#### ``index.js``

#### ``build.gradle`` (Android)

#### ``AndroidManifest.xml`` (Android)

##### ``permission`` (Android)

##### ``MainActivity``

#### ``MainApplication.java`` (Android)

#### ``MainActivity.java`` (Android)

#### ``Podfile`` (iOS)

#### ``AppDelegate.m`` (iOS)
