SDK 설치


iOS SDKiOS SDK

패키지 설치

Cocoapods

  1. 아래와 같은 명령어로 Podfile 파일을 생성해주세요.
cd path/to/project
touch Podfile
  1. Podfile 파일 내용을 아래와 같이 채워주세요.
target '[프로젝트 이름]' do
    pod 'AirBridge', '1.26.0'
end

Airbridge iOS SDK 1.18.0 이상은 Cocoapods 1.11.0 이상이 필요합니다.

  1. 터미널을 여시고 아래와 같은 명령어를 입력해주세요.
cd path/to/project
pod install --repo-update

pod 명령어가 없을 경우, cocoapods 를 설치해주세요.
sudo gem install cocoapods

SPM

Swift Package Manager(SPM)를 통해 iOS SDK를 설치할 수 있습니다. SPM을 지원하는 SDK 버전은 1.23.0 이상 입니다.

  1. Xcode에서 File > Add packages로 이동합니다
15821582
  1. Airbridge iOS SDK 추가하기
    Apple Swift Package 윈도우가 나타나면 검색창에 Airbridge 패키지의 주소 https://github.com/ab180/airbridge-ios-sdk-deploy를 입력한 후 검색합니다. 이후 원하는 버전을 입력한 후 Add package 버튼을 클릭합니다.
22362236
  1. 원하는 타겟을 선택한 후 패키지를 추가합니다
22362236
  1. SDK가 바르게 설치되었다면 Package Dependencies에 AirBridge가 표시됩니다
18181818

직접 설치

AirBridge.framework : 다운로드

1. AirBridge.framework 추가
  1. Xcode > Project 파일 > General > Frameworks, Libraries, and Embedded Content+ 버튼을 눌러주세요.
  2. 좌측 하단의 Add Other.. > Add Files.. 를 클릭해 다운로드 받은 zip 파일내의 AirBridge.framework 폴더를 추가해주세요.
2. Dependency framework 들 추가
  1. Xcode > Project 파일 > General > Frameworks, Libraries, and Embedded Content 로 이동해주세요.
  2. + 버튼을 눌러주세요.
  3. 리스트에서 아래 6개의 [Framework 이름].framework 를 찾아 추가해주세요.
  4. 6개의 [Framework 이름].framework 의 Embed 를 Do not Embed 로 설정해주세요.
  5. Xcode > Project 파일 > Build Phase > Link Binary With Libraries 로 이동해주세요.
  6. 6개의 [Framework 이름].framework 의 Status 를 Optional 로 설정해주세요.

Framework

설명

AdSupport.framework

IDFA 를 수집하는데 사용합니다.

iAd.framework

Apple Search Ads Attribution 정보를 수집하는데 사용합니다.

CoreTelephony.framework

통신사 정보를 수집하는데 사용합니다.

StoreKit.framework

SKAdNetwork 정보를 수집하는데 사용합니다.

AppTrackingTransparency.framework

Tracking 허용 상태정보를 수집하는데 사용합니다.

AdServices.framework

Apple Search Ads Attribution 정보를 수집하는데 사용합니다. (iOS 14.3+)

프로젝트 설정

다음 코드를 AppDelegateapplication(_:didFinishLaunchingWithOptions:)의 최상단에 추가해 SDK를 초기합니다.

#import <AirBridge/AirBridge.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
    [AirBridge getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];
    ...
}
import AirBridge

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    AirBridge.getInstance("YOUR_APP_TOKEN", appName:"YOUR_APP_NAME", withLaunchOptions:launchOptions)
    // ...
}

AppDelegate가 존재하지 않는 SwiftUI 환경을 사용할 경우 일반적으로 @main이 존재하는 App 클래스에서 SDK를 초기화합니다.

// YourprojectApp.swift

import SwiftUI
import AirBridge

@main
struct OnlyUIApp: App {
    init() {
        AirBridge.getInstance("YOUR_APP_TOKEN", appName: "YOUR_APP_NAME")
    }
    
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

YOUR_APP_NAME 은 대시보드의 Settings > Tokens > 앱 이름 에서 확인할 수 있습니다.
YOUR_APP_TOKEN 은 대시보드의 Settings > Tokens > 앱 SDK 토큰 에서 확인할 수 있습니다.

IDFA 이용약관 동의

SDK 를 사용하기 위해서는 앱스토어에 앱을 게시할 때 IDFA 이용약관 동의가 필요합니다.

  1. 'Yes' 항목에 체크해 주세요.
  2. 아래 사진과 같은 화면이 나옵니다.
  3. 'Attribute this app installation to a previously served advertisement.' 항목을 체크해 주세요.
  4. 'Attribute an action taken within this app to a previously served advertisement' 항목을 체크해 주세요.
  5. 'Limit Ad Tracking Setting in iOS' 항목을 체크해 주세요.
22402240

SDK 설치 확인

앱을 설치하고 실행 했을때 Install 이벤트가 전송되는지 확인해주세요.

대시보드로 확인

SDK 에서 발생한 Event 들은 에어브릿지 대시보드 > Raw Data > App Real-time Logs 에 출력됩니다.

  1. 에어브릿지 대시보드 > Raw Data > App Real-time Logs 항목을 클릭해 주세요.
  2. 검색어 입력iOS IDFA 를 입력해 주세요.
  • 로그 노출은 최대 5분 가량 지연될 수 있습니다.

로그로 확인

SDK 를 초기화하는 코드 상단에 다음 코드를 입력하면 SDK 로그가 출력됩니다.

[AirBridge setLogLevel:AB_LOG_ALL];
[AirBridge getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];
AirBridge.setLogLevel(.LOG_ALL)
AirBridge.getInstance("YOUR_APP_TOKEN", appName:"YOUR_APP_NAME", withLaunchOptions:launchOptions)

딥링크 설정


대시보드 설정

20072007

에어브릿지 대시보드 > Tracking Link > Deep Link 에 아래 2가지 정보가 필요합니다.

