この記事では、Cordova、Ionic、Capacitorなどのウェブテクノロジーを使用して構築されたハイブリッドアプリにPendoをインストールする方法について説明します。ハイブリッドアプリには、WebViewなど、アプリ内でウェブページを読み込むためのモバイルコンポーネントとウェブコンポーネントの両方が含まれます。他の種類のハイブリッドアプリについては、ハイブリッドアプリでのPendoの使用を参照してください。
CordovaアプリおよびIonicアプリでは、Pendoのウェブインストールスニペットとウェブアプリキーを使用して、ウェブレイヤーでアナリティクスを収集し、ガイドを表示します。PendoはCordovaやIonic向けのモバイルSDKを提供していません。ウェブスニペットのインストールの詳細については、インストールスクリプトを使用したPendoの実装に関する開発者ガイドを参照してください。
CordovaアプリおよびIonicアプリのネイティブ機能では、トラックイベントのみがサポートされます。これらのイベントはアプリケーションコード内に実装する必要があります。Pendoはネイティブなインタラクションを自動的に収集したり、ネイティブコンポーネント内でガイドを表示したりすることはありません。
重要:他のアプリケーションでも訪問者を追跡している場合は、訪問者のジャーニーの一貫性を保つために、すべてのインストールで同じ訪問者ID、アカウントIDs、メタデータのキーと値を使用してください。
CordovaアプリケーションへのPendoのインストール
Cordovaは、ハイブリッドモバイルアプリを構築するためのオープンソースフレームワークです。そのウェブページは、iOSまたはAndroidデバイス上で実行されているローカルウェブサーバーから配信されます。アプリはウェブ上に存在し、アプリ内でWebViewを開きます。
通常、Cordovaアプリケーションは中心となるウェブアプリケーションを軸に構築されます。Cordovaアプリケーションに Pendo をインストールする場合は、次の点に関するいくつかの注意事項を考慮する必要があります。
- ブラウザへのビルド
- ページのタグ付け
- ネイティブデバイス機能の追跡
ブラウザへのビルド
ほとんどのアプリケーションと同様に、PendoはJavaScriptのインストールスクリプトを使用してインストールされます。そのため、Cordovaアプリケーションは、ページとフィーチャーにタグ付けしたり、ビジュアルデザインスタジオでアプリ内ガイドを構築したりできるように、ウェブブラウザでアクセスできる必要があります。
これは、CordovaのCLIが提供するブラウザプラットフォームを使用して行うことができます。
- Cordovaアプリケーションにブラウザプラットフォームを追加します:
cordova platform add browser。 - ブラウザプラットフォーム用にウェブアプリケーションをビルドします:
cordova build browser。
これにより、/<path-to-application>/platforms/browser/wwwにウェブアプリケーションの静的ビルドが作成されます。その後、このビルドを、ガイドを作成したり、ページやフィーチャーにタグ付けしたりするPendoユーザーがアクセスできる場所にホストする必要があります。
ページのタグ付け
Cordovaアプリケーションは複数の異なるプラットフォーム向けにビルドできるため、ページルールは意図するすべてのプラットフォームを考慮する必要があります。たとえば、以下はサンプルのCordovaアプリケーションの[推奨ページ(Suggested Pages)]を示しています。
この例では、2つの推奨ページがどちらも同じページ(index.html)を指しています。これは、このアプリケーションが実行されるブラウザとiOSのプラットフォームが、同じページを異なるURLで配信しているためです。
このようなシナリオに対応するには、ブラウザのプラットフォームページをタグ付けする標準の手順に従った後、追加のプラットフォームURLを手動で追加します。Pendoでタグ付けされたページに移動し、[ルールを追加(Add Rule)]を選択します。詳細な手順については、ページのタグ付けを参照してください。
以下の例では、//*/index.htmlがブラウザプラットフォームのURLを取得し、//*/*/*/*/*/*/*/*/*/index.htmlがiOSプラットフォームのURLを取得します。
ネイティブデバイス機能の追跡
Pendoは Cordova アプリケーションのウェブアプリケーションレイヤーにインストールされるため、アプリケーションのネイティブ部分ではアクティビティが収集されません。
たとえば、Pendoがインストールされた Cordova アプリケーションに、デバイスのネイティブカメラアプリケーションを起動するボタンが含まれている場合、Pendoはそのボタンのクリックのみを収集し、カメラアプリケーション内で発生するインタラクションは収集しません。
ネイティブデバイス機能の可視性が必要な場合は、トラックイベントをCordova APIが提供するコールバック関数内に必要に応じて実装できます。以下は、写真撮影の失敗を収集するためにトラックイベントを実装する例です。
// EXAMPLE CODE PROVIDED AS IS WITH NO WARRANTY OR SLA
function cameraSuccess() {
// Code to execute on successful photo
}
function cameraFailure() {
// Code to execute on failed photo
// Send camera-error track event to Pendo to track camera failures
pendo.track("camera-error", {
model: device.model,
platform: device.platform,
version: device.version,
});
}
navigator.camera.getPicture(cameraSuccess, cameraFailure);