Airbridge

https://help.airbridge.io/ko
Admin
Airbridge is a mobile measurement partner (MMP) and deep linking solution that helps marketers...
Tokens:624,373
Snippets:6,089
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Encrypted Install Referrer Example

Source: https://help.airbridge.io/ko/guides/meta-business-google-play-install-referrer

This snippet shows an example of an encrypted install referrer, including UTM content, source data, and nonce. This format is typically seen before decryption.

```json
{
 referrer = {
 utm_content: {
 source: {
 "data": "afe56cf6228c6ea8c79da49186e718e92a579824596ae1d0d4d20d7793dca797bd4034ccf467bfae5c79a3981e7a2968c41949237e2b2db678c1c3d39c9ae564c5cafd52f2b77a3dc77bf1bae063114d0283b97417487207735da31ddc1531d5645a9c3e602c195a0ebf69c272aa5fda3a2d781cb47e117310164715a54c7a5a032740584e2789a7b4e596034c16425139a77e507c492b629c848573c714a03a2e7d25b9459b95842332b460f3682d19c35dbc7d53e3a51e0497ff6a6cbb367e760debc4194ae097498108df7b95eac2fa9bac4320077b510be3b7b823248bfe02ae501d9fe4ba179c7de6733c92bf89d523df9e31238ef497b9db719484cbab7531dbf6c5ea5a8087f95d59f5e4f89050e0f1dc03e464168ad76a64cca64b79",
 "nonce": "b7203c6a6fb633d16e9cf5c1"
 },
 ...
 }
}
```

--------------------------------

### Include User Data in Install/Open Events (Swift)

Source: https://help.airbridge.io/ko/developers/ios-sdk-v4

Ensure user data is included in install and open events by disabling auto-tracking, setting user data, and then explicitly starting tracking. This requires opt-in setup.

```Swift
// 1. initialize SDK. Opt-in setup
let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_SDK_TOKEN")
    .setAutoStartTrackingEnabled(false)
    .build()
Airbridge.initializeSDK(option: option)

// 2. Set up user data
Airbridge.setUserID("testID")
Airbridge.setUserEmail("testID@ab180.co")

// 3. Explicitly start tracking
Airbridge.startTracking()
```

--------------------------------

### Include User Data in Install/Open Events (Objective-C)

Source: https://help.airbridge.io/ko/developers/ios-sdk-v4

Ensure user data is included in install and open events by disabling auto-tracking, setting user data, and then explicitly starting tracking. This requires opt-in setup.

```Objective-C
// 1. initialize SDK. Opt-in setup
AirbridgeOptionBuilder* optionBuilder = [[AirbridgeOptionBuilder alloc] initWithName:@"YOUR_APP_NAME"
                                                                               token:@"YOUR_APP_SDK_TOKEN"];
[optionBuilder setAutoStartTrackingEnabled:NO];
AirbridgeOption* option = [optionBuilder build];
[Airbridge initializeSDKWithOption:option];

// 2. Set up user data
[Airbridge setUserID:@"testID"];
[Airbridge setUserEmail:@"testID@ab180.co"];

// 3. Explicitly start tracking
[Airbridge startTracking];
```

--------------------------------

### Install Web SDK

Source: https://help.airbridge.io/ko/developers/sdk-quickstart

Instructions for installing the Airbridge Web SDK using script, npm, yarn, or pnpm.