  • iOS URI Scheme
  • iOS App ID

iOS URI Scheme

사용하기 원하는 scheme 을 에어브릿지 대시보드의 iOS URI Scheme 영역에 :// 을 붙여 입력해주세요.

예) example://

🚧

에어브릿지의 URI Scheme은 영어 소문자, 숫자 그리고 일부 특수문자(-+.)만 지원하고 있습니다.

iOS App ID

  1. https://developer.apple.com/account/resources 의 Identifiers 로 이동해 주세요.
  2. Tracking 하고자하는 앱의 Identifier 를 클릭해 주세요.
  3. 해당 Identifier 의 App ID Prefix + . + Bundle ID 를 에어브릿지 대시보드의 iOS App ID 영역에 입력해 주세요.

예) 9JA89QQLNQ.com.apple.wwdc

20482048

프로젝트 설정

Scheme

  1. Xcode > Project 파일 > Info > URL Types 로 이동해주세요.
  2. URL Schemes 에 에어브릿지 대시보드에 입력한 iOS URI Scheme 을 입력해주세요.

:// 값을 없애고 넣어주세요.

768768

Universal Link

  1. Xcode > Project 파일 > Signing & Capabilities 로 이동해주세요.
  2. + Capability 를 눌러 Associated Domains 를 추가해주세요.
  3. Associated Domainsapplinks:YOUR_APP_NAME.airbridge.io 를 추가해주세요.
  4. Associated Domainsapplinks:YOUR_APP_NAME.deeplink.page 를 추가해주세요.

YOUR_APP_NAME 은 대시보드의 Settings > Tokens > 앱 이름 에서 확인할 수 있습니다.

Autofill 기능을 사용하는 경우, Troubleshooting > Webcredentials 를 참조해주세요.

SDK 에 Deeplink 정보 전달

AppDelegate를 사용하는 경우

iOS 12 및 이전 버전을 지원하는 앱의 경우 일반적으로 AppDelegateapplication(_:open:options:) 메서드에서 이벤트를 전달합니다.

  1. ios/[프로젝트 이름]/AppDelegate 파일을 열어주세요.

  2. 아래 함수의 최상단에서 handleURLSchemeDeeplink 함수를 호출해 App 이 Scheme으로 열렸을 때, SDK에 Deeplink 정보를 전달해주세요.

- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id>*)options
{
    [AirBridge.deeplink handleURLSchemeDeeplink:url];

    return YES;
}
func application(_ app: UIApplication,
                 open url: URL,
                 options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool
{
    AirBridge.deeplink()?.handleURLSchemeDeeplink(url)
    
    return true
}
  1. iOS 8.x 또는 그 이전 버전을 target 한다면, 아래 함수의 최상단에서도 handleURLSchemeDeeplink 함수를 호출해 App 이 Scheme 으로 열였을 때, SDK 에 Deeplink 정보를 전달해주세요.
- (BOOL)application:(UIApplication*)application
            openURL:(NSURL*)url
  sourceApplication:(NSString*)sourceApplication 
         annotation:(id)annotation
{
    [AirBridge.deeplink handleURLSchemeDeeplink:url];

    return YES;
}
func application(_ application: UIApplication,
                 open url: URL,
                 sourceApplication: String?,
                 annotation: Any) -> Bool
{
    AirBridge.deeplink()?.handleURLSchemeDeeplink(url)
    
    return true;
}
  1. 아래 함수의 최상단에서 handleUniversalLink 함수를 호출해 App 이 Universal Link 로 열였을 때, SDK 에 Deeplink 정보를 전달해주세요.
-  (BOOL)application:(UIApplication*)application
continueUserActivity:(NSUserActivity*)userActivity
  restorationHandler:(void (^)(NSArray* _Nullable))restorationHandler
{
    [AirBridge.deeplink handleUniversalLink:userActivity.webpageURL];

    return YES;
}
func application(_ application: UIApplication,
                 continue userActivity: NSUserActivity,
                 restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool
{
    if let webpageURL = userActivity.webpageURL {      
        AirBridge.deeplink()?.handleUniversalLink(webpageURL)
    }
    
    return true
}

🚧

SceneDelegate를 사용하는 프로젝트의 경우 AppDelegate가 아닌 SceneDelegate로 URL이 전달됩니다. SceneDelegate로 URL을 받는 방법은 다음 섹션인 SceneDelegate를 사용하는 경우를 참고해주세요.

SceneDelegate를 사용하는 경우

iOS 13 및 이후 버전을 지원하는 앱 중 SceneDelegate를 사용할 경우 다음 메소드로 딥링크가 전달됩니다.

  • 앱이 Not running 상태에서 로드 될 경우:
    • scene(_:willConnectTo:options:)
  • 이외의 경우(ex. background):
    • Universal link : scene(_:continue:)
    • Scheme link : scene(_:openURLContexts:)
import UIKit
import AirBridge

@available(iOS 13, *)
class SceneDelegate: UIWindowSceneDelegate {
    var window: UIWindow?

    // Receive links after the app's killed 
    func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
        if let schemeLinkURL = connectionOptions.urlContexts.first?.url {
            // Scheme
            AirBridge.deeplink().handleURLSchemeDeeplink(schemeLinkURL)
        } else if let universalLinkURL = connectionOptions.userActivities.first?.webpageURL {
            // Universal
            AirBridge.deeplink().handleUniversalLink(universalLinkURL)
        }
        
        // ...
    }
  
      // Receive universal link
    func scene(_ scene: UIScene, continue userActivity: NSUserActivity) {
        print(userActivity.webpageURL as Any)
        guard let universalLinkURL = userActivity.webpageURL else {
            return
        }
        
        AirBridge.deeplink().handleUniversalLink(universalLinkURL)
        // ...
    }
  
    // Receive scheme link
    func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
        guard let schemeLinkURL = URLContexts.first?.url else {
             return
        }
        
        AirBridge.deeplink().handleURLSchemeDeeplink(schemeLinkURL)
        // ...
    }
}
AppDelegate와 SceneDelegate를 사용하지 않는 경우(SwiftUI)

