pod v1.32.2

1. 아래와 같은 명령어로 Podfile파일을 생성해주세요.

   12

   cd path/to/project
   touch Podfile

2. Podfile파일 내용을 아래와 같이 채워주세요.

   Podfile

   123

   target '[Project Name]' do
       pod 'AirBridge', '1.33.4'
   end

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

3. 터미널을 여시고 아래와 같은 명령어를 입력해주세요.

   12

   cd path/to/project
   pod install --repo-update

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

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

1. Xcode에서 File > Add packages로 이동합니다.

   

2. Airbridge iOS SDK 추가하기
   Apple Swift Package 윈도우가 나타나면 검색창에 Airbridge 패키지의 주소 https://github.com/ab180/airbridge-ios-sdk-deploy를 입력한 후 검색합니다. 이후 원하는 버전을 입력한 후 Add package 버튼을 클릭합니다.

   

3. 원하는 타겟을 선택한 후 패키지를 추가합니다.

   

4. SDK가 바르게 설치되었다면 Package Dependencies에 AirBridge가 표시됩니다.

   

AirBridge.framework : 다운로드

1. Xcode > Project 파일 > General > Frameworks, Libraries, and Embedded Content의 +버튼을 눌러주세요.

2. 좌측 하단의 Add Other.. > Add Files..를 클릭해 다운로드 받은 zip 파일내의 AirBridge.xcframework 폴더를 추가해주세요.

3. AirBridge.xcframework의 Embed 를 Do not Embed 로 설정해주세요.

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 로 설정해주세요.

