MIIT コンプライアンス初期化で SDK 統合を設定 - Quick Tracking

基本的な統合

1. ドメイン設定

事前初期化メソッドを呼び出す前に、開発者は setTrackDomain API を呼び出して、SDK の他の API を呼び出す前に、プライベート化環境のデータ収集エンドポイントを設定する必要があります。

import { setTrackDomain } from '@quicktracking/analytics';

// 統計ログをアップロードするためのプライマリドメインと代替ドメインを設定します。
// SDK は、最初にプライマリドメインに統計を報告します。 失敗した場合、代替ドメインへのデータの報告を再試行します。
// プライマリドメイン primaryDomain または null または空の文字列を指定することはできません。 null または空の文字列が指定されている場合、SDK は「ドメインを空にすることはできません。 ドメイン設定を確認してください！」という例外ログを出力します。
// 代替ドメインには null または空の文字列を指定できます。 この場合、SDK は代替ドメインがプライマリドメインとまったく同じであるとみなします。 SDK がデータのアップロードに失敗した後、データは 2 回目にプライマリドメインに報告されます。
// 入力されるドメインパラメータには、「https://」プレフィックスが含まれている必要があります。

function setTrackDomain(primaryDomain: string, standaryDomain?: string)

値	説明
primaryDomain	ログをアップロードするためのプライマリデータ収集エンドポイントのアドレス。
standaryDomain	ログをアップロードするための代替データ収集エンドポイントのアドレス。

注: HTTP および HTTPS プレフィックスのみがサポートされています。プロトコルプレフィックスを指定しない場合、デフォルトで HTTPS が使用されます。

2. コンプライアンス初期化

工業情報化部 (MIIT) のコンプライアンス要件のため、アプリケーションはユーザーがプライバシーポリシーに同意するまで個人情報を取得できません。したがって、QuickTracking Next の SDK は、事前初期化と初期化の 2 つのステップに分かれています。コンプライアンス初期化を完了するには、次の操作を実行します。

アプリにプライバシーポリシーがあり、ユーザーが初めてアプリを起動したときにプライバシーポリシーがポップアップ表示され、ユーザーの同意が得られることを確認する必要があります。
QuickTrackingSDK 収集サービスを選択したことをユーザーに通知する必要があります。次の参照句をプライバシーポリシーに追加してください。「当社の製品は QuickTracking SDK を統合しています。QuickTracking SDK は、統計分析サービスを提供するために、OAID /Huawei AAID/SIM カード IMSI 情報 / ハードウェアシリアル番号 /MCC (モバイル国別コード) および MNC (モバイルネットワーク番号) を収集する必要があります。
プライバシーポリシーに同意した後にのみ、QuickTracking SDK を初期化できます。

2.1. 事前初期化 API

SDK 事前初期化 API を呼び出します。事前初期化 API 呼び出しでは、デバイス情報の追跡や QuickTracking 収集サービスへのデータの報告は行われません。

2.1.1. API の説明

import { preInit } from '@quicktracking/analytics';

function preInit(cfg: UMConfig):void

2.1.2. パラメータの説明

オプション	パラメータ	説明	必須
context	common.ApplicationContext	アプリケーション環境コンテキスト変数	はい
appKey	string	アプリケーションの一意の識別子。入力パラメータの appkey は、QT バックエンドの appkey と同じである必要があります。 appKey は各イベントログとともに報告され、QT のアプリケーションプラットフォームデータを識別するために使用されます。	はい
plugins	BasePlugin \| BasePlugin[]	現在開いているプラグイン	はい
channel	string	アプリケーションがリリースされるチャネル。詳細については、「システムプロパティのアップグレードチャネル」をご参照ください。	いいえ
enableLog	boolean	デバッグログを有効にするかどうか。デフォルト値: false。	いいえ
enableJSBridge	boolean	H5 ブリッジを有効にするかどうかを指定します。デフォルト値: false。	いいえ
enableAutoTrackApplication	boolean	EDAS アプリケーションライフサイクルの自動追跡を有効にするかどうかを指定します。デフォルト値: true。	いいえ
enableAutoTrackPage	boolean	自動追跡ページが有効になっているかどうかを示します。デフォルト値: true。	いいえ

2.2. API init の初期化

ユーザーがプライバシー契約に同意した後、SDK 初期化 API が呼び出されます。ログの追跡と送信は、init メソッドが呼び出された後にのみ開始されます。

2.2.1. API の説明

import { init } from '@quicktracking/analytics';

function init():Promise<void>

2.3. SDK を呼び出して API を初期化する

アプリケーションモジュールディレクトリに、abilityStage プロジェクトファイル (例: entry/src/main/ets/abilityStage/MyAbilityStage.ets) を追加します。特定の場所のスクリーンショットは次のとおりです。

srcEntry を module.json5 ファイルに追加して、abilityStage ファイルのアドレスを指すようにします。

2.3.1. 完全な呼び出し例

import AbilityStage from '@ohos.app.ability.AbilityStage';
import { preInit, InternalPlugin, setLogEnabled, init, setTrackDomain } from '@quicktracking/analytics';

setLogEnabled(true); // デバッグログを有効にします。
setTrackDomain("プライマリデータ収集エンドポイント", "サブデータ収集エンドポイント"); // 収集ドメインを設定します。

export default class MyAbilityStage extends AbilityStage {
  onCreate() {
    preInit({
      appKey: 'Your AppKey',
      context: this.context.getApplicationContext(),
      enableJSBridge: true,
      enableAutoTrackApplication: true,
      enableAutoTrackPage: true,
      plugins: [new InternalPlugin()]
    });
    init();
  }
}

注意:! ! ! preInit メソッドが呼び出された後、ログの追跡と送信は、init メソッドが呼び出され、ユーザーがプライバシーポリシーに同意する権限を与えられた後にのみ開始されます。

3. ログ出力

sdk ログは、setLogEnable API をアクティブに呼び出すことで有効または無効にすることができます。

import { setLogEnabled } from '@quicktracking/analytics';

function setLogEnabled(enable: boolean):void

値	説明
enable	sdk ログを有効にするかどうか。デフォルトでは、false は無効になっています。

注:

初期化中に LOG を表示する場合は、初期化メソッドを呼び出す前に必ず LOG スイッチをオンにしてください。
ログは 3 つのレベルに分かれています。

error SDK の統合または実行時に関するエラーメッセージを出力します。
warn sdk の警告メッセージを出力します。
info sdk のプロンプト情報を出力します。