SwiftUI를 사용하며 SceneDelegate를 사용하지 않는 경우 onOpenUrl로 딥링크를 전달받습니다. SDK 초기화와 마찬가지로 @main이 존재하는 App 클래스에 해당 메소드를 추가합니다.

import SwiftUI
import AirBridge

@main
@available(iOS 14, *)
struct OnlyUIApp: App {

    ...
    
    var body: some Scene {
        WindowGroup {
            ContentView()
                .onOpenURL { url in
                    if url.scheme == "http" || url.scheme == "https" {
                        // Universal link
                        print(url)
                        AirBridge.deeplink().handleUniversalLink(url)
                    } else {
                        // Scheme link
                        print(url)
                        AirBridge.deeplink().handleURLSchemeDeeplink(url)
                    }
                }
        }
    }
}

🚧

SwiftUI를 사용하여 SceneDelegate가 존재하는 프로젝트의 경우 onOpenUrl을 사용할 수 없습니다. 이 경우 위의 SceneDelegate를 사용하는 경우를 참고하세요.

Deeplink Callback 설정

AppDelegate를 사용하는 경우
  1. ios/[프로젝트 이름]/AppDelegate 파일을 열어주세요.
  2. AppDelegateapplication(_:didFinishLaunchingWithOptions:)에서 setDeeplinkCallback 함수를 사용해 Deeplink로 App이 열렸을 때, 호출할 Callback을 설정해주세요.
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
    [AirBridge getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];

    [AirBridge.deeplink setDeeplinkCallback:^(NSString* deeplink) {
        // 딥링크로 앱이 열리는 경우 작동할 코드
        // Airbridge 를 통한 Deeplink = YOUR_SCHEME://...
        NSLog(@"DeeplinkCallback : %@", deeplink);
    }];
}
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey:
Any]?) -> Bool {
    AirBridge.getInstance("YOUR_APP_TOKEN", appName: "YOUR_APP_NAME", withLaunchOptions: launchOptions)
    
    AirBridge.deeplink()?.setDeeplinkCallback({ deeplink in
        // 딥링크로 앱이 열리는 경우 작동할 코드
        // Airbridge 를 통한 Deeplink = YOUR_SCHEME://...
        NSLog("DeeplinkCallback : %@", deeplink)
    })
    
    return true
}
AppDelegate를 사용하지 않는 경우 (SwiftUI)

SDK 초기화와 마찬기지로 @main이 존재하는 App 클래스의 생성자에 해당 메소드를 추가합니다.

import SwiftUI
import AirBridge

@main
@available(iOS 14, *)
struct OnlyUIApp: App {
    init() {
        AirBridge.getInstance("YOUR_APP_TOKEN", appName: "YOUR_APP_NAME")
        AirBridge.deeplink()?.setDeeplinkCallback { deeplink in
            print(deeplink)
        }
    }
    
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

App 을 여는 모든 Deeplink 들은 Deeplink Callback 에 전달됩니다.
그리고 그 Deeplink 들 중, Airbridge 를 통한 Deeplink 는 Airbridge 대시보드의 iOS URI Scheme 에 입력한 YOUR_SCHEME://... 형태로 전달됩니다.

Deferred deeplink 는 ATT 상태가 선택되거나, timeout 이 발생했을 때, callback 에 전달됩니다.


Airbridge iOS SDK, 1.10.0 ~ 1.10.9 를 사용하는 경우
Airbridge Deeplinkhttps://YOUR_APP_NAME.airbridge.io/... 형태로 전달됩니다.

Airbridge iOS SDK, ~ 1.9.10 를 사용하는 경우
Airbridge Deeplinkhttps://YOUR_APP_NAME.airbridge.io/... 또는 YOUR_SCHEME://... 형태로 전달됩니다.

Custom Domain 설정 (옵션)

Airbridge Tracking Link 에 Custom Domain 을 사용한다면 example.com 부분에 설정한 커스텀 도메인을 넣어 아래와 같이 설정해주세요.

  1. Xcode > Project 파일 > Signing & Capabilities > Associated Domains 로 이동해주세요.
  2. + 버튼을 눌러 applinks:example.com 를 추가해주세요.
  3. info.plist 를 열어주세요.
  4. 다음 값을 추가해주세요.
955955

딥링크 설정 확인

Airbridge 대시보드의 iOS URI Scheme 에 입력한 YOUR_SCHEME://... 형태의 딥링크를 클릭하였을 때, 앱이 열리고 Deeplink 이벤트가 전송되는지 확인해주세요.

예) example://

  1. 딥링크를 클릭해주세요.
  2. Airbridge 대시보드 > Raw Data > App Real-time Logs 에서 Deeplink 이벤트가 존재하는지 확인해주세요.

사용자 설정


사용자 식별자 설정

SDK 에 사용자 식별자 정보를 전달하여 이후 수집되는 모든 이벤트에 입력되도록 할 수 있습니다.

[AirBridge.state setUserID:@"testID"];
[AirBridge.state setUserEmail:@"[email protected]"];
[AirBridge.state setUserPhone:@"000-0000-0000"];

// 입력된 dictionary 로 user alias 가 교체됩니다.
[AirBridge.state setUserAlias:@{@"key": @"value"}];
// 기존의 user alias 에 해당 key, value 가 추가됩니다.
[AirBridge.state addUserAliasWithKey:@"key" value:@"value"];
AirBridge.state()?.setUserID("testID")
AirBridge.state()?.setUserEmail("[email protected]")
AirBridge.state()?.setUserPhone("000-0000-0000")

// 입력된 dictionary 로 user alias 가 교체됩니다.
AirBridge.state()?.setUserAlias(["key": "value"])
// 기존의 user alias 에 해당 key, value 가 추가됩니다.
AirBridge.state()?.addUserAlias(withKey: "key", value: "value")

