すべてのプロダクト
Search
ドキュメントセンター

Quick Tracking:基本的な機能

最終更新日:Oct 15, 2025

1 SDK の原則の概要

1.1 原則

SDK は 2 つの API 呼び出し方法を提供します。

  • aplus 環境変数を使用して API を直接呼び出す

  • SDK の aplus_queue に API コマンドを送信する

注: 2 つの方法から 1 つを選択しますが、混在させることもできます

1.1.1 aplus 環境変数を使用して API 操作を呼び出す

直接 API 呼び出しのコードは、次のフォーマットでより簡潔になります:

const { aplus } = ミニプログラムプラットフォーム環境変数 // WeChat wx、Alipay my、Byte tt、Baidu Swan など
aplus.${APIName}($arguments) // arguments は指定された API の入力パラメーターです。

APIName には以下が含まれます:

  1. setMetaInfo: SDK の既存のデフォルト設定を上書きします

  2. appendMetaInfo: SDK のデフォルト設定を追加します

  3. getMetaInfo: SDK の現在の構成を取得します。

  4. record: イベントログを送信するために使用されます

  5. sendPV: ページログを送信するために使用されます

arguments は各 API 呼び出しの入力パラメーターです

1.1.2 API 命令を命令キュー aplus_queue に送信する

SDK に API コマンドを送信するには、SDK のコマンドキュー aplus_queue にコマンドを送信します。 SDK はコマンドを実行します。 コマンドの形式は次のとおりです。

const { aplus_queue } =Mini Program Platform Environment Variables // 例: WeChat wx、Alipay my、Byte tt、Baidu Swan など
aplus_queue.push({
 	'action': "$APIName", 
  'arguments': [$arguments] // 引数は指定された API の入力パラメーターです。
})
  • action パラメーターは、命令を送信する API の名前を表します。 その入力パラメーターは文字列で、値は列挙値です。 使用可能な列挙値は次のとおりです

    • aplus.setMetaInfo: SDK の既存のデフォルト設定を上書きします

    • aplus.appendMetaInfo: 追加 SDK のデフォルト構成

    • aplus. getMetaInfo: SDK の現在の構成を取得します。

    • aplus. record: イベントログの送信に使用されます

    • aplus. sendPV: ページログの送信に使用されます

  • arguments パラメーターは、action で指定された API の入力パラメーターです。 形式は配列です。 配列内の要素の順序は、API で定義されている入力パラメーターの順序と同じです。

1.2 例

1.2.1 aplus 環境変数を使用して API 操作を呼び出す

const { aplus } =Mini Program Platform Environment Variables // 例: WeChat wx、Alipay my、Byte tt、Baidu Swan など

// SDK のデフォルト設定を上書きします。
aplus.setMetaInfo(metaName, metaValue);

// 追加 SDK のデフォルト設定。 このパラメーターは、metaValue パラメーターが Array または Object タイプの場合にのみ有効です。
aplus.appendMetaInfo(metaName, metaValue)

// SDK の現在の構成を取得します。
aplus.getMetaInfo(metaName);

// イベントログの送信に使用されます。
aplus.record(trackerEventCode, eventType, eventParams);

// ページログの送信に使用されます。
aplus.sendPV(pageEventConfig, userData);

1.2.2 API コマンドを aplus_queue コマンドキューに送信する

const { aplus_queue, aplus } =Mini Program Platform Environment Variables // 例: WeChat wx、Alipay my、Byte tt、Baidu Swan など

// SDK のデフォルト設定を上書きします。
aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: [metaName, metaValue]
});

// 追加 SDK のデフォルト設定。 このパラメーターは、metaValue パラメーターが Array または Object タイプの場合にのみ有効です。
aplus_queue.push({
  action: 'aplus.appendMetaInfo',
  arguments: [metaName, metaValue]
});

// SDK の現在の構成を取得します。
aplus.getMetaInfo(metaName);

// イベントログの送信に使用されます。
aplus_queue.push({
  action: 'aplus.record',
  arguments: [trackerEventCode, eventType, eventParams]
});

// ページログの送信に使用されます。
aplus_queue.push({
  action: 'aplus.sendPV',
  arguments: [pageEventConfig, userData]
});

2. ログ出力

