MacOS

TIP

GitHub (opens new window)でMacOS SDKのソースコードを取得できます。

MacOS SDKはOSX 10.10以上必要です

最新バージョン: 3.0.0

更新時間: 2023-10-10

ダウンロード：Source Code (opens new window)

SDK実装

CocoaPodsでSDKをインストールします。

1.Podfileの内容を作成、または編集します

Podfile を作成し、プロジェクト (.xcodeproj) ファイルと同じディレクトリでコマンドを実行します。

pod init

Podfile の内容を次のように編集します：

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

2.インストールコマンドを実行

pod install

3.インポートが成功したら、プロジェクトを開始します

コマンドが正常に実行されると、SDK が正常にインポートされたことを示す .xcworkspace ファイルが生成されます。 .xcworkspace ファイルを開いてプロジェクトを開始します (注: .xcodeproj ファイルを同時に開くことはできません)

初期設定

初期化操作を完了します。サンプル コードは次のとおりとなります。

#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の場合はプロジェクト管理→データアクセスURLにて確認してください
  • プライベート構築の場合は、データ送信URLを指定することが可能
    

メイン機能

メイン機能を利用する前に、ユーザー識別ルールを確認してくだ；

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：以前設定した共通イベントプロパティは上書きされます。

• イベントのプロパティは一つNSDictionaryの対象となり、エレメントごとでプロパティを分けられます
  • Key は当プロパティの名称でstringタイプで、英文字と数字、 "_"を含め、最大50文字。TEシステムは一律で小英文字に統一されます
  • Value は当プロパティの値で、String, Number, Bloon, Time, object, array, list objectを対応しております。
  • Bloonタイプのプロパティをアップロードしたい場合は、@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 ユーザープロパティ設定

一般のユーザープロパティに関しては、user_setを利用して設定することができますが、 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"])

コード例のまとめ

以下のコード例で全ての操作が含まれます、以下の順で利用推奨しております：

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"}];
}