이름

설명

제한

id

사용자 ID

email

사용자 Email

자동으로 SHA256 으로 Hash 됨 (옵션으로 해제가능)

phone

사용자 전화번호

자동으로 SHA256 으로 Hash 됨 (옵션으로 해제가능)

alias

사용자의 또 다른 ID

  • 최대 10개 입니다.
  • key 는 NSString 타입이며, 최대 128자 입니다.
  • key 는 ^[a-zA-Z_][a-z0-9_]*$ 정규식을 만족해야 합니다.
  • value 는 NSString 타입이며, 최대 1024자 입니다.

사용자 속성 설정

MTA(Multi-Touch Attribution) 분석의 정확도 향상, 내부 데이터 분석, 서드파티(3rd Party) 솔루션 연동 등의 목적으로 사용자의 추가 속성 데이터를 설정할 수 있습니다.

// 입력된 dictionary 로 user attributes 가 교체됩니다.
[AirBridge.state setUserAttributes:@{@"key": @"value"}];
// 기존의 user attributes 에 해당 key, value 가 추가됩니다.
[AirBridge.state addUserAttributesWithKey:@"key" value:@"value"];
// 입력된 dictionary 로 user attributes 가 교체됩니다.
AirBridge.state()?.setUserAttributes(["key": "value" as NSObject])
// 기존의 user attributes 에 해당 key, value 가 추가됩니다.
AirBridge.state()?.addUserAttributes(withKey: "key", value: "value" as NSObject)

이름

설명

제한

attributes

사용자 속성

  • 최대 100개 입니다.
  • key 는 NSString 타입이며, 최대 128자 입니다.
  • key 는 ^[a-zA-Z_][a-z0-9_]*$ 정규식을 만족해야 합니다.
  • value 는 NSString 또는 NSNumber 타입입니다.
  • value 는 NSString 타입일 경우 최대 1024자 입니다.

사용자 설정 확인

사용자 설정을 완료한 후, SDK 를 통해 Event 를 전송하고, 해당 Event 에 설정한 사용자 정보가 있는지 확인해주세요.

  1. 사용자 설정을 해주세요.
  2. SDK 를 통해 Event 를 전송해주세요.
  3. Airbridge 대시보드 > Raw Data > App Real-time Logs 에서 전송한 Event 를 클릭하여 JSON 속 user 부분에 설정한 사용자 정보가 있는지 확인해주세요.

이벤트 설정


사용자의 중요한 행동들이 발생할 때, 인앱 이벤트를 전송해 유입 경로별 성과를 측정할 수 있습니다.

모든 이벤트의 파라미터는 선택적으로 추가할 수 있습니다.
그러나 이벤트에 대한 많은 정보는 정확한 통계 제공에 도움이 됨으로 추가하는 것을 권장합니다.

이벤트 전송

SDK 를 통해 이벤트를 전송할 수 있습니다.

setCategory 함수는 이벤트 전송을 위해 필수적으로 호출되어야만 합니다.

#import <AirBridge/ABInAppEvent.h>

ABInAppEvent* event = [[ABInAppEvent alloc] init];

[event setCategory:@"category"];
[event setAction:@"action"];
[event setLabel:@"label"];
[event setValue:@(123)];
[event setCustoms:@{@"key": @"value"}];

// Semantic Attributes Option 1
ABSemanticAttributes* semanticAttributes = [[ABSemanticAttributes alloc] init];
semanticAttributes.transactionID = @"transaction_123";
[event setSemanticAttributes:semanticAttributes];

// Semantic Attributes Option 2
// For more details, please check following page
// https://developers.airbridge.io/docs/event-structure#semantic-attributes
[event setSemantics:@{@"transactionID": @"transaction_123"}];

[event send];
let event = ABInAppEvent()

event?.setCategory("category")
event?.setAction("action")
event?.setLabel("label")
event?.setValue(123)
event?.setCustoms(["key": "value"])

// Semantic Attributes Option 1
let semanticAttributes = ABSemanticAttributes()
semanticAttributes?.transactionID = "transaction_123"
event?.setSemanticAttributes(semanticAttributes)

// Semantic Attributes Option 2
// For more details, please check following page
// https://developers.airbridge.io/docs/event-structure#semantic-attributes
event?.setSemantics(["transactionID": "transaction_123"])

event?.send()

파라미터

설명

setCategory

이벤트 이름 (required)

setAction

이벤트 하위 분류 1

setLabel

이벤트 하위 분류 2

setValue

이벤트 커스텀 값

setCustoms

이벤트 커스텀 정보

setSemantics

이벤트 시맨틱 정보 (Map)

스탠다드 이벤트 전송

회원가입

#import <AirBridge/ABUser.h>
#import <AirBridge/ABInAppEvent.h>
#import <AirBridge/ABCategory.h>

ABUser* user = [[ABUser alloc] init];
user.ID = @"testID";
user.email = @"[email protected]";
user.phone = @"000-0000-0000";
user.alias = @{
    @"key": @"value",
};
user.attributes = @{
    @"key": @"value",
};

[AirBridge.state setUser:user];

ABInAppEvent* event = [[ABInAppEvent alloc] init];
[event setCategory:ABCategory.signUp];

[event send];
let user = ABUser()
user.id = "testID"
user.email = "[email protected]"
user.phone = "000-0000-0000"
user.attributes = [
    "key": "value" as NSObject,
]
user.alias = [
    "key": "value",
]

AirBridge.state().setUser(user)

let event = ABInAppEvent()
event?.setCategory(ABCategory.signUp)
event?.send()

로그인

#import <AirBridge/ABUser.h>
#import <AirBridge/ABInAppEvent.h>
#import <AirBridge/ABCategory.h>

ABUser* user = [[ABUser alloc] init];
user.ID = @"testID";
user.email = @"[email protected]";
user.phone = @"000-0000-0000";
user.alias = @{
    @"key": @"value",
};
user.attributes = @{
    @"key": @"value",
};