const aplusConfig = {
	metaInfo: {
		...
		'DEBUG': true, // デバッグモードを有効にします。
  	...
	}
};

出力ログの例: image

3 日間のロゴ送付ポリシー

QuickTracking ミニプログラム SDK のデフォルトのイベントレポートポリシーは次のとおりです:

  • 非集約の通常の要求ログのレポート

  • リクエストログは1 秒ごとに送信されます。

  • デフォルトでは、ミニプログラムのネットワークリクエストチャネルは最大1 つまで占有されます。

  • デフォルトのリクエストタイムアウト期間は3 秒です。 デフォルトのリクエストタイムアウト期間の優先度は、一部のプラットフォームミニプログラムの優先度よりも低くなります。 app.json で networkTimeout を設定する (リンク例は WeChat ミニプログラムです)

オプション。3.1 ログの集約とレポートを有効にする

一部のシナリオでは、SDK リクエストレポートを集約したい場合があります。 SDK 構成項目 max-queue-count を追加して、集約レポート機能を完了できます。 例:

const aplusConfig = {
	metaInfo: {
		...
    // オプション。 集約するログエントリの数。 デフォルトでは、ログエントリは集約されません。 最大 1 ~ 5 を指定することをお勧めします。
		'max-queue-count': 1,  
  	...
	}
};

次の図に示すように、max-queue-count が 5 に設定されている場合、5 つのログエントリが収集された場合にのみ、リクエストがサーバーに送信されます。

数が 5 未満の場合は、ミニプログラムを終了すると自動的にレポートされます。

image

注:

  1. WeChat ミニプログラムでは、「短時間に多くのリクエストを開始すると、ミニプログラムの並列リクエストデータ量の制限がトリガーされます。同時に、リクエストが多すぎると、読み込みが遅くなるなどの問題が発生する可能性もあります。リクエストの数を合理的に制御し、リクエストをマージする必要さえあります。」と要求されています。したがって、前述の「ログ集約レポート」を使用することをお勧めします。

  2. max-queue-count の値を大きくしすぎないことをお勧めします。集約およびレポートされるレコードの数が多いほど、単一のリクエストログが占有する帯域幅が大きくなり、ネットワーク損失のリスクがあります。

オプション。3.2 SDK ネットワークリクエストが占有するチャンネル数を変更する

WeChat ミニプログラムなどの一部のミニプログラムプラットフォームでは、短時間でネットワークリクエストが多すぎると、ページのパフォーマンスに影響が出る可能性があるため、リクエスト数を制御し、リクエストをマージすることをお勧めします。詳細については、SDK 3.1 の説明をご参照ください。Quick Tracking ミニプログラムのデフォルトのネットワークリクエストチャンネルは最大で 1 つを占有します。次の例は、リクエストチャンネルを変更する方法を示しています:

const aplusConfig = {
	metaInfo: {
		...
    // オプション。同時リクエストチャンネルの最大数。デフォルト値: 1。有効な値: 1 から 5。
		'aplus-mini-requests-limit': 1,  
  	...
	}
};

オプション。3.3 SDK のデフォルトリクエストタイムアウト期間を変更する

デフォルトのネットワークリクエストタイムアウト期間は、ミニプログラムプラットフォームによって異なります。WeChat、Douyin、Alipay、DingTalk などの一部のプラットフォームでは、カスタムリクエストタイムアウト期間がサポートされています。SDK 設定項目 aplus-request-timeout を変更して、SDK リクエストタイムアウト期間をカスタマイズできます。デフォルトのタイムアウト期間は 3000ms です。設定例は次のとおりです:

const aplusConfig = {
	metaInfo: {
		...
    // オプション。 デフォルトのリクエストタイムアウト期間。 単位: ミリ秒。
		'aplus-request-timeout': 3000,
  	...
	}
};

注: すべてのプラットフォームミニプログラムは、app.json で networkTimeout の統一設定もサポートしています。 開発者が app.json で networkTimeout 構成を適用する場合、統一構成の優先度が高くなります。 次のスクリーンショットは、WeChat ミニプログラムの公式ドキュメントを示しています。 その他のプラットフォームミニプログラムについては、各プラットフォームの公式ドキュメントを参照してください。

image

4. 基本的なアプリケーション情報を構成する