```APIDOC
## Install Web SDK

### Description
Install the Airbridge Web SDK using various package managers or a script tag.

### Installation Methods

#### Script Tag
Add the following to your `<head>` tag:
```html
<script>
(function(a_,i_,r_,_b,_r,_i,_d,_g,_e){if(!a_[_b]){var n=function(){var c=i_.createElement(r_);c.onerror=function(){g.queue.filter(function(a){return 0<=_d.indexOf(a[0])}).forEach(function(a){a=a[1];a=a[a.length-1];"function"===typeof a&&a("error occur when load airbridge")})};c.async=1;c.src=_r;"complete"===i_.readyState?i_.head.appendChild(c):a_.addEventListener("load",function h(){a_.removeEventListener("load",h);i_.head.appendChild(c)})
},g={queue:[],get isSDKEnabled(){return!1}};
_i.concat(_d).forEach(function(c){var a=c.split("."),h=a.pop();a.reduce(function(p,q){return p[q]=p[q]||{}},g)[h]=function(){g.queue.push([c,arguments])}});a_[_b]=g;0<_g?(_b=new (a_.XDomainRequest||a_.XMLHttpRequest),_i=function(){},_b.open("GET",_r),_b.timeout=_g,_b.onload=function(){n()},_b.onerror=_i,_b.onprogress=_i,_b.ontimeout=_i,_b.send()):n()}})(window,document,"script","airbridge","//static.airbridge.io/sdk/latest/airbridge.min.js","init startTracking stopTracking fetchResource openBanner setBanner setDownload setDownloads openDeeplink setDeeplinks sendWeb setUserAgent setMobileAppData setUserID clearUserID setUserEmail clearUserEmail setUserPhone clearUserPhone setUserAttribute removeUserAttribute clearUserAttributes setUserAlias removeUserAlias clearUserAlias clearUser setUserId setUserAttributes addUserAlias setDeviceAlias removeDeviceAlias clearDeviceAlias setDeviceIFV setDeviceIFA setDeviceGAID events.send events.signIn events.signUp events.signOut events.purchased events.addedToCart events.productDetailsViewEvent events.homeViewEvent events.productListViewEvent events.searchResultViewEvent".split(" "),["events.wait","createTouchpoint"],0);
</script>
```

#### npm
```bash
npm install airbridge-web-sdk-loader
```

#### yarn
```bash
yarn add airbridge-web-sdk-loader
```

#### pnpm
```bash
pnpm install airbridge-web-sdk-loader
```

After installation via npm, yarn, or pnpm, import `airbridge` as follows:
```javascript
import airbridge from 'airbridge-web-sdk-loader'
```
```

--------------------------------

### Decrypted Install Referrer Example

Source: https://help.airbridge.io/ko/guides/meta-business-google-play-install-referrer

This snippet demonstrates a decrypted install referrer, showing details like account ID, ad ID, and campaign information. This data is obtained after applying the Meta Ads decryption key.

```json
{
    "account_id": 988056874045064, 
    "ad_id": 59263050382376798, 
    "ad_objective_name": "APP_INSTALLS",
    "adgroup_id": 63244591281507997,
    "adgroup_name": "discount_banner",
    "campaign_group_id": 47071347859859780,
    "campaign_group_name": "install_summer_promotion",
    "campaign_id": 20683163274650358,
    "campaign_name": "aos_female",
    "is_instagram": true,
    "publisher_platform": "instagram"
}

```

--------------------------------

### Install Airbridge Web SDK via pnpm

Source: https://help.airbridge.io/ko/developers/sdk-quickstart

Install the Airbridge web SDK using pnpm for integration into your project.

```bash
pnpm install airbridge-web-sdk-loader
```

--------------------------------

### Initialize iOS SDK (Swift)

Source: https://help.airbridge.io/ko/developers/cordova-sdk-v4

Add this code to the `application:didFinishLaunchingWithOptions:` function in your `AppDelegate.m` file for iOS. Replace YOUR_APP_NAME and YOUR_APP_TOKEN with your actual values.

```swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    AirbridgeCordova.initializeSDK(name:"YOUR_APP_NAME", token:"YOUR_APP_TOKEN")
    ...
}
```

--------------------------------

### Initialize iOS SDK (Objective-C)

Source: https://help.airbridge.io/ko/developers/cordova-sdk-v4

Add this code to the `application:didFinishLaunchingWithOptions:` function in your `AppDelegate.m` file for iOS. Replace YOUR_APP_NAME and YOUR_APP_TOKEN with your actual values.

```objective-c
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AirbridgeCordova initializeSDKWithName:@"YOUR_APP_NAME" token:@"YOUR_APP_TOKEN"];
    ...
}
```

--------------------------------

### Complete WebView Initialization with Airbridge Handling (Java)

Source: https://help.airbridge.io/ko/developers/open-link-in-webview-deprecated-android-sdk-v2

