Quick Tracking:埋め込み API

1. トラッキングソリューションを表示するにはどうすればよいですか?

ポイントを埋め込む前に、ポイントを埋め込む場所とどのポイントを埋め込むかを決定する必要があります。つまり、ポイントを埋め込むための明確な要件を整理する必要があります。クイックトラッキングプラットフォームでは、明示的なトラッキング要件はトラッキングソリューションと呼ばれ、トラッキングソリューション用に仕様テンプレートが設計されています。例：

埋め込みポイントスキームでは、必要な埋め込みポイントは次のとおりです。

1. イベント件名：「誰が」このイベントをトリガーしたかを指し、デバイス ID とアカウント ID に分かれています。報告されたイベントには、これらのいずれかが含まれている必要があります。

• デバイス ID：macOS デバイスのデフォルトのデバイス ID は、アプリケーションレベルで一意のデバイス ID です。デバイス ID は、クイックトラッキング SDK によって自動的に生成されるか、setCustomDeviceId 操作を呼び出すことによって設定されます。

• アカウント ID：クライアントユーザーがシステムにログインするためのアカウント ID。ユーザーが異なるデバイスからログインすると、デバイス ID は変更されますが、アカウント ID は変更されません。たとえば、ユーザーが 2 台のコンピューターを使用してそれぞれログインする場合などです。

2. ユーザー属性：アカウント ID の属性。たとえば、「testdemo@111」のアカウント ID、「1999-02-13」の「誕生日」、「プラチナ」の「メンバーレベル」などを持ちます。「誕生日」と「メンバーシップ」の評価はユーザー属性です。

3. グローバル属性：グローバル設定後に各イベントによって一度伝達される属性

4. ページ閲覧イベント：ページの読み込み中に報告されるイベント（トラッキングスキームでページコードとイベントコードが等しいイベントも青色でマークされます）

5. クリック、露出、カスタムイベント：クライアントユーザーがクライアントと対話するときに報告されるイベント。

指示メモ

• 入力パラメーターサイズの制限：

2. プリファブイベントを適用する

2.1 アプリケーション起動イベントを手動でトリガーするには

インターフェース関数：

// アプリケーション起動イベントを手動でトリガーします。
-(void)trackAppStart:(NSDictionary *_Nullable)properties;

パラメーター:

例：

NSDictionary *appStartProperties = @{
    @"appStartTest": @"appStartTest",
    @"times": @1024,
    @"subContents": @[@"test1", @"test2", @"test3"]
};
[[QuickTrackingSDK sharedInstance] trackAppStart:appStartProperties];

2.2 アプリケーション終了イベントを手動でトリガー

インターフェース関数：

// アプリケーション終了イベントを手動でトリガーします。
-(void)trackAppEnd:(NSDictionary *_Nullable)properties;

パラメーター:

例：

NSDictionary *appEndProperties = @{
    @"appEndTest": @"appEndTest"
};
[[QuickTrackingSDK sharedInstance] trackAppEnd:appEndProperties];

3 デバイス ID

SDK はカスタムデバイス ID をサポートしています。カスタムデバイス ID を使用する場合は、setCustomDeviceId API パラメーターを有効な値に設定する必要があります。デフォルト値は、暗号化されたデバイスの一意の識別子です。

3.1 カスタムデバイス ID

インターフェース関数：

// カスタムデバイス ID を指定します。
-(void)setCustomDeviceId:(NSString *_Nonnull)customDeviceID;

パラメーター:

例：

[[QuickTrackingSDK sharedInstance] setCustomDeviceId:@"your_deviceId"];

3.2 デバイス ID を読み取る

インターフェース関数：

// デバイス ID を読み取ります。
-(NSString *_Nullable)getDeviceID;

例：

NSString *deviceID = [[QuickTrackingSDK sharedInstance] getDeviceID];

注：

このメソッドは SDK の初期化完了に依存しており、null 値を返す場合があります

4 アカウント ID

4.1 ユーザーログイン

