コンテンツにスキップ

クイックスタート

本記事では、0.3.0 以降のバージョンで最短の連携手順を説明します。インストールとホスト統合の完全な説明については、アプリ連携を参照してください。

アプリは Agent 自動連携 と 手動連携 をサポートします。以下の手順では、手動連携の最小構成を説明します。

通常の uni-app

1. モジュールをインストール

同じバージョンのリリースパッケージに含まれる次のディレクトリをプロジェクトにコピーします。バージョンは 0.3.0 以上である必要があります。

uni_modules/
├── GC-JSPlugin
└── GC-UniPlugin

nativeplugins/GCUniPlugin はインストールしないでください。

2. Bridge をロードして API をインポート

アプリのエントリで setup.js を 1 回ロードします。

import '@/uni_modules/GC-UniPlugin/setup.js';

import {
    mobileAgent,
    rum,
    logger,
    tracer
} from '@/uni_modules/GC-UniPlugin';

import {
    gcErrorTracking,
    gcViewTracking,
    gcResourceTracking
} from '@/uni_modules/GC-JSPlugin';

3. 初期化

mobileAgent.sdkConfig({
    datakitUrl: 'YOUR_DATAKIT_URL',
    debug: true,
    env: 'prod'
});

rum.setConfig({
    androidAppId: 'YOUR_ANDROID_APP_ID',
    iOSAppId: 'YOUR_IOS_APP_ID',
    harmonyAppId: 'YOUR_HARMONY_APP_ID'
});

logger.setConfig({
    enableCustomLog: true,
    enableLinkRumData: true
});

tracer.setConfig({
    traceType: 'ddTrace',
    enableLinkRUMData: true
});

gcErrorTracking.startTracking();
gcResourceTracking.startTracking();

実際にリリースするプラットフォームに対応する RUM App ID のみを入力してください。パブリック DataWay を使用する場合は、datakitUrl を datawayUrl と clientToken に置き換えてください。

4. View の自動収集を有効化

Vue 2 では、ルートインスタンスを作成する前に呼び出す必要があります。

gcViewTracking.startTracking();

Vue 3 では、createSSRApp() が返すアプリインスタンスを渡す必要があります。

import App from './App';
import { createSSRApp } from 'vue';

export function createApp() {
    const app = createSSRApp(App);
    gcViewTracking.startTracking(app);
    return { app };
}

初期化の順序は次のとおりにすることを推奨します。

mobileAgent.sdkConfig
  -> rum.setConfig
  -> logger.setConfig / tracer.setConfig
  -> GC-UniSessionReplay.setConfig(任意)
  -> gcErrorTracking / gcResourceTracking / gcActionTracking
  -> gcViewTracking

ホスト App + uni ミニプログラム

uni ミニプログラムプロジェクトでは GC-JSPlugin のみをインストールします。

import {
    mobileAgent,
    rum,
    logger,
    tracer,
    gcErrorTracking,
    gcViewTracking,
    gcResourceTracking
} from '@/uni_modules/GC-JSPlugin';

Native SDK、RUM、Log、Trace はホスト App が uni ミニプログラムを開く前に初期化します。uni ミニプログラムでは JS コレクターを起動し、ランタイム API を呼び出すだけです。例:

mobileAgent.bindRUMUserData({
    userId: 'USER_ID'
});

mobileAgent.appendBridgeContext({
    wgt_id: 'YOUR_WGT_ID'
});

gcErrorTracking.startTracking();
gcResourceTracking.startTracking();

iOS ホストで Native Resource の自動収集がすでに有効になっている場合は、重複収集を避けるため、gcResourceTracking.startTracking({ enableIOS: false }) を呼び出すように変更してください。

ホスト App に対応するモジュールが登録されていない場合、これらの呼び出しは安全に no-op へフォールバックするため、通常のベースアプリで uni ミニプログラムページをデバッグできます。ネイティブ経路は、ホスト拡張を統合したホスト App で検証する必要があります。

次のステップ

フィードバック

このページは役に立ちましたか?