v2 개발자 가이드
SDK 연동
SDK 삽입
1. 필수 설정
SDK 설치
Cocoapod 환경에서 SDK 다운로드 방법
XCode 프로젝트 파일중 Podfile 파일에 다음과 같이 SDK를 추가합니다
1
pod 'RW'
Copied!
기존에 SDK를 한번 설치한 경우에는 설치할SDK 버전을 표시해야 하는 경우도 있습니다. 아래와 같이 설치할 SDK버전을 명시적으로 표시하면 됩니다.
1
pod 'RW', '~> 1.1.18'
Copied!
Podfile 에 해당라인을 추가한 후 Terminal 프로그램을 실행하여 다음의 명령을 수행합니다
1
pod install
Copied!
SDK 버전 업데이트의 경우 다음의 명령을 수행합니다.
1
pod update
Copied!
정상적으로 설치가 되면 아래와 같은 폴더 구조를 확인할 수 있습니다.
SDK 설치 - Cocoapod 사용하지 않을 경우
다운된 파일을 압축 해제하면 다음과 같은 파일이 확인 가능하고 이중 아래에 선택된 3개의 파일을 분석 대상 앱 프로젝트에 추가합니다.
프로젝트 선택후 마우스 우클릭, Add Files to 메뉴를 선택합니다.
앞에서 다운로드 받고, 압축 해제한 폴더에 들어가서 아래와 같이 추가 대상 파일을 선택하고, 화면 아래쪽 설정은 존재하는 모든 target에 포함되었는지 확인후 추가 하면 됩니다.
BuildSetting 에 아래와 같이 설정을 추가합니다.
xcode 가 12.3 이후 버전이고 빌드 과정에서 아래와 유사한 오류가 발생하는 경우가 있으며,
위의 경우에는 아래와 같이 설정을 하고, 빌드를 하면됩니다.
dotAuthorizationKey 등록
info.plist 파일을 Open As Source Code 방식으로 오픈한 후, 아래 코드를 추가합니다.
XML
1
<key>dotAuthorizationKey</key>
2
<dict>
3
<key>serviceNumber</key>
4
<string>xxxxx</string>
5
<key>expireDate</key>
6
<string>14</string>
7
<key>isDebug</key>
8
<string>true</string>
9
<key>isInstallRetention</key>
10
<string>true</string>
11
<key>isFingerPrint</key>
12
<string>true</string>
13
<key>accessToken</key>
14
<string></string>
15
<key>useMode</key>
16
<string>2</string>
17
</dict>
Copied!
추가한 코드 중
serviceNumber의 value를 올바른 값으로 변경해야 합니다. 와이즈트래커에 로그인하여 화면 상단의 Service 부분을 선택하면 앱 이름과 함께 올바른 Service Number 가 나타납니다. Service No. 옆의 숫자를 복사하여 serviceNumber의 value로 입력해주세요.
HTTP 통신 허용
http통신을 허용하기 위해 NSAppTransportSecurity 를 아래와 같이 추가합니다.
이전과 마찬가지로 info.plist 파일을 Open As Source Code 방식으로 오픈한 후, 아래 코드를 추가합니다.
1
<key>NSAppTransportSecurity</key>
2
<dict>
3
<key>NSAllowsArbitraryLoads</key>
4
<true/>
5
</dict>
Copied!
초기화
- 초기화 방법은 SceneDelegate 가 설정된 경우와 설정되지 않은 경우에 따라 달라집니다.
- SceneDelegate를 사용하지 않으면 AppDelegate에서 초기화작업을 하고, 그렇지 않고 SceneDelegate를 사용하면 SceneDelegate에서 이 작업을 해야 합니다.
1. iOS13 미만 (SceneDelegate 없음)
SceneDelegate 없음)AppDelegate의
didFinishLaunchingWithOptions 함수에 SDK를 Initialization하기 위한 코드를 다음과 같이 적용합니다. SDK가 정상적으로 초기화 되었을 때 아래와 같은 기본 분석이 가능합니다.- 앱 실행 및 방문수, 일/주/월순수방문수 등 방문과 관련된 지표
- 통신사, 단말기, 국가 등 방문자의 단말기 환경으로 부터 추출될 수 있는 지표
Swift
Objective-C
1
import DOT
2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
3
// S: Wisetracker SDK init
4
DOT.initialization(launchOptions, application: application)
5
#if DEBUG
6
DOT.checkDebugMode(true)
7
#else
8
DOT.checkDebugMode(false)
9
#endif
10
// E: Wisetracker SDK init
11
}
Copied!
1
#import <DOT/DOT.h>
2
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
3
// S: Wisetracker SDK init
4
[DOT initialization:launchOptions application:application];
5
#ifdef DEBUG
6
[DOT checkDebugMode:true]
7
#else
8
[DOT checkDebugMode:false]
9
#endif
10
// E: Wisetracker SDK init
11
}
Copied!
DOT가 사용되는 곳에서는
import DOT을 통해 import가 필요합니다. 이하 적용 예시에서는 import하는 부분이 생략되어 있습니다.2. iOS13 이상 (SceneDelegate 사용)
SceneDelegate 사용)👉 iOS13 이상이어도 SceneDelegate를 사용하지 않을 수도 있어요, 이 때에는 위의 SceneDelegate를 사용하지 않는 경우를 참조하세요.
SceneDelegate의 sceneDidBecomeActive함수에 SDK를 Initialization하기 위한 코드를 다음과 같이 적용합니다. SDK가 정상적으로 초기화 되었을 때 아래와 같은 기본 분석이 가능합니다.- 앱 실행 및 방문수, 일/주/월순수방문수 등 방문과 관련된 지표
- 통신사, 단말기, 국가 등 방문자의 단말기 환경으로 부터 추출될 수 있는 지표
Swift
Objective-C
1
import DOT
2
3
class SceneDelegate: UIResponder, UIWindowSceneDelegate {
4
...
5
func sceneDidBecomeActive(_ scene: UIScene) {
6
// S: Wisetracker SDK init
7
DOT.initialization(nil, application: UIApplication.shared)
8
#if DEBUG
9
DOT.checkDebugMode(true)
10
#else
11
DOT.checkDebugMode(false)
12
#endif
13
// E: Wisetracker SDK init
14
}
15
...
16
}
Copied!
1
#import <DOT/DOT.h>
2
3
@implementation SceneDelegate
4
...
5
- (void)sceneDidBecomeActive:(UIScene *)scene {
6
// S: Wisetracker SDK init
7
[DOT initialization:nil application:[UIApplication sharedApplication]];
8
#ifdef DEBUG
9
[DOT checkDebugMode:true]
10
#else
11
[DOT checkDebugMode:false]
12
#endif
13
// E: Wisetracker SDK init
14
}
15
...
16
@end
Copied!
페이지 분석을 위한 설정
페이지뷰, 페이지 체류시간 분석이 가능합니다. 각 ViewController 이동 시에 호출되는 delegate 함수에 다음과 같이 기본적인 페이지 분석을 위한 코드를 적용합니다.
Swift
Objective-C
HTML
1
override func viewWillAppear(_ animated: Bool) {
2
super.viewWillAppear(animated)
3
DOT.onStartPage()
4
}
Copied!
1
- (void)viewWillAppear:(BOOL)animated {
2
[super viewWillAppear:animated];
3
[DOT onStartPage];
4
}
Copied!
1
<!- 별도 설정 없이 자동분석 ->
Copied!
Hybrid App을 위한 설정
Hybrid 앱의 경우 앱 내에서 WebView 를 사용하여 웹 컨텐츠를 서비스 하기도 합니다. 이와 같이 Webview 에 의해서 보여지는 웹 컨텐츠의 경우에는 위에서 설명된 Native 화면과는 다른 방식으로 동작하기 때문에, 별도의 분석 코드 적용이 필요합니다. 분석 대상 앱이 만약 Hybrid 앱인 경우에는 아래의 코드를 참고하여 웹 컨텐츠도 분석할 수 있도록 적용을 해야합니다.
앱내에서 사용할 WKWebView의 Delegate 함수에 아래와 같이 분석코드를 적용합니다.
Swift
Objective-C
1
func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {
2
...
3
if (webView.isLoading) {
4
return;
5
}
6
DOT.setJavascriptInjectionIn(webView)
7
...
8
}
9
func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction, decisionHandler: @escaping (WKNavigationActionPolicy) -> Void) {
10
...
11
if let url = navigationAction.request.url{
12
let absoluteString = url.absoluteString
13
if (absoluteString.hasPrefix("jscall-dot")) {
14
let request: URLRequest? = navigationAction.request
15
DOT.setWkWebView(webView, reqeust: request)
16
decisionHandler(.cancel)
17
}
18
...
19
}
20
...
21
}
Copied!
1
- (void)webView:(WKWebView *)webView didFinishNavigation:(WKNavigation *)navigation {
2
if(webView.isLoading) {
3
return;
4
}
5
[DOT setJavascriptInjectionInWkWebView:webView];
6
}
7
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {
8
if([@"jscall-dot" isEqualToString:navigationAction.request.URL.scheme]) {
9
NSURLRequest *request = navigationAction.request;
10
decisionHandler(WKNavigationActionPolicyAllow);
11
[DOT setWkWebView:webView reqeust:request];
12
}
13
}
Copied!
모바일앱내 웹뷰와 PC 혹은 모바일웹뷰로 동시에 사용하는 화면인 경우 아래와 같은 웹킷뷰를 포함한 viewController의 viewWillApeear에 아래와 같이 적용해주세요.
Swift
Objective-C
1
override func viewWillAppear(_ animated: Bool) {
2
super.viewWillAppear(animated)
3
4
webView.evaluateJavaScript("navigator.userAgent") { (userAgent, error) in
5
if let ua = userAgent {
6
self.webView.customUserAgent = ua as! String + " RW2SDK"
7
}
8
}
9
}
Copied!
1
Copied!
2. 고급 설정
고급 설정이란 반드시 적용할 필요는 없지만 와이즈트래커의 확장된 분석기능을 활용하기 위해 추가해야 하는 설정을 말합니다. 필요에 따라 선택적으로 설정을 추가해주시기 바랍니다.
Universal Link 설정
유니버셜 링크 설정 가이드는 별도의 문서에 정리되어 있습니다.
Universal Link 분석
continueUserActivity 부분에 아래와 같이 적용이 되면 유니버셜 링크를 통한 광고분석이 가능합니다.
Swift
1
func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
2
if let uniLink = userActivity.webpageURL?.absoluteString {
3
DOT.setDeepLink(uniLink)
4
}
5
return false;
6
}
Copied!
딥링크 설정
- 딥링크가 설정된 url 을 통해서 오픈된 이벤트를 분석합니다. 분석을 하기 위해서는 앱에 custom url scheme 설정해야 합니다.
딥링크 분석
- 앱이 설치된 이후 DeepLink를 통해서 앱이 실행되는 경로 분석이 필요한 경우 아래와 같이
setDeepLink함수를 사용하면 분석이 가능합니다.
Swift
Objective-C
1
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
2
DOT.setDeepLink(url.absoluteString)
3
return true
4
}
Copied!
1
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
2
[DOT setDeepLink:[url absoluteString]];
3
return YES;
4
}
Copied!
Facebook 광고 성과 측정
Facebook 앱에서 유입되는 설치수를 분석하기 위해서는 Facebook에서 제공하는 SDK가 분석 대상 앱에 설치가 선행되어야 합니다.
FBSDK 다운로드 방법
1) XCode 프로젝트 파일중 Podfile 파일에 다음과 같이 SDK를 추가합니다
1
pod 'FacebookSDK'
Copied!
2) Podfile 에 dependency 를 추가한 뒤에는 Terminal 프로그램을 실행하여 다음의 명령을 수행합니다
1
cmd> pod install
Copied!
FBSDK 설치 방법
1) info.plist 파일을 source로 보기 로 오픈합니다
2) 이름 속성 아래에 포함된 내용중 [APP\_ID] 와 [APP\_NAME] 부분을 Facebook Developer Site 에서 제공하는 값으로 치환후 info.plist 파일에 저장합니다
1
<key>CFBundleURLTypes</key>
2
<array>
3
<dict>
4
<key>CFBundleURLSchemes</key>
5
<array>
6
<string>fb[APP_ID]</string>
7
</array>
8
</dict>
9
</array>
10
<key>FacebookAppID</key>
11
<string>[APP_ID]</string>
12
<key>FacebookDisplayName</key>
13
<string>[APP_NAME]</string>
Copied!
FBSDK 로부터 Install Referrer를 수신하고, SDK에 전달하는 방법
사용자가 Facebook에 노출된 광고를 클릭하고 앱을 설치한 경우 설치된 앱에서는 FBSDK를 통해서 AppLinkData를 수신받을 수 있습니다. 아래의 코드에서 FBSDK로부터 AppLinkData를 수신 받고, 수신 받은 AppLinkData 를 SDK로 전달하는 방법을 확인할 수 있습니다. 이 함수는 appDelegate의
didFinishLaunchingWithOptions 함수에 적용하세요. SDK 초기화 API initialization 호출 전에 적용해주세요.Swift
Objective-C
1
import FBSDKCoreKit
2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
3
AppLinkUtility.fetchDeferredAppLink({ url, error in
4
if error != nil {
5
if let anError = error {
6
print("Received error while fetching deferred app link \(anError)")
7
}
8
}
9
if let unwrappedUrl = url {
10
DOT.setFacebookreferrerData(unwrappedUrl)
11
}
12
})
13
}
Copied!
1
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
2
[FBSDKAppLinkUtility fetchDeferredAppLink:^(NSURL *url, NSError *error) {
3
if(error) {
4
NSLog(@"Received error while fetching deferred app link %@", error);
5
}
6
if(url) {
7
[DOT setFacebookreferrerData:url];
8
}
9
}];
10
}
Copied!
Facebook SDK와 관련하여 보다 자세한 설치 방법은 아래의 링크에서 확인이 가능합니다.
앱 설치 경로 측정
앱이 설치된 경로를 분석하는 시점은 앱 설치 후 처음 실행될 때 설치 경로를 획득하게 됩니다. 이에 대한 처리는 기본적으로 위에서 설명된 SDK 필수 적용 사항이 적용된 상태에서는 자동으로 처리가 되기 때문에 별도의 분석코드 적용이 필요하지 않습니다. 다만 앱의 특별한 상황에 의해서 앱에서 수신된 설치 경로 정보를 SDK에 직접 설정하고자 하는 경우에는 다음의 코드를 사용하세요.
AppDelegate 정의 항목중
didFinishLaunchingWithOptions 함수 정의에서 파라미터로 전달받은 launchOptions 로 부터 설치 경로를 직접 획득 후 수신된 값을 setInstallReferrer 함수를 사용해서 SDK로 전달할 수 있습니다. 다만 주의할 사항은 아래와 같이 직접 앱 설치 경로를 SDK에 설정하는 경우 해당 코드가 매 실행 시점마다 반복해서 실행되지 않고 앱 설치 후 최초 1회만 동작하도록 적용되어야 합니다. 또한 아래의 코드는 반드시 SDK initialization() 함수 호출 이후 에 적용되어야 합니다.Swift
Objective-C
1
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
2
if let referrer = launchOptions?[.url] as? URL {
3
let _installReferrer:Referrer = Referrer();
4
_installReferrer.referrer = referrer.absoluteString;
5
DOT.setInstallReferrer(_installReferrer);
6
}
7
}
Copied!
1
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
2
NSURL *referrer = [launchOptions valueForKey:UIApplicationLaunchOptionsURLKey];
3
if (referrer){
4
Referrer *_installReferrer = [Referrer alloc];
5
_installReferrer.referrer = referrer.absoluteString;
6
[DOT setInstallReferrer:_installReferrer];
7
}
8
}
Copied!
4. iOS 14 개인정보방침 변경 관련 가이드
- iOS 14부터 IDFA를 획득하기 위해서는 사용자의 동의를 얻어야 합니다.
3.1 info.plist파일에 NSUserTrackingUsageDescription 설정 추가
1
<key>NSUserTrackingUsageDescription</key>
2
<string>Your data will be used to deliver personalized ads to you.</string>
Copied!
3.2 App Tracking Transparency 동의 System Alert 노출 & API 호출
- IDFA 획득을 위해 앱 추적 투명성 동의 요청 System Alert(대화 상자)을 띄워야 합니다. 동의 요청 System Alert(대화 상자) 화면에 띄우려면 requestTrackingAuthorizationWithCompletionHandler:를 호출합니다. completionHandler에서 동의 시 SDK API를 호출하도록 위와 같이 구현하시면 됩니다.
Swift
Objective-C
1
import AppTrackingTransparency
2
import AdSupport
3
if #available(iOS 14, *) {
4
ATTrackingManager.requestTrackingAuthorization { (AuthorizationStatus) in
5
if(AuthorizationStatus == .authorized) {
6
DOT.setIDFA(ASIdentifierManager.shared().advertisingIdentifier.uuidString)
7
}
8
}
9
} else {
10
DOT.setATTAuthorizationStatus(3)
11
}
Copied!
1
#import <AppTrackingTransparency/ATTrackingManager.h>
2
#import <AdSupport/AdSupport.h>
3
if (@available(iOS 14, *)) {
4
[ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {
5
if(status == ATTrackingManagerAuthorizationStatusAuthorized) {
6
[DOT setIDFA:[[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString]];
7
}
8
}];
9
} else {
10
[DOT setATTAuthorizationStatus:3];
11
}
Copied!
Last modified 2mo ago
Copy link
Contents
1. 필수 설정
SDK 설치
SDK 설치 - Cocoapod 사용하지 않을 경우
dotAuthorizationKey 등록
HTTP 통신 허용
초기화
페이지 분석을 위한 설정
Hybrid App을 위한 설정
2. 고급 설정
Universal Link 설정
딥링크 설정
Facebook 광고 성과 측정
앱 설치 경로 측정
4. iOS 14 개인정보방침 변경 관련 가이드
3.1 info.plist파일에 NSUserTrackingUsageDescription 설정 추가
3.2 App Tracking Transparency 동의 System Alert 노출 & API 호출