MacOS

::: 팁

GitHub (opens new window)에서 MacOS SDK의 소스 코드를 가져올 수 있습니다.

MacOS SDK는 OSX 10.10 같거나 크다 필수입니다.

:::

최신 버전: 3.0.0

업데이트 시간: 2023-10-10

소스 코드：Source Code (opens new window)

1. SDK 구현

CocoaPods로 SDK를 설치합니다.

1. Podfile 내용 생성 또는 편집

Podfile을 생성하고 프로젝트(.xcodeproj) 파일과 같은 디렉토리에서 명령어를 실행합니다.

pod init

Podfile 내용을 다음과 같이 편집합니다:

platform :osx, '10.10'
target 'YourProjectTarget' do
  pod 'ThinkingSDKMacOS'
end

1. 설치 명령 실행

pod install

1. 업로드가 성공하면, 프로젝트 시작

명령어가 정상적으로 실행되면, SDK가 정상적으로 업로드되었음을 나타내는 .xcworkspace 파일이 생성됩니다. .xcworkspace 파일을 열어 프로젝트를 시작합니다 (주의: .xcodeproj 파일을 동시에 열 수 없습니다)

2. 초기 설정

초기화 작업을 완료합니다. 샘플 코드는 다음과 같습니다.

#import <ThinkingSDK/ThinkingSDK.h>

// SDK needs to be initialized on the main thread

NSString *appid = @"APPID";
NSString *url = @"SERVER_URL";
    
// the first way
[TDAnalytics startAnalyticsWithAppId:appid serverUrl:url];
    
// the second way
TDConfig *config = [[TDConfig alloc] init];
config.appid = appid;
config.serverUrl = url;
[TDAnalytics startAnalyticsWithConfig:config];

// SDK needs to be initialized on the main thread

let appid = "APPID";
let url = "SERVER_URL";

// the first way
TDAnalytics.start(withAppId: appid, serverUrl: url)

// the second way
let config = TDConfig(appId: appid, serverUrl: url)
TDAnalytics.start(with: config)

파라미터 설명:

• APPID: 프로젝트의 APPID, TE 프로젝트 관리 화면에서 획득 가능
• SERVER_URL: 데이터 전송 URL
  • SaaS 경우는 프로젝트 관리 → 데이터 전송 주소에서 확인해주세요
  • 프라이빗 구축 경우, 데이터 전송 주소을 지정할 수 있습니다
    

3. 주요 기능

주요 기능을 사용하기 전에, 유저 식별 규칙을 확인해 주세요.

SDK는 게스트 ID를 자동으로 생성하고, 로컬에 저장됩니다; 유저가 로그인하기 전에, 게스트 ID를 신분 식별 ID로 사용됩니다.

주의: 게스트 ID는 유저가 앱을 재설치할 때 리셋됩니다.

3.1 계정 ID

설정 유저가 로그인할 때, login을 호출하고 유저의 계정 ID를 설정할 수 있습니다. TE 플랫폼은 계정 ID를 신원 확인 ID로 사용하고 logout을 호출하기 전까지 유지합니다. login을 여러 번 호출하면 이전의 계정 ID가 덮어씌워집니다.

// The login unique identifier of the user, corresponding to the #account_id in data tracking. #Account_id now is TE
[instance login:@"TE"];

// The login unique identifier of the user, corresponding to the #account_id in data tracking. #Account_id now is TE
instance.login("TE");

이 방법으로는 로그인 이벤트가 전송되지 않습니다

3.2 공통 이벤트 속성 설정

공통 이벤트 속성은 모든 이벤트에 포함되는 속성입니다. setSuperProperties를 호출하여 설정할 수 있습니다. 이벤트를 전송하기 전에 공통 이벤트 속성을 설정해 주세요.

예: 플레이어의 레벨, 전투력, 보유한 아이템 등

NSDictionary *superProperties = @{
    @"channel": @"ta",
    @"age": @1,
    @"isSuccess": @YES,
    @"birthday": [NSDate date],
    @"object": @{
        @"key":@"value"
    },
    @"object_arr":@[
        @{
            @"key":@"value"
        }
    ],
    @"arr": @[@"value"],
};
[TDAnalytics setSuperProperties:superProperties];