This snippet demonstrates the complete Java implementation for setting up a WebView, including enabling JavaScript and DOM storage, and configuring the `WebViewClient` to correctly intercept and handle Airbridge tracking links.

```java
@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout....);

    webView = findViewById(R.id....);
    initWebView();
}

private void initWebView() {
    webView.getSettings().setJavaScriptEnabled(true);
    webView.getSettings().setDomStorageEnabled(true);
    webView.setWebViewClient(webViewClient);
}

private final WebViewClient webViewClient = new WebViewClient() {
    @Override
    public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
        Uri uri = request == null ? null : request.getUrl();
        if (uri != null) {
            String host = uri.getHost();

            List<String> airbridgeHosts = Arrays.asList(
                    "abr.ge",
                    "YOUR_APP_NAME.abr.ge",
                    "YOUR_APP_NAME.deeplink.page"
            );

            if (airbridgeHosts.contains(host)) {
                decisionHandler(uri)
                return true;
            }
        }

        return false;
    }
};

private void decisionHandler(Uri uri) {
    Airbridge.click(uri.toString());
}
```

--------------------------------

### Receive Attribution Results

Source: https://help.airbridge.io/ko/developers/cordova-sdk-v4

Implement `Airbridge.setOnAttributionReceived` to get attribution data for install events. This callback provides details about the advertising source that contributed to the install.

```typescript
Airbridge.setOnAttributionReceived((attribution) => {
    // when attribution is received
})
```

--------------------------------

### Send Start Trial Event

Source: https://help.airbridge.io/ko/developers/web-sdk

Log when a user begins a trial period. Include product and currency details for the trial.

```javascript
airbridge.events.send('airbridge.startTrial', {
    semanticAttributes: {
        transactionID: 'ef1e5271-0370-407c-b1e9-669a8df1dc2c',
        currency: 'USD',
        period: 'P1M',
        products: [{
            productID: '306a57cb-f653-4220-a208-8405d8e4d506',
            name: 'MusicStreamingMembership',
            price: 15,
            currency: 'USD',
        }],
    },
})
```

--------------------------------

### Include User Data in Install/Open Events (Java)

Source: https://help.airbridge.io/ko/developers/android-sdk-v4

Initializes the SDK with auto-tracking disabled, sets user data, and then explicitly starts tracking to ensure user data is included in the initial install/open events.

```java
// 1. Initialize SDK. Opt-in setup
AirbridgeOption option = new AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
    .setAutoStartTrackingEnabled(false)
    .build();
Airbridge.initializeSDK(this, option);

// 2. Set up user data
Airbridge.setUserID("testID");
Airbridge.setUserEmail("testID@ab180.co");

// 3. Explicitly start tracking
Airbridge.startTracking();
```

--------------------------------

### Handle Deferred Deep Links in Android (Kotlin)

Source: https://help.airbridge.io/ko/deeplink-developers/sdk-quickstart

Call `handleDeferredDeeplink` in `onCreate` to get the deep link for users who clicked a tracking link before installing the app. Returns true on the first call after installation.

```kotlin
import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import co.ab180.airbridge.Airbridge

class MainActivity: AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val isFirstCalled = Airbridge.handleDeferredDeeplink { uri ->
            // when handleDeferredDeeplink is called firstly after install
            if (uri != null) {
                // show proper content using uri (YOUR_SCHEME://...)
            }
        }
        if (isFirstCalled) return
        // when handleDeferredDeeplink is called secondly or later after install
        // use existing logic as it is
    }
}
```

--------------------------------

### Get Conversion Value Configuration (Deprecated)

Source: https://help.airbridge.io/ko/references/skadnetwork-configuration

This deprecated endpoint retrieves conversion value information configured in the SKAN 3-only dashboard. Refer to the Airbridge guide for details on this specific dashboard.

```http
GET /skadnetwork/conversion-bit-config/v4?api_key={API_KEY}&response_format={RESPONSE_FORMAT}&itunes_app_id={ITUNES_APP_ID}
```

--------------------------------

### Initialize Android SDK (Java)

Source: https://help.airbridge.io/ko/developers/cordova-sdk-v4