[AirBridge.state setUser:user];

ABInAppEvent* event = [[ABInAppEvent alloc] init];
[event setCategory:ABCategory.signIn];

[event send];
let user = ABUser()
user.id = "testID"
user.email = "[email protected]"
user.phone = "000-0000-0000"
user.attributes = [
    "key": "value" as NSObject,
]
user.alias = [
    "key": "value",
]

AirBridge.state().setUser(user)

let event = ABInAppEvent()
event?.setCategory(ABCategory.signIn)
event?.send()

로그아웃

#import <AirBridge/ABInAppEvent.h>
#import <AirBridge/ABCategory.h>

ABInAppEvent* event = [[ABInAppEvent alloc] init];
[event setCategory:ABCategory.signOut];

[AirBridge.state setUser:[[ABUser alloc] init]];
let event = ABInAppEvent()
event?.setCategory(ABCategory.signOut)
event?.send()

AirBridge.state.setUser(ABUser())

홈 화면 조회

#import <AirBridge/ABInAppEvent.h>
#import <AirBridge/ABCategory.h>
  
ABInAppEvent* event = [[ABInAppEvent alloc] init];
[event setCategory:ABCategory.viewHome];

[event send];
let event = ABInAppEvent()
event?.setCategory(ABCategory.viewHome)
event?.send()

상품 상세 조회

#import <AirBridge/ABProduct.h>
#import <AirBridge/ABInAppEvent.h>
#import <AirBridge/ABCategory.h>
#import <AirBridge/ABSemanticsKey.h>

ABProduct* product1 = [[ABProduct alloc] init];
product1.idx = @"idx1";
product1.name = @"name1";
product1.price = @100;
product1.currency = @"USD";
product1.orderPosition = @1;
product1.quantity = @1;

ABInAppEvent* event = [[ABInAppEvent alloc] init];
[event setCategory:ABCategory.viewProductDetail];
[event setSemantics:@{
    ABSemanticsKey.products: @[product1.toDictionary],
}];

[event send];
let product1 = ABProduct()
product1.idx = "idx1"
product1.name = "name1"
product1.price = 100
product1.currency = "USD"
product1.orderPosition = 1
product1.quantity = 1

let event = ABInAppEvent()
event?.setCategory(ABCategory.viewProductDetail)
event?.setSemantics([
    ABSemanticsKey.products: [
        product1.toDictionary(),
    ],
])
event?.send()

상품 리스트 조회

#import <AirBridge/ABProduct.h>
#import <AirBridge/ABInAppEvent.h>
#import <AirBridge/ABCategory.h>
#import <AirBridge/ABSemanticsKey.h>

ABProduct* product1 = [[ABProduct alloc] init];
product1.idx = @"idx1";
product1.name = @"name1";
product1.price = @100;
product1.currency = @"USD";
product1.orderPosition = @1;
product1.quantity = @1;

ABProduct* product2 = [[ABProduct alloc] init];
product2.idx = @"idx2";
product2.name = @"name2";
product2.price = @200;
product2.currency = @"USD";
product2.orderPosition = @2;
product2.quantity = @2;

ABInAppEvent* event = [[ABInAppEvent alloc] init];
[event setCategory:ABCategory.viewProductList];
[event setSemantics:@{
    ABSemanticsKey.products: @[
        product1.toDictionary,
        product2.toDictionary,
    ],
    ABSemanticsKey.productListID: @"listID",
}];

[event send];
let product1 = ABProduct()
product1.idx = "idx1"
product1.name = "name1"
product1.price = 100
product1.currency = "USD"
product1.orderPosition = 1
product1.quantity = 1

let product2 = ABProduct()
product2.idx = "idx2"
product2.name = "name2"
product2.price = 200
product2.currency = "USD"
product2.orderPosition = 2
product2.quantity = 2

let event = ABInAppEvent()
event?.setCategory(ABCategory.viewProductList)
event?.setSemantics([
    ABSemanticsKey.products: [
        product1.toDictionary(),
        product2.toDictionary(),
    ],
    ABSemanticsKey.productListID: "productListID",
])
event?.send()

검색 결과 조회

#import <AirBridge/ABProduct.h>
#import <AirBridge/ABInAppEvent.h>
#import <AirBridge/ABCategory.h>
#import <AirBridge/ABSemanticsKey.h>

ABProduct* product1 = [[ABProduct alloc] init];
product1.idx = @"idx1";
product1.name = @"name1";
product1.price = @100;
product1.currency = @"USD";
product1.orderPosition = @1;
product1.quantity = @1;

ABProduct* product2 = [[ABProduct alloc] init];
product2.idx = @"idx2";
product2.name = @"name2";
product2.price = @200;
product2.currency = @"USD";
product2.orderPosition = @2;
product2.quantity = @2;

ABInAppEvent* event = [[ABInAppEvent alloc] init];
[event setCategory:ABCategory.viewSearchResult];
[event setSemantics:@{
    ABSemanticsKey.products: @[
        product1.toDictionary,
        product2.toDictionary,
    ],
    ABSemanticsKey.query: @"query",
}];

[event send];
let product1 = ABProduct()
product1.idx = "idx1"
product1.name = "name1"
product1.price = 100
product1.currency = "USD"
product1.orderPosition = 1
product1.quantity = 1

let product2 = ABProduct()
product2.idx = "idx2"
product2.name = "name2"
product2.price = 200
product2.currency = "USD"
product2.orderPosition = 2
product2.quantity = 2

let event = ABInAppEvent()
event?.setCategory(ABCategory.viewSearchResult)
event?.setSemantics([
    ABSemanticsKey.products: [
        product1.toDictionary(),
        product2.toDictionary(),
    ],
    ABSemanticsKey.query: "query",
])
event?.send()

장바구니 담기

#import <AirBridge/ABProduct.h>
#import <AirBridge/ABInAppEvent.h>
#import <AirBridge/ABCategory.h>
#import <AirBridge/ABSemanticsKey.h>