Quick Tracking SDK は、ユーザーをカウントする際にデバイスを標準として使用します。独自のアカウントをカウントする必要がある場合は、次のメソッドを使用します。

インターフェース関数：

// アプリケーションにログインします。
- (void)onProfileSignIn:(NSString *_Nonnull)userId;

パラメーター:

例：

[[QuickTrackingSDK sharedInstance] onProfileSignIn:@"your_userId"];

4.2 ユーザーログアウト

ユーザーアカウントのバインドが不要になった場合は、SDK が提供するユーザーログアウトメソッドを呼び出すことができます。ユーザーログアウトメソッドが呼び出されると、SDK はユーザーアカウント関連のコンテンツを送信しなくなります。

インターフェース関数：

// ログアウトします。
- (void)onProfieSignOff;

例：

[[QuickTrackingSDK sharedInstance] onProfieSignOff];

5. ユーザー属性をアップロードする

イベントエンコーディングは $$_user_profile カスタムイベントアップロードとして固定されており、イベントによって伝達されるイベント属性はユーザーテーブルにユーザー属性として配置されます。

インターフェース関数：

// ユーザー properties をアップロードします。
- (void)uploadUserProfile:(NSDictionary *_Nullable)properties;

パラメーター:

例：

NSDictionary *userProfile = @{
  @"name": @"your_name",
  @"email": @"example@example.com"
};
[[QuickTrackingSDK sharedInstance] uploadUserProfile:userProfile];

注：

SDK はユーザー properties をキャッシュしません。ユーザー properties を報告するには、ユーザーアカウントを呼び出して API onProfileSignIn を設定し、データの精度を確保する必要があります。

6. グローバル属性

6.1 グローバル属性を登録する

インターフェース関数：

// グローバル properties を設定します。
-(void)registerGlobalProperties:(NSDictionary * _Nonnull)properties;

パラメーター:

例：

[[QuickTrackingSDK sharedInstance] registerGlobalProperties:@{
    @"content": @"Test",
    @"times": @1024,
    @"subContents": @[@"abc", @"def", @"ghi"]
}];

注：

既存のグローバル属性のキーが既存のグローバル属性のキーと同じ場合は、既存の値が更新されます。既存のグローバル属性のキーが既存のグローバル属性のキーと異なる場合は、新しいグローバル属性が挿入されます。

6.2 グローバル属性を削除する

インターフェース関数：

// キーに基づいてグローバル属性を削除します。
-(void)unregisterGlobalProperty:(NSString *_Nonnull)propertyName;

パラメーター:

例：

[[QuickTrackingSDK sharedInstance] unregisterGlobalProperty:@"your_key"];

6.3 キーに基づいて単一のグローバル属性を取得するには

インターフェース関数：

// キーに基づいてグローバル properties を取得します。
-(id _Nullable)getGlobalProperty:(NSString *_Nonnull)propertyName;

パラメーター:

戻り値:

例：

id value = [[QuickTrackingSDK sharedInstance] getGlobalProperty:@"your_key"];

6.4 すべてのグローバル属性を取得する

インターフェース関数：

// すべてのグローバル属性を取得します。
-(NSDictionary *_Nullable)getGlobalProperties;

戻り値:

例：

NSDictionary *globalProperties = [[QuickTrackingSDK sharedInstance] getGlobalProperties];

6.5 すべてのグローバル属性をクリアする

インターフェース関数：

// すべてのグローバル属性をクリアします。
-(void)clearGlobalProperties;

例：

[[QuickTrackingSDK sharedInstance] clearGlobalProperties];

7. ページ閲覧イベント

使用する前に、QuickTracking 管理バックグラウンドのデータ収集-> トラッキング管理-> イベント管理モジュールに移動して、対応するページイベントを作成し、プロジェクトに対応するページコード（page_ name）を渡してください。

7.1 ページ起動

インターフェース関数：

// ページエントリ動作の統計
+(void)onPageStart:(id _Nonnull)pageContext page_name:(NSString * _Nonnull)page_name options:(NSDictionary *_Nullable)options;

