SDK 初期化¶

本稿では、0.3.0 以降の Mobile SDK の初期化とランタイムの基本 API について説明します。

API オブジェクトの取得¶

通常の uni-app では UTS モジュールからインポートし、アプリケーションのエントリで最初に setup.js を一度ロードします。

import '@/uni_modules/GC-UniPlugin/setup.js';
import { mobileAgent } from '@/uni_modules/GC-UniPlugin';

uni ミニアプリでは、パブリックな JS レイヤーからインポートします。

import { mobileAgent } from '@/uni_modules/GC-JSPlugin';

uni ミニアプリの SDK はホストアプリによって初期化されるため、sdkConfig() を呼び出す必要はありません。本ページのその他のランタイム API は、ホストアプリの初期化完了後に呼び出すことができます。

基本設定¶

mobileAgent.sdkConfig({
    datakitUrl: 'http://10.0.0.1:9529',
    debug: true,
    env: 'common',
    globalContext: {
        custom_key: 'custom value'
    }
});

リモート設定とデータフィルタリング¶

mobileAgent.sdkConfig({
    datakitUrl: 'http://10.0.0.1:9529',
    remoteConfiguration: true,
    remoteConfigMiniUpdateInterval: 600,
    enableDataFilter: true,
    dataFilters: {
        logging: [
            "{ message match [ 'password' ] }"
        ],
        rum: [
            "{ resource_status match [ '5..' ] }"
        ]
    }
});

• remoteConfiguration は、サンプリングレートなどの SDK 設定のリモート更新を有効にするために使用します。手動で更新をトリガーする必要がある場合は、updateRemoteConfigWithMiniUpdateInterval を使用できます。
• dataFilters は、アプリとともに配布されるローカルのブラックリストルールです。いずれかのルールに一致したデータは、ローカルキャッシュに書き込まれる前に破棄されます。
• ローカルルールとリモートルールは両方とも有効です。ルールは lineDataModifier の後に実行されるため、修正後のデータに基づいて判断されます。
• 各ルールは { 条件 } で表現されます。フィールドと値の形式については、ブラックリストフィルタリングルール を参照してください。

ユーザー情報のバインドとアンバインド¶

mobileAgent.bindRUMUserData({
    userId: 'Test userId',
    userName: 'Test name',
    userEmail: 'test@example.com',
    extra: {
        age: '20'
    }
});

mobileAgent.unbindRUMUserData();

API - bindRUMUserData¶

API - unbindRUMUserData¶

現在のユーザーをアンバインドします。

ランタイム機能¶

SDK のシャットダウン¶

mobileAgent.shutDown();

SDK をシャットダウンした後、再度使用するには、完全な初期化をやり直す必要があります。uni ミニアプリは通常、ホストアプリが保持する SDK をシャットダウンすべきではありません。ただし、両者でライフサイクル管理方法を合意している場合はこの限りではありません。

SDK キャッシュデータのクリア¶

mobileAgent.clearAllData();

まだサーバーにアップロードされていないすべてのデータをクリアします。

手動データ同期¶

mobileAgent.flushSyncData();

autoSync が true の場合は追加の操作は不要です。autoSync が false の場合は、このメソッドを呼び出してデータ同期をトリガーします。