ABProduct* product1 = [[ABProduct alloc] init];
product1.idx = @"idx1";
product1.name = @"name1";
product1.price = @100;
product1.currency = @"USD";
product1.orderPosition = @1;
product1.quantity = @1;

ABProduct* product2 = [[ABProduct alloc] init];
product2.idx = @"idx2";
product2.name = @"name2";
product2.price = @200;
product2.currency = @"USD";
product2.orderPosition = @2;
product2.quantity = @2;

ABInAppEvent* event = [[ABInAppEvent alloc] init];
[event setCategory:ABCategory.addToCart];
[event setSemantics:@{
    ABSemanticsKey.products: @[
        product1.toDictionary,
        product2.toDictionary,
    ],
    ABSemanticsKey.cartID: @"cartID",
    ABSemanticsKey.currency: @"currency",
    ABSemanticsKey.totalValue: @300,
}];

[event send];
let product1 = ABProduct()
product1.idx = "idx1"
product1.name = "name1"
product1.price = 100
product1.currency = "USD"
product1.orderPosition = 1
product1.quantity = 1;

let product2 = ABProduct()
product2.idx = "idx2"
product2.name = "name2"
product2.price = 200
product2.currency = "USD"
product2.orderPosition = 2
product2.quantity = 2;

let event = ABInAppEvent()
event?.setCategory(ABCategory.addToCart)
event?.setSemantics([
    ABSemanticsKey.products: [
        product1.toDictionary(),
        product2.toDictionary(),
    ],
    ABSemanticsKey.cartID: "cartID",
    ABSemanticsKey.totalValue: 300,
    ABSemanticsKey.currency: "KRW",
])
event?.send()

결제

#import <AirBridge/ABProduct.h>
#import <AirBridge/ABInAppEvent.h>
#import <AirBridge/ABCategory.h>
#import <AirBridge/ABSemanticsKey.h>

ABProduct* product1 = [[ABProduct alloc] init];
product1.idx = @"idx1";
product1.name = @"name1";
product1.price = @100;
product1.currency = @"USD";
product1.orderPosition = @1;
product1.quantity = @1;

ABProduct* product2 = [[ABProduct alloc] init];
product2.idx = @"idx2";
product2.name = @"name2";
product2.price = @200;
product2.currency = @"USD";
product2.orderPosition = @2;
product2.quantity = @2;

ABInAppEvent* event = [[ABInAppEvent alloc] init];
[event setCategory:ABCategory.purchase];
[event setSemantics:@{
    ABSemanticsKey.products: @[
        product1.toDictionary,
        product2.toDictionary,
    ],
    ABSemanticsKey.transcationID: @"transcationID",
    ABSemanticsKey.currency: @"currency",
    ABSemanticsKey.totalValue: @300,
    ABSemanticsKey.inAppPurchased: @YES,
}];

[event send];
let product1 = ABProduct()
product1.idx = "idx1"
product1.name = "name1"
product1.price = 100
product1.currency = "USD"
product1.orderPosition = 1
product1.quantity = 1

let product2 = ABProduct()
product2.idx = "idx2"
product2.name = "name2"
product2.price = 200
product2.currency = "USD"
product2.orderPosition = 2
product2.quantity = 2

let event = ABInAppEvent()
event?.setCategory(ABCategory.purchase)
event?.setSemantics([
    ABSemanticsKey.products: [
        product1.toDictionary(),
        product2.toDictionary(),
    ],
    ABSemanticsKey.transactionID: "transactionID",
    ABSemanticsKey.totalValue: 300,
    ABSemanticsKey.currency: "KRW",
    ABSemanticsKey.inAppPurchased: true,
])
event?.send()

이벤트 전송 확인

SDK 를 통해 Event 를 전송하고, 에어브릿지 대시보드에 해당 Event 가 존재하는지 확인해주세요.

  1. SDK 를 통해 Event 를 전송해주세요.
  2. Airbridge 대시보드 > Raw Data > App Real-time Logs 에서 전송한 Event 가 존재하는지 확인해주세요.

고급 설정


사용자 정보 해시화 설정

유저의 정보 중 email, phone 정보는 자동으로 SHA256 으로 Hash 되어 전송합니다.
SDK 를 초기화하는 코드 상단에 setIsUserInfoHashed 함수를 호출해 설정을 변경하실 수 있습니다.

// User 정보 Hash 화 해제
[AirBridge setIsUserInfoHashed:NO];

[AirBridge getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];
// User 정보 Hash 화 해제
AirBridge.setIsUserInfoHashed(false) 

AirBridge.getInstance("YOUR_APP_TOKEN", appName:"YOUR_APP_NAME", withLaunchOptions:launchOptions)

세션 타임아웃 설정

SDK 를 초기화하는 코드 상단에 setSessionTimeout 함수를 호출해 세션 타임아웃을 설정할 수 있습니다.

세션 타임아웃은 millisecond 단위이며, 0 이상 604800000 (7일) 이하 인 값이어야 합니다.

세션 타임아웃의 기본값은 1000 * 60 * 5 (5분) 입니다.

[AirBridge setSessionTimeout:1000 * 60 * 5];

[AirBridge getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];
AirBridge.setSessionTimeout(1000 * 60 * 5)

AirBridge.getInstance("YOUR_APP_TOKEN", appName:"YOUR_APP_NAME", withLaunchOptions:launchOptions)

개인정보보호(Opt-out) 설정

해당 기능은 GDPR이나 CCPA와 같이 고객으로부터 개인정보보호에 대한 동의를 받아 데이터 수집 및 전송을 진행하는 경우에 유용한 기능입니다.

SDK 초기화 코드 이전에 autoStartTrackingEnabled 를 false 로 설정하면, SDK 는 startTracking 함수가 호출 될 때 까지 이벤트를 전송하지 않습니다.