var superProperties: [AnyHashable : Any] = [:]
superProperties["channel"] = "ta" 
superProperties["age"] = 1 
superProperties["isSuccess"] = true 
superProperties["birthday"] = Date() 
superProperties["object"] = [
    "key": "value"
]
superProperties["object_arr"] = [["key": "value"]] 
superProperties["arr"] = ["value"] 

//Set public event properties
TDAnalytics.setSuperProperties(superProperties)

공통 이벤트 속성은 캐시에 저장되며, 앱을 시작할 때마다 호출할 필요가 없습니다. 만약 호출한다면 setSuperProperties: 이전에 설정한 공통 이벤트 속성은 덮어씌워집니다.

• Key는 해당 속성의 이름으로 string 타입이며, 영문자와 숫자, "_"를 포함, 최대 50자. TE 시스템은 일괄적으로 소문자로 통일됩니다
• Value는 해당 속성의 값으로, String, Number, Boolean, Time, object, array, list object를 지원합니다.
• Boolean 타입의 속성을 업로드하고 싶은 경우, @YES와 @NO 또는 [NSNumber numberWithBool:YES]와 [NSNumber numberWithBool:NO]로 값을 지정해주세요. @true, @false, @TRUE, @FALSE를 사용하면 안 됩니다.

이벤트 속성, 유저 속성은 공통 이벤트 속성과 일치해야 합니다.

3.3 이벤트 전송

track을 호출하여 이벤트를 전송합니다. 사전에 데이터 트래킹 정책을 준비하고 전송하십시오. 아래는 모델 코드입니다. 예: 아이템 구매

NSDictionary *eventProperties = @{@"product_name": @"book"};
[TDAnalytics track:@"product_buy" properties:eventProperties];

let properties = ["product_name": "book"] as [String: Any]
TDAnalytics.track("product_buy", properties: properties)

이벤트 이름은 string 타입이며, 영문자와 숫자, "_"를 포함하여 최대 50자까지 입력 가능합니다.

3.4 유저 속성 설정

일반적인 유저 속성에 대해서는, UserSet을 사용하여 설정할 수 있지만, UserSet은 원래의 값을 덮어씁니다. 원래 해당 속성에 값이 없는 경우, 속성이 새로 생성됩니다. 아래는 코드 예시입니다.

// "username" is "ThinkingData"
[TDAnalytics userSet:@{@"username": @"ThinkingData"}];
// "username" is "TA"
[TDAnalytics userSet:@{@"username": @"TA"}];

//"username" is "ThinkingData"
TDAnalytics.userSet(["usernaame": "ThinkingData"])
//"username" is "TA"
TDAnalytics.userSet(["usernaame": "TA"])

4. 코드 예시 (Example Code)

아래의 코드 예시에 모든 작업이 포함되어 있으며, 아래 순서대로 사용하는 것을 권장합니다:

if (Authorized privacy policy) {
    // enable log
    [TDAnalytics enableLog:NO];
    
    // SDK needs to be initialized on the main thread
    NSString *appid = @"APPID";
    NSString *url = @"SERVER_URL";
    TDConfig *config = [[TDConfig alloc] init];
    config.appid = appid;
    config.serverUrl = url;
    [TDAnalytics startAnalyticsWithConfig:config];
    
    [TDAnalytics login:@"TD"];
    
    NSDictionary *superProperties = @{
        @"channel": @"ta",
        @"age": @1,
        @"isSuccess": @YES,
        @"birthday": [NSDate date],
        @"object": @{
            @"key":@"value"
        },
        @"object_arr":@[
            @{
                @"key":@"value"
            }
        ],
        @"arr": @[@"value"],
    };
    [TDAnalytics setSuperProperties:superProperties];
    
    NSDictionary *eventProperties = @{@"product_name": @"book"};
    [TDAnalytics track:@"product_buy" properties:eventProperties];
    
    // "username" is "ThinkingData"
    [TDAnalytics userSet:@{@"username": @"ThinkingData"}];
}