Add this code to your `MainApplication.java` file for Android. Replace YOUR_APP_NAME and YOUR_APP_SDK_TOKEN with your actual values.

```java
import co.ab180.airbridge.cordova.AirbridgeCordova;
...
@Override
public void onCreate() {
    super.onCreate();
    AirbridgeCordova.initializeSDK(this, "YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN");
    ...
}
```

--------------------------------

### Redirect to App Store with setDownloads

Source: https://help.airbridge.io/ko/developers/web-sdk

Use the `setDownloads` function to direct users to the app store. This function is useful for guiding users to download your app, regardless of whether it's already installed.

```html
<button id="<BUTTON_ID>">앱 다운로드하기</button>
<script>
    airbridge.setDownloads({
        buttonID: '<BUTTON_ID>', // or ['<BUTTON_ID_1>', '<BUTTON_ID_2>', ...]
        defaultParams: {
            campaign: '<EXAMPLE_CAMPAIGN>',
            medium: '<EXAMPLE_MEDIUM>',
            term: '<EXAMPLE_TERM>',
            content: '<EXAMPLE_CONTENT>',
        },
        ctaParams: {
            cta_param_1: '<EXAMPLE_CTA_PARAM_1>',
            cta_param_2: '<EXAMPLE_CTA_PARAM_2>',
            cta_param_3: '<EXAMPLE_CTA_PARAM_3>',
        },
    })
</script>
```

--------------------------------

### Initialize SDK with Protected Attribution Window in Minutes

Source: https://help.airbridge.io/ko/developers/web-sdk

Configure the Protected Attribution Window (PAW) in minutes using `protectedAttributionWindowInMinutes`. This option only works when `useProtectedAttributionWindow` is `true`. The default is 30 minutes.

```javascript
airbridge.init({
    app: '<YOUR_APP_NAME>',
    webToken: '<YOUR_WEB_TOKEN>',
    // ...
    useProtectedAttributionWindow: true,
    protectedAttributionWindowInMinutes: 60,
})
```

--------------------------------

### Install iOS Dependencies

Source: https://help.airbridge.io/ko/developers/react-native-sdk-v4

After installing the SDK, use CocoaPods to install iOS dependencies. Android dependencies are installed automatically.

```bash
cd ios; pod install
```

--------------------------------

### Initialize SDK with Cookie Window in Minutes

Source: https://help.airbridge.io/ko/developers/web-sdk

Configure the attribution window in minutes using `cookieWindowInMinutes`. This option takes precedence over `cookieWindow` if both are set.

```javascript
airbridge.init({
    app: '<YOUR_APP_NAME>',
    webToken: '<YOUR_WEB_TOKEN>',
    // ...
    cookieWindowInMinutes: <MINUTES>,
})
```

--------------------------------

### Install New SDK (v1.1.X)

Source: https://help.airbridge.io/ko/developers/deprecated-react-native-sdk-v2

Install the new version of the Airbridge React Native SDK using `npm install`.

```bash
npm install --save airbridge-react-native-sdk
```

--------------------------------

### Install Dependencies (React Native >= 0.60.X)

Source: https://help.airbridge.io/ko/developers/deprecated-react-native-sdk-v2

After updating the SDK version, run `npm install` and `pod install` for iOS.

```bash
npm install
cd ios
pod install
```

--------------------------------

### Install Airbridge React Native SDK

Source: https://help.airbridge.io/ko/deeplink-developers/sdk-quickstart

Install the Airbridge React Native SDK using npm and run pod install for iOS.

```bash
npm install airbridge-react-native-sdk
cd ios; pod install
```

--------------------------------

### Complete WebView Initialization with Airbridge Handling (Kotlin)

Source: https://help.airbridge.io/ko/developers/open-link-in-webview-deprecated-android-sdk-v2

This snippet shows the full implementation for initializing a WebView and setting up the `WebViewClient` to handle Airbridge tracking links, ensuring JavaScript and DOM storage are enabled.