パラメーター:

例：

NSDictionary *pageOptions = @{
    @"url": @"your_url",
    @"page_title": @"your_page_title"
};
[QuickTrackingSDK onPageStart:self page_name:@"your_page_name" options:pageOptions];

7.2 ページ離脱

インターフェース関数：

// ページ離脱動作をカウントします。
+(void)onPageEnd:(id _Nonnull)pageContext page_name:(NSString * _Nonnull)page_name;

パラメーター:

例：

[QuickTrackingSDK onPageEnd:self page_name:@"your_page_name"]; // QuickTrackingSDK onPageEnd:self page_name:@"your_page_name" を呼び出します。

7.3 ページイベントのプロパティを設定する

インターフェース関数:

// ページイベントのプロパティを設定します。
+(void)updatePageProperties:(id _Nonnull)pageContext page_name:(NSString *_Nonnull)page_name properties:(NSDictionary *_Nonnull)properties;

パラメータ:

例:

NSDictionary *pageProperties = @{
    @"page_type": @"main", // ページタイプ
    @"user_role": @"admin" // ユーザーロール
};
[QuickTrackingSDK updatePageProperties:self page_name:@"your_name" properties:pageProperties];

8. イベント追跡

カスタムイベントは、ユーザーの動作を追跡し、動作発生の具体的な詳細を記録するために使用できます。

使用する前に、クイックトラッキング管理バックグラウンドのデータ収集 > トラッキング管理 > イベント管理モジュールに移動し、カスタムイベントを作成してから、プロジェクトで対応するイベントコードを渡します。

インターフェース関数：

// トラッキングイベント。
- (void)event:(NSString *_Nonnull)eventCode;
// トラッキングイベントにはイベント属性があります。
- (void)event:(NSString *_Nonnull)eventCode properties:(NSDictionary *_Nullable)properties;
// トラッキングイベントはページコードでエンコードされます。
- (void)event:(NSString *_Nonnull)eventCode page_name:(NSString *_Nonnull)page_name;
// ページコードとイベント属性を持つイベントを追跡します
- (void)event:(NSString *_Nonnull)eventCode page_name:(NSString *_Nonnull)page_name properties:(NSDictionary *_Nullable)properties;

パラメーター:

例:

// トラッキングイベント。
NSString *eventCodeSimple = @"your_event_code";
[[QuickTrackingSDK sharedInstance] event:eventCodeSimple];

// ページ属性を持つトラッキングイベント
NSString *eventCodeWithProperties = @"your_event_code";
NSDictionary *yourProperties = @{
    @"item_name": @"your_item_name",
    @"item_price": @20
};
[[QuickTrackingSDK sharedInstance] event:eventCodeWithProperties properties:yourProperties];

// トラッキングイベントはページコードでエンコードされます。
NSString *eventCodeWithPage = @"your_event_code";
NSString *page_name = @"homepage";
[[QuickTrackingSDK sharedInstance] event:eventCodeWithPage page_name:page_name];

// ページコードとイベント属性を持つイベントを追跡する
NSString *eventCodeWithPageWithProperties = @"your_event_code";
NSString *page_name = @"settings_page";
NSDictionary *properties = @{
    @"button_name": @"save_settings",
    @"user_id": @"test"
};
[[QuickTrackingSDK sharedInstance] event:eventCodeWithPageWithProperties page_name:page_name properties:properties];

9. その他

9.1 SDK を無効にするには

この操作を呼び出した後、SDK はイベントを収集せず、ネットワークリクエストを送信しません。

主な機能：

// SDK を無効にします。
+(void)disableSDK;

例:

[QuickTrackingSDK disableSDK];

9.2 SDK を開く

SDK が無効になっている場合、SDK が呼び出された後にデータ収集機能が復元されます。

インターフェース関数:

// SDK を有効にします。
+(void)enableSDK;

例：

[QuickTrackingSDK enableSDK];