따라서, 앱이 꺼져있는 상태에서 라이프사이클 이벤트(Deeplink Open 등) 발생 시, startTracking 함수 호출보다 해당 이벤트가 먼저 전송되므로 이벤트가 누락될 수 있습니다.

AirBridge.autoStartTrackingEnabled = NO;

[AirBridge getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];

[AirBridge startTracking];
AirBridge.setAutoStartTrackingEnabled(false)

AirBridge.getInstance("YOUR_APP_TOKEN", appName:"YOUR_APP_NAME", withLaunchOptions:launchOptions)

AirBridge.startTracking()

Airbridge 링크만 추적 설정

SDK 는 딥링크로 앱이 열렸을 때, 언제나 딥링크 이벤트를 전송합니다.

SDK 를 초기화하는 코드 상단에 setIsTrackAirbridgeDeeplinkOnly 함수를 호출해 true 로 설정하면, Airbridge 를 통한 딥링크 로 앱이 열린 경우에만 딥링크 이벤트를 전송할 수 있습니다.

// Airbridge 를 통한 딥링크 로 앱이 열린 경우에만 딥링크 이벤트를 전송
[AirBridge setIsTrackAirbridgeDeeplinkOnly:YES];

[AirBridge getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];
// Airbridge 를 통한 딥링크 로 앱이 열린 경우에만 딥링크 이벤트를 전송
AirBridge.setIsTrackAirbridgeDeeplinkOnly(true)

AirBridge.getInstance("YOUR_APP_TOKEN", appName:"YOUR_APP_NAME", withLaunchOptions:launchOptions)

페이스북 디퍼드 앱링크 설정

아래 설정을 통해 Facebook 의 Deferred App Link 를 SDK 에서 수집할 수 있습니다.

  1. https://developers.facebook.com/docs/ios/getting-started 링크를 통해 Facebook SDK 를 설치해주세요.
  2. ios/[프로젝트 이름]/AppDelegate 파일을 열어주세요.
  3. SDK 초기화 코드 이전에 setIsFacebookDeferredAppLinkEnabled 함수를 호출해주세요.

isFacebookDeferredAppLinkEnabled 값이 YES 이고, Facebook SDK 가 설치되어 있을 때, SDK 가 Facebook Deferred App Link 를 수집합니다.

[AirBridge setIsFacebookDeferredAppLinkEnabled:YES];

[AirBridge getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];
AirBridge.setIsFacebookDeferredAppLinkEnabled(true)

AirBridge.getInstance("YOUR_APP_TOKEN", appName: "YOUR_APP_NAME", withLaunchOptions: launchOptions)

앱 삭제 추적 설정

앱 삭제 추적 설정은 해당 페이지를 참조해 주세요.

푸시 알림 딥링크 추적 설정

푸시 알림이 클릭되었을 때, handleNotificationDeeplink 함수를 호출해 푸시 알림 페이로드의 딥링크를 SDK 에 전달해주세요.

- (void)         application:(UIApplication *)application 
didReceiveRemoteNotification:(NSDictionary *)userInfo 
      fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler 
{
    if (UIApplication.sharedApplication.applicationState == UIApplicationStateInactive) {
        NSURL* url = // 푸시 알림 페이로드의 딥링크
        
        [AirBridge.deeplink handleNotificationDeeplink:url];
    }
}

- (void)userNotificationCenter:(UNUserNotificationCenter *)center 
didReceiveNotificationResponse:(UNNotificationResponse *)response 
         withCompletionHandler:(void (^)(void))completionHandler API_AVAILABLE(ios(10.0)) 
{
    if (UIApplication.sharedApplication.applicationState == UIApplicationStateInactive
        && [response.actionIdentifier isEqual:UNNotificationDefaultActionIdentifier])
    {
        NSURL* url = // 푸시 알림 페이로드의 딥링크
        
        [AirBridge.deeplink handleNotificationDeeplink:url];
    }
}
func application(_ application: UIApplication, 
                 didReceiveRemoteNotification userInfo: [AnyHashable : Any], 
                 fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) 
{
    if UIApplication.shared.applicationState == .inactive {
        let url = // 푸시 알림 페이로드의 딥링크
            
        AirBridge.deeplink()?.handleNotificationDeeplink(url)
    }
}

@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, 
                            didReceive response: UNNotificationResponse, withCompletionHandler 
                            completionHandler: @escaping () -> Void) 
{
    if UIApplication.shared.applicationState == .inactive,
       response.actionIdentifier == UNNotificationDefaultActionIdentifier
    {
        let url = // 푸시 알림 페이로드의 딥링크
            
        AirBridge.deeplink()?.handleNotificationDeeplink(url)
    }
}

Tracking Authorize Timeout 설정

AppTrackingTransparency.framework 를 사용해 추적 허용 선택창 을 표시하는 경우, 추적 허용 을 선택하더라도 선택하기 이전에 설치 이벤트가 전송되기 때문에 설치 이벤트에서 IDFA 수집이 불가능합니다.

SDK 초기화 코드 이전에 trackingAuthorizeTimeouttimeout 을 설정하면, 설치 이벤트를 전송하기 전에 timeout 만큼 추적 허용 선택창 이 선택될 때 까지 기다립니다.

trackingAuthorizeTimeout 은 millisecond 단위입니다.
trackingAuthorizeTimeout 만큼 설치 이벤트가 늦게 전송될 수 있습니다.
trackingAuthorizeTimeout App 재시작 마다 초기화됩니다.

ATT 상태가 선택되거나, timeout 이 발생했을 때 deferred deeplink 가 callback 에 전달됩니다.

App 재시작마다 timeout 을 초기화하지 않기 위해서는 isRestartTrackingAuthorizeTimeout 을 false 로 설정해 주세요.

// millisecond 단위를 고려해서 30 대신 원하는 Tracking Authorized Timeout 시간을 입력합니다.
AirBridge.setting.trackingAuthorizeTimeout = 30 * 1000;
AirBridge.setting.isRestartTrackingAuthorizeTimeout = NO;