SDK の導入セクションでは、一部のデフォルト設定を変更または追加できます

const aplusConfig = {
	metaInfo: {
    'appKey': '', // QuickTracking でアプリケーションを作成したときに入力した Appkey。このパラメーターは必須です。
    'trackDomain': '', // 必須。ログ収集およびレポート用のドメイン名。
    '_user_id': 'testUserId', // 必要に応じてミニプログラムのログインアカウント ID をレポートします。ユーザーアカウントの緯度データを計算および分析する必要がある場合
    'autoGetOpenid': true, // openid 設定を自動的に取得します (推奨!現在、WeChat ミニプログラムのみがサポートされています)
    'DEBUG': true, // デバッグログをオンにします。
    // '_hold': 'BLOCK', // 非同期シナリオでは、ログレポートをブロックする必要があります。OpenID パラメーターを設定した後、ログをレポートできます。
    'appVersion': ''// オプション。ミニプログラムのバージョン。デフォルト値: devtools。
	}
};

import { initQTSDK } from './utils/qt_mini.umd.js';
initQTSDK(aplusConfig);

MetaName

Meta 設定の説明

MetaValue の割り当ての説明

サポートされているバージョン

DEBUG

この機能を有効にすると、SDK トラッキングログがコンソールに返されます。

ログを開くには true、ログを閉じるには false

すべて

appVersion

現在のミニプログラムのバージョンを設定します

現在のミニプログラムのバージョンを入力します。

すべて

appKey

プラットフォームシステムでアプリケーションを作成したときに入力した Appkey

プラットフォームで追跡ミニプログラムに対応する appkey を取得する必要があります。

すべて

aplus-rhost-v

収集およびレポートドメイン名 (非推奨)

プラットフォームによって収集された情報を取得できます。

すべて

trackDomain

ドメイン名を収集してレポートします

プラットフォームによって収集された情報を取得できます。

v2.0.0 以降

autoGetOpenid

openid を自動的に収集します

ブール値。 デフォルト値は false です。

コードを使用して OpenID を取得できます。

すべて

_anony_id

デバイスの一意の識別子を設定します

ビジネス定義の匿名ユーザー ID

、Alipay の場合は alipayid、WeChat の場合は openid

すべて

_dev_id

WeChat ミニプログラムで unionid を設定します

WeChat ミニプログラムで unionid を設定します

すべて

_user_id

userid を設定します

カスタムログインアカウントの ID。

すべて

_hold

ホールドシグナルを送信します。 SDK ライフサイクル全体で_hold を複数回設定できます。 ただし、BLOCK と START の設定はペアで設定する必要があります。 そうしないと、ログレポートに影響します。

説明

BLOCK は、コマンドキュー aplus_queue によって送信される API コマンドのみを制御し、aplus 環境変数によって直接呼び出される API には影響しません。

列挙型。 使用可能な値と説明は次のとおりです。

  • 「START」: ログ送信を有効にします。

  • "BLOCK": ログの送信をブロックします。BLOCK 状態の前に、ログを送信する前の準備を完了できます。

すべて

max-queue-count

SDK ログ集約を有効にする

数値の値。 デフォルト値は未定義です。 1 ~ 5 の数値を構成できます。

すべて

aplus-request-timeout

SDK デフォルトのリクエストタイムアウト期間を設定します

number 型の値。単位: ミリ秒。デフォルト値は 3000ms です。サポートされているプラットフォームには、WeChat、Douyin、Alipay、DingTalk が含まれます。

v2.0.0 以降

aplus-mini-requests-limit

SDK によって同時に占有されるネットワークリクエストチャネルの最大数を設定します

数値の値。 デフォルト値は 1 です。 1 ~ 5 の値がサポートされています。

v2.0.8 以降

aplus-preset-events-disabled

SDK のデフォルト収集を無効にするために使用される事前定義イベント

デフォルト値は未定義です。 配列に値を割り当てることができます。 例:

'aplus-preset-events-disabled': [
 '$$_share', // 共有イベントを作成します。
 '$$_reach_bottom', // プレハブのボトミングイベント
 '$$_perf_warning', // プレハブのネットワークパフォーマンスイベント
 '$$_user_profile', // ユーザー属性レポートイベント。
 ]

v2.0.8 以降