다음 코드를 AppDelegate의 application(_: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를 초기화합니다.

YOUR_APP_NAME과 YOUR_APP_SDK_TOKEN은 Airbridge 대시보드 > Settings > Tokens 탭에서 확인하실 수 있습니다.

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' 항목을 체크해 주세요.

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

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

1. Airbridge 대시보드 > Raw Data> App Real-time Logs항목을 클릭해 주세요.

2. 검색어 입력 에 iOS IDFA를 입력해 주세요. 로그 노출은 최대 5분 가량 지연될 수 있습니다.

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

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

• iOS URI Scheme

• iOS App ID

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

주의하세요

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

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

     

1. Xcode> Project 파일> Info> URL Types로 이동해주세요.

2. URL Schemes에 에어브릿지 대시보드에 입력한 iOS URI Scheme을 입력해주세요.

주의하세요

URI Scheme 입력 시 :// 는 제외하고 입력해주세요.

1. Xcode> Project 파일> Signing & Capabilities로 이동해주세요.

2. + Capability를 눌러 Associated Domains를 추가해주세요.

3. Associated Domains에 applinks:YOUR_APP_NAME.airbridge.io를 추가해주세요.

4. Associated Domains에 applinks:YOUR_APP_NAME.abr.ge를 추가해주세요.

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

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

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

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

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

   Objective-C

   Swift

3. 아래 함수의 최상단에서 handleUserActivity함수를 호출해 App 이 Universal Link 로 열였을 때, SDK 에 Deeplink 정보를 전달해주세요.

   Objective-C

   Swift

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

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

• 앱이 Not running 상태에서 로드 될 경우: scene(_:willConnectTo:options:)

• 이외의 경우(ex. background)

  • Universal link : scene(_:continue:)

  • Scheme link : scene(_:openURLContexts:)

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

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

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

2. AppDelegate의 application(_:didFinishLaunchingWithOptions:)에서 setDeeplinkCallback함수를 사용해 딥링크로 App이 열렸을 때, 호출할 콜백을 설정해주세요.

   Objective-C

   Swift

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

• Airbridge iOS SDK v1.10.0 ~ v1.10.9를 사용하는 경우 : Airbridge Deeplink는 https://YOUR_APP_NAME.airbridge.io/...형태로 전달됩니다.

• Airbridge iOS SDK ~ v1.9.10를 사용하는 경우 : Airbridge Deeplink는 https://YOUR_APP_NAME.airbridge.io/...또는 YOUR_SCHEME://...형태로 전달됩니다.

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

1. Xcode > Project 파일 > Signing & Capabilities > Associated Domains 로 이동해주세요.

2. +버튼을 눌러 applinks:example.com를 추가해주세요.

3. info.plist를 열어주세요.

4. 다음 값을 추가해주세요.

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

1. 딥링크를 클릭해주세요.

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

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

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

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

1. 사용자 설정을 해주세요.

2. SDK 를 통해 Event 를 전송해주세요.

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

SDK에 디바이스 식별자 정보를 설정해 이후 수집되는 모든 이벤트에 디바이스 식별정보를 포함시킬 수 있습니다. 디바이스 식별자가 설정되면 별도로 삭제하지 않을 경우 앱 종료 여부에 관계없이 계속 유지됩니다.

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

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

SDK를 통해 서비스 내에서 발생하는 다양한 이벤트를 Airbridge로 전송하여 마케팅의 성과로 측정할 수 있습니다.

주의하세요

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

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

1. SDK 를 통해 Event 를 전송해주세요.

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

SDK Signature 를 설정하는 것으로 SDK 를 SDK Spoofing 으로 부터 보호할 수 있습니다.

SDK 를 초기화하는 코드 상단에 setSDKSignatureSecret 함수를 호출해 설정을 변경하실 수 있습니다.

SDK Signature 를 설정하기 위해서는 SDK Signature Secret, SDK Signature Secret ID 2가지가 필요합니다. 해당 2가지 값을 발급받기 위해서는 담당 에어브릿지 CSM 에게 연락해주세요.

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

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

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

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

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

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

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

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

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

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

1. 아래 페이스북 개발자 가이드를 참고하여 Facebook SDK 를 설치해주세요.

   • https://developers.facebook.com/docs/ios/getting-started

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

3. SDK 초기화 코드 이전에 setIsFacebookDeferredAppLinkEnabled함수를 호출해주세요.

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

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

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

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

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

• trackingAuthorizeTimeout 은 millisecond 단위입니다.

• trackingAuthorizeTimeout 만큼 설치 이벤트가 늦게 전송될 수 있습니다.

• trackingAuthorizeTimeout App 재시작 마다 초기화됩니다.

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

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

주의하세요

위 코드 중 trackingAuthorizeTimeout 값은 SDK 버전이 1.32.1+ 이상인 iOS SDK의 기본값(30초)입니다. 실제로 활용할 때는 반드시 앱의 UX(사용자 경험)와 ATT 프롬프트 설정에 맞게 값을 바꿔야 합니다.

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

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

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

주의하세요

해당 함수는 Airbridge이 트래킹을 시작하기 전에 실행되어야 합니다. 즉, autoStartTracking이 true로 설정되어 있을 경우 getInstance이전, false로 설정되어 있을 경우 startTracking이전에 실행되어야 합니다. 그렇지 않을 경우 해당 기능은 동작하지 않습니다.

Airbridge SDK는 앱 내에서 트래킹 링크를 열 수 있는 기능을 제공해 브라우저를 거치지 않고도 다른 화면으로 이동할 수 있습니다.

해당 트래킹 링크가 클릭되었을 때 호출합니다. 그 후 트래킹 링크의 click 통계를 추가하고 설정된 App, Web 또는 Fallback으로 이동합니다.

해당 트래킹 링크가 UI에 표시 되었을 때 호출합니다. 그 후 트래킹 링크의 impression 통계를 1개 추가합니다.

주의하세요

커스텀 도메인 사용 시, 커스텀 Short ID를 포함한 트래킹 링크는 사용할 수 없습니다.

• example1) http://deeplink.ab180.co/custom → 사용불가

• example2) http://deeplink.ab180.co/a3b1c2 → 사용가능

• example3) https://abr.ge/a3b1c2 → 사용가능