```kotlin
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout....)
    initWebView()
}

private fun initWebView() {
    webView.settings.javaScriptEnabled = true
    webView.settings.domStorageEnabled = true
    webView.webViewClient = webViewClient
}

private val webViewClient = object : WebViewClient() {

    @RequiresApi(Build.VERSION_CODES.LOLLIPOP)
    override fun shouldOverrideUrlLoading(
        view: WebView?,
        request: WebResourceRequest?
    ): Boolean {

        request?.url?.let {
            val airbridgeHosts = arrayOf(
                "abr.ge",
                "YOUR_APP_NAME.abr.ge",
                "YOUR_APP_NAME.deeplink.page"
            )

            if (airbridgeHosts.contains(it.host)) {
                decisionHandler(it)
                return true
            }
        }

        return false
    }

    private fun decisionHandler(uri: Uri) {
        Airbridge.click(uri.toString())
    }
}
```

--------------------------------

### Set Up Web Interface with New Function (Swift)

Source: https://help.airbridge.io/ko/developers/migration-guide-for-ios-sdk-v4

Use `Airbridge.setWebInterface` to integrate with web views, providing the view controller and a web token.

```swift
import Airbridge
...
Airbridge.setWebInterface(
    controller: controller,
    webToken: "YOUR_WEB_TOKEN"
)
```

--------------------------------

### Install Pods

Source: https://help.airbridge.io/ko/developers/deprecated-react-native-sdk-v2

Run 'pod install' in the terminal to update iOS dependencies.

```bash
pod install
```

--------------------------------

### Initialize Android SDK (Kotlin)

Source: https://help.airbridge.io/ko/developers/cordova-sdk-v4

Add this code to your `MainApplication.java` file for Android. Replace YOUR_APP_NAME and YOUR_APP_SDK_TOKEN with your actual values.

```kotlin
import co.ab180.airbridge.cordova.AirbridgeCordova
...
override fun onCreate() {
    super.onCreate()
    AirbridgeCordova.initializeSDK(this, "YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
    ...
}
```

--------------------------------

### Install React Native SDK

Source: https://help.airbridge.io/ko/developers/react-native-sdk-v4

Use npm to install the standard Airbridge React Native SDK.

```bash
npm install airbridge-react-native-sdk
```

--------------------------------

### Example Postback URL with Data

Source: https://help.airbridge.io/ko/guides/airbridge-partner-registration

This is an example of a postback URL after Airbridge has replaced the macros with specific data.

```URL
https://api.example-ad-channel.com/postback/airbridge?touchpoint_id=e7580180-7f04-11e6-bdf4-0800200c9a66&ad_channel=sample_channel&event_timestamp=1479186394000&customID=4093721
```

--------------------------------

### Example API Key Authentication

Source: https://help.airbridge.io/ko/references/attribution-result

Demonstrates how to make an API request using an API Key for authentication. Ensure you replace {API-TOKEN} with your actual API token.

```zsh
curl -H "Authorization: AIRBRIDGE-API-KEY {API-TOKEN}" https://api.airbridge.io
```

--------------------------------

### Start Airbridge SDK Tracking

Source: https://help.airbridge.io/ko/developers/unreal-sdk-v4

Call this function when you are ready to start collecting events. This is used for Opt-In tracking.

```cpp
FAirbridge::StartTracking();
```

--------------------------------

### Initialize Web SDK

Source: https://help.airbridge.io/ko/developers/sdk-quickstart

Initialize the SDK when the website loads using your app name and web SDK token.

```APIDOC
## Initialize Web SDK

### Description
Initialize the Airbridge Web SDK with your application's name and web SDK token.

### Usage
Call `airbridge.init` with your credentials. You can find `YOUR_APP_NAME` and `YOUR_WEB_SDK_TOKEN` in the Airbridge dashboard under [Settings]>[Token Management].

### Code Example
```javascript
airbridge.init({
    app: 'YOUR_APP_NAME',
    webToken: 'YOUR_WEB_SDK_TOKEN',
})
```
```

--------------------------------

### Verify Web SDK Installation

Source: https://help.airbridge.io/ko/developers/web-sdk

Logs the status of the Airbridge SDK to the console. 'true' indicates successful installation and initialization.

```javascript
console.log(airbridge.isSDKEnabled)
```
Tokens:
Raw