コンテンツにスキップ

WebView データモニタリング

本文は、Cocos Creator の Android/iOS ネイティブビルドで WebView コンポーネントを通じて読み込まれる Web ページを対象としています。Web Mobile / Web Desktop ビルドについては Web 導入 を参照してください。

App 側の設定

まず SDK 初期化 と RUM 設定 を完了し、WebView ページを読み込む前に RUM を初期化します。

スタンドアロン実行モードでは、既存の guanceSdk.start() 設定で WebView パラメータを設定し、アプリのライフサイクル内で 1 回だけ初期化します:

guanceSdk.start({
  sdk: {
    datakitUrl: 'https://your-datakit.example.com',
    allowWebViewHost: ['example.com'],
  },
  rum: {
    androidAppId: 'android-rum-app-id',
    iosAppId: 'ios-rum-app-id',
    enableTraceWebView: true,
  },
  // WebView ページのログを収集する場合に設定します。
  logger: {
    enableWebViewLog: true,
  },
});
  • rum.enableTraceWebView は WebView RUM を制御し、デフォルトは true です。false に設定すると WebView RUM のみが無効になり、有効になっている WebView ログには影響しません。
  • sdk.allowWebViewHost は WebView RUM とログの両方の Bridge host の範囲を制御します。null はすべての host を許可し、空配列 [] はすべての host を禁止します。未設定の場合はネイティブ SDK のデフォルト動作を維持します。設定位置とマッチングルールについては WebView host 設定 を参照してください。
  • logger.enableWebViewLog は WebView ログを制御し、デフォルトは false です。ページ側でも Browser Logs SDK を初期化する必要があります。詳細は WebView ログ を参照してください。

これらのパラメータは Android/iOS ネイティブビルドの WebView に適用され、Web Mobile / Web Desktop の Browser SDK 設定にはマッピングされません。Cocos SDK を更新した後は、インストーラーを再実行してネイティブプロジェクトをビルドし、TypeScript の型、Bridge、および付随するネイティブ依存関係を一致させる必要があります。

ネイティブホストの Hybrid シナリオでは、SDK、RUM、Log の初期化をホスト側で行い、Cocos は attach() で連携するため、上記の start() の例で重複して初期化しないでください。ホスト側の設定については Android WebView モニタリング と iOS WebView データモニタリング を、Cocos の導入方法については ネイティブと Cocos のハイブリッド開発 を参照してください。

Android Plugin 設定

Cocos のビルド拡張は ft-plugin を自動的に適用しないため、WebView Bridge の自動注入には以下の設定を完了する必要があります:

  1. 生成された Android ネイティブプロジェクトで、Android Plugin の導入 に従って Maven リポジトリとプラグインの依存関係を追加し、Android Gradle Plugin(AGP)のバージョンに応じて ft-plugin または ft-plugin-legacy を選択します。
  2. アプリのメインモジュールの build.gradle(通常は app/build.gradle)でプラグインを適用し、FTExt にカスタム WebView クラスの認識設定を追加します。たとえば、org.cocos2dx.lib.Cocos2dxWebView を使用するプロジェクトの設定は次のとおりです:

    apply plugin: 'ft-plugin'
    
    FTExt {
        knownWebViewClasses = ['org.cocos2dx.lib.Cocos2dxWebView']
    }
    

    プロジェクトで既にプラグインを適用している場合は、apply plugin を重複して追加する必要はありません。knownWebViewClasses を既存の FTExt にマージし、その他の設定は保持してください。既にクラスリストがある場合は、上記のクラス名を追記します。プロジェクトで他のカスタム WebView クラスを使用している場合は、実際に使用している完全修飾クラス名を記入してください。

  3. Gradle のコンパイル、パッケージング、アプリのインストールを再度実行し、インストルメンテーション設定を有効にします。Cocos Creator が Android ネイティブプロジェクトを再生成した後は、Plugin と knownWebViewClasses の設定が残っていることを確認してください。

カスタム WebView の認識

ft-plugin を導入済みであっても、Cocos のカスタム WebView が認識されているわけではありません。ft-plugin 1.3.9 と org.cocos2dx.lib.Cocos2dxWebView を使用する場合は、上記のクラス認識設定を追加する必要があります。データが受信できない場合は、カスタム WebView 自動収集のトラブルシューティング に従ってプラグインのログを確認してください。

Web ページの初期化

App 側の設定が完了したら、WebView で読み込まれるページ内に Web RUM SDK を組み込み、初期化します。詳細は ページの初期化 を参照してください。既に Web SDK の初期化設定がある場合は既存の設定を再利用し、初期化は 1 回だけ行ってください。

WebView データの検証 に従ってレポートを確認します。App でページを開き、アクセス、クリック、またはネットワークリクエストを発生させ、対応する Android/iOS App アプリケーションで WebView RUM データが受信されていることを確認してください。

フィードバック

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