Airbridge SDK에서 어트리뷰션 결과를 확인하려면 다음과 같이 attributionCallback에 콜백 클로저를 전달합니다.

• 결과로 다음과 같은 데이터를 받을 수 있습니다:

• 기여 결과가 없는 경우 attributedChannel항목에 대해 unattributed데이터가 전달됩니다.

Attribution 값 사용에 대한 가이드라인:

• 기여 결과가 존재하는 경우

  1. Attribution 값은 SDK 초기화 후 대체로 40초 내외에 콜백으로 전달됩니다.

  2. 앱이 종료되어 이전에 Attribution 값을 전달받지 못한 경우, 다음 앱 실행 시 SDK 초기화 후 40초 내외에 Attribution 값이 전달됩니다.

  3. 드물게 최대 5분까지 전달이 지연될 수 있습니다.

• 기여 결과가 존재하지 않는 경우 SDK를 초기화한 이후, 최소 3시간이 경과한 후 앱 재실행 시 Attribution 값이 전달됩니다.

실시간 처리가 필요한 부분에는 콜백으로 전달되는 Attribution 값을 활용하는 것은 권장하지 않습니다.

Airbridge 생명 주기 이벤트 중 앱이 Background로 이동하고 세션 안에 발생하는 생명 주기 이벤트는 기본적으로 수집되지 않습니다. 이 옵션을 사용하면 이 이벤트들을 수집할 수 있습니다.

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

주의하세요

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

iOS Extension 의 Airbridge SDK 의 활용이 가능합니다. iOS Extension 의 viewDidLoad 함수에서 SDK 를 초기화 해주시고 이벤트 전송 함수를 이용하여 이벤트를 수집하실 수 있습니다.

주의하세요

iOS Extension 에서 Airbridge SDK 활용에 있어서 아래와 같은 제약이 존재합니다.

• iOS Extension 에서는 Install, Open, Deeplink Open, Foreground 등 생명주기 이벤트들은 수집되지 않습니다.

• iOS Extension 에서 이벤트를 전송하는 도중 해당 프로세스가 종료되는 경우, 이벤트는 전송되지 않고 다음에 Extension 이 실행되었을 때 다시 전송을 시도하게 됩니다. (App 이 실행되었을 때 다시 전송을 시도하지 않습니다.)

• iOS Extension 에 Airbridge SDK 를 활용하시는 경우, SKAdNetwork 의 전환값 측정이 제대로 작동하지 않게 되기 때문에 SKAdNetwork 기능을 사용하지 않으셔야 합니다.

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

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

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

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

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

1. https://example.com/.well-known/apple-app-site-association주소에서 아래 내용을 호스팅 합니다.

   예) 9JA89QQLNQ.com.apple.wwdc

2. Xcode > Project 파일 > Signing & Capabilities > Associated Domains 로 이동해주세요.

3. +버튼을 눌러 webcredentials:example.com을 추가해주세요.

Airbridge iOS SDK 는 1.28.0 버전 부터 Bitcode 를 지원하지 않습니다. (Xcode 14 부터 Bitcode 가 deprecate 되었습니다.)
하지만 App 프로젝트에서 Bitcode 를 사용하는 경우 아래와 같은 컴파일에러가 발생할 수 있습니다.

이 문제를 해결하기 위해서는 Podfile 파일에 아래와 같은 내용을 추가하거나 Xcode 에서 ENABLE_BITCODE 설정을 NO로 설정해주시면 됩니다.

Xcode 에서 ENABLE_BITCODE 설정을 NO 로 설정해주시면 됩니다.

Apple Appstore 에서는 Bitcode 를 Deprecate 하여 Bitcode 를 사용하는 .ipa 파일이 제출되어도 자동으로 Bitcode 를 제거합니다.

Airbridge iOS SDK 는 1.28.0 버전 부터 Xcode 13 및 iOS 9, 10 을 지원하지 않습니다.
해당 지원이 필요하신 경우, Airbridge iOS SDK 1.27.0 이하 버전을 사용해주셔야 합니다.