すべてのプロダクト
Search

このプロダクト

    Quick Tracking:Web SDK の基本的な機能

    ドキュメントセンター

    Quick Tracking:Web SDK の基本的な機能

    最終更新日:Jun 09, 2026

    QuickTracking Web SDK を使用して、命令ベースの API 経由でイベントログとページビュー (PV) ログを送信します。

    1. SDKの概要

    1.1. 仕組み

    SDK は命令ベースの API を使用します。ほとんどの操作では、aplus 環境変数の aplus_queue キューに命令をプッシュします。一部の API は、aplus オブジェクトから直接呼び出されます。

    aplus_queue.push({
    'action': "$APIName", 
    'arguments': [$arguments] // arguments は、指定された API の入力パラメーターです。
})

    • action パラメーターは API 名を指定します。指定可能な値：

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

      • aplus.appendMetaInfo：SDK のデフォルト設定に追加します。

      • getMetaInfo: 現在の SDK の設定を取得します。

      • record: イベントログを送信します。

      • sendPV: ページビュー (PV) ログを送信します。

      • recordAppLink: アプリケーションの起動イベントを送信します。

    • arguments パラメーターは、指定された 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', 'Your_AppKey']
})

aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ['trackDomain', 'Your_Data_Collection_Service_Endpoint']
});

// デバッグモードを有効にします。
aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ['DEBUG', true]
});

    MetaName

    説明

    metaValueの説明

    対応バージョン

    DEBUG

    SDK のインストルメンテーションログをコンソールに出力します。

    true はログを有効化し、false は無効化します。

    すべて

    appVersion

    Web アプリケーションの現在のバージョン。

    Web アプリケーションのバージョン文字列。

    すべて

    appKey

    アプリケーション作成時に割り当てられる appKey。

    プラットフォームから appKey を取得します。

    すべて

    aplus-rhost-v

    データ収集ドメイン名 (非推奨)。

    プラットフォームから取得します。

    すべて

    trackDomain

    データ収集ドメイン名。

    プラットフォームから取得します。

    v2.0.0 以降

    _dev_id

    カスタムデバイス ID。

    QuickTracking が自動生成するデバイス ID を上書きします。

    すべて

    _user_id

    ユーザー ID を設定します。

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

    すべて

    _hold

    ホールドシグナルを送信します。SDK のライフサイクル中に _hold を複数回設定できますが、BLOCK と START はペアで使用する必要があります。ペアで使用しない場合、ログ送信に影響が出る場合があります。

    列挙値：

    • "START"：ログ送信を有効にします。

    • "BLOCK"：ログ送信をブロックします。BLOCK 状態では、ログを送信する前に準備を完了してください。

    すべて

    注：この設定は、aplus_queue.push を使用した API 呼び出しにのみ適用されます。

    aplus-jsbridge-only

    H5 ログ報告のスイッチ。

    • true：H5 ログの送信を無効にします。ブリッジシナリオでは、ブリッジログのみを送信します。

    • false：H5 ログの送信を有効にします (デフォルト)。

    すべて

    aplus-utm-expire-days

    UTM パラメーターの有効期限を設定します。

    デフォルトでは、UTM パラメーターは現在のセッションで有効です。カスタムの有効期限を日数で設定します。値は Cookie に保存され、ブラウザーの Cookie の有効期限の制限を受けます。

    v2.0.7 以降

    aplus-preset-events-disabled

    SDK が収集するデフォルトのプリセットイベントを無効にします。

    デフォルト：undefined。配列を指定して、特定のイベントを無効にします。例：

    aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ['aplus-preset-events-disabled', [
        '$$_page_leave', // プリセットのページ離脱イベント。
    ]] 
});

    v2.0.9 以降

    5. データ収集スイッチ

    データ収集はデフォルトで有効になっています。有効化 API と無効化 API を使用して制御します。v2.2.2 以降で利用できます。同期統合と非同期統合では、使用するパラメーター名が異なる点にご注意ください。

    重要

    データ収集はデフォルトで有効になっています。開発者がローカルストレージ内の aplus-sdk-disable フィールドを設定または削除しない限り、データ収集は有効なままです。

    5.1. データ収集の有効化

    enableSDK

    例：

    5.1.1. 同期統合

    <script src='SDK_URL' charset="UTF-8"></script>
<script>
    aplus.initParams({
        appKey: "Your_AppKey",
        trackDomain: 'Your_Data_Collection_Domain',
        ...
        'disableSDK': false // データ収集を有効にします (デフォルトで有効)。
    });
</script>

    5.1.2. 非同期統合 (命令キュー)

    // データ収集を有効にします。
window.aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ['aplus-sdk-disable',  false]
})

    5.1.3. 非同期統合 (API)

    // データ収集を有効にします。
window.aplus.enableSDK();

    5.2. データ収集の無効化

    SDK の無効化

    例：

    5.2.1. 同期統合

    <script src='SDK_URL' charset="UTF-8"></script>
<script>
    aplus.initParams({
        appKey: "Your_AppKey",
        trackDomain: 'Your_Data_Collection_Domain',
        ...
        'disableSDK': true // データ収集を無効にします。
    });
</script>

    5.2.2. 非同期統合 (命令キュー)

    // データ収集を無効にします。
window.aplus_queue.push({
    action: 'aplus.setMetaInfo',
    arguments: ['aplus-sdk-disable',  true]
})

    5.2.3. 非同期統合 (API)

    // データ収集を無効にします。
window.aplus.disableSDK();