[AirBridge getInstance:@"YOUR_APP_TOKEN" appName:@"YOUR_APP_NAME" withLaunchOptions:launchOptions];
AirBridge.setting()?.trackingAuthorizeTimeout = 120 * 1000
AirBridge.setting()?.isRestartTrackingAuthorizeTimeout = false

AirBridge.getInstance("YOUR_APP_TOKEN", appName:"YOUR_APP_NAME", withLaunchOptions:launchOptions)

🚧

위 코드 중 trackingAuthorizeTimeout 값은 Tracking Authorized Timeout 시간을 임의로 설정한 예시입니다. 실제로 활용할 때는 반드시 앱의 UX(사용자 경험)와 ATT 프롬프트 설정에 맞게 값을 바꿔야 합니다.

이벤트 버퍼 제한 설정

Airbridge SDK 는 이벤트를 전송할 수 없는 환경인 경우에 대비해서 이벤트를 스토리지에 저장하고 재시도하는 기능을 가지고 있습니다. 이 기능을 통해 Airbridge 가 이벤트를 저장하는데 사용하는 스토리지를 제한할 수 있습니다.

// 이벤트 개수 제한
[AirBridge.setting setEventMaximumBufferCount:newValue]
// 이벤트 크기 제한 (Byte 단위)
[AirBridge.setting setEventMaximumBufferSize:newValue]
// 이벤트 개수 제한
AirBridge.setting().setEventMaximumBufferCount(newValue)
// 이벤트 크기 제한 (Byte 단위)
AirBridge.setting().setEventMaximumBufferSize(newValue)

설정된 제한은 다음 SDK 초기화 부터 적용됩니다.

이벤트 전송 주기 설정

Airbridge SDK 는 이벤트를 전송하는 최소 주기를 설정할 수 있습니다. 이벤트를 1회 전송하는데 성공하면 설정한 주기 만큼은 이벤트가 전송되지 않게 됩니다.

// 이벤트 전송 주기 (Millisecond 단위)
[AirBridge.setting setEventTransmitInterval:newValue]
// 이벤트 전송 주기 (Millisecond 단위)
AirBridge.setting().setEventTransmitInterval(newValue)

📘

기본 이벤트 전송 주기는 0 millisecond 입니다.

미처리된 이벤트 삭제 설정

Airbridge 초기화 시 내부 저장소에 저장된 모든 이벤트를 삭제하는 기능입니다.
Airbridge는 이벤트 전송 시 손실을 최소화하기 위해 전송되지 않은 이벤트를 내부 저장소에 저장합니다. 하지만 이 기능이 활성화되어있을 경우, Airbridge가 초기화될 때 저장소에 있는 이벤트를 모두 삭제합니다.

// 활성화
Airbridge.setResetEventBufferEnabled(true)

// 비활성화
Airbridge.setResetEventBufferEnabled(false)

🚧

해당 함수는 Airbridge이 트래킹을 시작하기 전에 실행되어야 합니다. 즉, autoStartTrackingtrue로 설정되어 있을 경우 getInstance이전, false로 설정되어 있을 경우 startTracking이전에 실행되어야 합니다.

그렇지 않을 경우 해당 기능은 동작하지 않습니다.

Airbridge 비활성화 설정

Airbridge의 전체 동작을 비활성화 할 수 있는 기능입니다. 앱 라이프 사이클 추적, 이벤트 전송 등 Airbridge의 모든 기능이 비활성화 됩니다.

// 활성화
Airbridge.setSDKEnabled(true)

// 비활성화
Airbridge.setSDKEnabled(false)

🚧

해당 함수는 Airbridge의 초기화 코드(getInstance)보다 먼저 실행되어야 합니다. 그렇지 않을 경우 해당 기능은 동작하지 않습니다.

하이브리드 앱 설정


WebView 환경 이벤트 전송

WebView 의 웹사이트에 설치된 Web SDK 가 전송하는 Event 를 iOS SDK 가 대신 전송할 수 있습니다.

아래와 같이 WebView 의 configuration 의 controller 에 airbridge web interface 를 주입해주세요.

WKWebViewConfiguration* configuration = [[WKWebViewConfiguration alloc] init];

WKUserContentController* controller = [[WKUserContentController alloc] init];
[AirBridge.webInterface injectTo:controller withWebToken:@"YOUR_WEB_TOKEN"];

configuration.userContentController = controller;
    
WKWebView* webview = [[WKWebView alloc] initWithFrame:CGRectZero configuration:configuration];
let configuration = WKWebViewConfiguration()
        
let controller = WKUserContentController()
AirBridge.webInterface()?.inject(to: controller, withWebToken: "YOUR_WEB_TOKEN")
        
configuration.userContentController = controller
        
webView = WKWebView(frame: .zero, configuration: configuration)

YOUR_WEB_TOKEN 은 대시보드의 Settings > Tokens > 웹 SDK 토큰 에서 확인할 수 있습니다.

Troubleshooting


Webcredentials

App 에서 Autofill 기능을 사용해 비밀번호를 저장하는 경우 webcredentials:... 설정이 되어 있지 않으면 비밀번호가 applinks:YOUR_APP_NAME.airbridge.io 또는 applinks:YOUR_APP_NAME.deeplink.page 의 도메인에 저장됩니다.

비밀번호가 저장되는 도메인을 변경하고 싶다면, example.com설정할 도메인 으로 변경해서 아래와 같이 설정해주세요.

  1. https://example.com/.well-known/apple-app-site-association 주소에서 아래내용을 호스팅해야 합니다.
{
    "webcredentials": {
        "apps": ["TEAM_ID.APP_BUNDLE_ID"]
    }
}

예) 9JA89QQLNQ.com.apple.wwdc

  1. Xcode > Project 파일 > Signing & Capabilities > Associated Domains 로 이동해주세요.
  2. + 버튼을 눌러 webcredentials:example.com 을 추가해주세요.