1 SDK 原則の概要
1.1 原則
SDK はコマンドベースの追跡方法を提供します。 aplus 環境変数のコマンドキュー aplus_queue にコマンドを送信できます。 aplus 環境変数は、要件に合わせてコマンドを実行します。 コマンド形式は次のとおりです。
aplus_queue.push({
'action': "$APIName",
'arguments': [$arguments] // 引数は指定された API の入力パラメーターです。
})
action パラメーターは、命令を送信する API の名前を表します。 入力パラメーターは文字列で、値は列挙値です。 使用可能な列挙値は次のとおりです。
setMetaInfo: SDK の既存のデフォルト設定を上書きします
appendMetaInfo: 追加 SDK のデフォルト構成
getMetaInfo: SDK の現在の構成を取得します。
record: イベントログの送信に使用されます
sendPV: ページログの送信に使用されます
arguments パラメーターは、action で指定された API の入力パラメーターです。 形式は配列です。 配列内の要素の順序は、API で定義されている入力パラメーターの順序と同じです。
1.2 例
// SDK のデフォルト設定を変更します。
aplus_queue.push({
action: 'aplus.setMetaInfo',
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 ログ出力
aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: ['DEBUG', true]
});
3 ログ送信戦略
イベントがトリガーされると、リアルタイムで報告されます。
4. 基本的なアプリケーション情報を構成する
SDK の導入セクションでは、いくつかのデフォルト設定を変更または追加できます
// 統合アプリケーションの appKey。
aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: ['appKey', 'xxxxxxx']
})
aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: ['aplus-rhost-v', 'quickaplus-Web-api.xxx.com.cn']
});
// デバッグモードを有効にします。
aplus_queue.push({
action: 'aplus.setMetaInfo',
arguments: ['DEBUG', true]
});
MetaName | メタ構成の説明 | MetaValue 割り当ての説明 | サポートされている MongoDB バージョン |
DEBUG | 有効にすると、コンソールは SDK 追跡ログを出力します | ログを開く場合は true、ログを閉じる場合は false | すべて |
appVersion | 現在の Web のバージョンを設定します | 現在の Web のバージョンを入力してください | すべて |
appKey | プラットフォームシステムでアプリケーションを作成したときに入力した Appkey | プラットフォームで埋め込まれた Web アプリケーションに対応する appkey を取得する必要があります。 | すべて |
aplus-rhost-v | 追跡およびレポート ドメイン (非推奨) | プラットフォームによって追跡された情報を取得できます。 | すべて |
trackDomain | 追跡およびレポート ドメイン | プラットフォームによって追跡された情報を取得できます。 | v2.0.0 から |
_dev_id | カスタムデバイス ID | このモードは、QuickTracking SDK によって自動的に生成されたデバイス ID を上書きします。 | すべて |
_user_id | userid を設定する | カスタムログインアカウントの ID。 | すべて |
_hold | ホールドシグナルを送信します。 SDK ライフサイクル全体で_hold を複数回設定できます。 BLOCK と START はペアで使用する必要があります。 そうしないと、ログ送信に影響します。 | 列挙型。 使用可能な値と説明は次のとおりです。
| すべて 注: このパラメーターは、aplus_queue.push API 呼び出しにのみ適用されます。 |
aplus-jsbridge-only | H5 レポートログスイッチ |
| すべて |
aplus-utm-expire-days | utm パラメーターの有効期限を設定する | デフォルトでは、現在のセッション期間が有効です。 utm パラメーターの有効期限を日単位でカスタマイズできます。 結果は Cookie に保存されます。 最大有効期限設定は、各ブラウザーでサポートされている Cookie の実際の最大有効期限によって異なります。 | v2.0.7 開始 |
aplus-preset-events-disabled | SDK デフォルト追跡を無効にするために使用されるプレハブイベント | デフォルト値は未定義です。 配列に値を割り当てることができます。 例:
| v2.0.9 開始 |