インストールスクリプトのコンポーネント

最終更新日:

Pendoをアプリケーションに直接実装するには、以下の主要コンポーネントが必要です。

この記事では、これらのコンポーネントについて簡単にまとめ、その仕組みについての簡単な技術概要を説明します。IDとメタデータの選択からユーザーの追加、Pendoの使用開始までの、Pendoの実装についての全体的な手順に関するガイダンスについては、Pendoのアプリへの直接実装を計画するを参照してください。インストールスクリプトを使ったPendoのインストールと設定については、インストールスクリプトを使用したPendoの実装に関する開発者ガイドを参照してください。

仕組み

インストールスクリプトは、Pendoエージェントをアプリケーションに統合します。アプリケーションがブラウザで実行されると、インストールスクリプトがPendoエージェントを呼び出して読み込み、アプリケーションでPendoの機能を利用できるようになります。

開発者はインストールスクリプトをページヘッダーに挿入する必要があります。インストールスクリプトのすべての要素を、データを収集するすべてのページに配置する必要があります。これには、Pendoエージェントの呼び出し、アカウントを識別するためのAPIキー、Pendoエージェントを起動しIDとメタデータを定義するための初期化メソッドが含まれます。

モバイル開発者がSDKをアプリに追加し、アプリの読み込み時にPendoを初期化し、データ収集とガイドの表示の準備ができ次第訪問者を識別します。

インストールスクリプトによるインストールと設定を行ってから、そのデータを受け取るまでに最大1時間かかる場合があります。分析に利用されるデータの多くは、1時間ごとに一括集計されるため、Pendoに表示されるまでには、毎正時から最大15分かかることがあります。

Pendoエージェント

サブスクリプションに応じて、Pendoエージェントは次の目的でブラウザで実行されるJavaScriptファイル(pendo.js)となります。

  • 訪問者イベント(ページの読み込み、機能のクリックなど)の収集および追跡
  • 訪問者およびアカウントのメタデータの収集
  • ガイドの読み込み
  • Feedbackモジュールの配信

通常、エージェントはPendoサーバー上で構成され、クライアント側のインストールスクリプトによって要求されます。

インストールスクリプト(「スニペット」)

インストールスクリプトは、一般に「スニペット」と呼ばれ、Pendoエージェントコード(pendo.js)を取得して読み込む短いJavaScript関数です。使用状況の追跡、フィードバックの収集、メッセージやガイドの配信を行うことができます。インストールスクリプトには以下が含まれます。

  • Pendoエージェントの要求
  • エージェントが収集したデータをPendoサブスクリプションのプロダクトにマッピングする顧客固有のAPIキー
  • Pendoエージェントをアクティブにするために必要な初期化メソッド

Pendoエージェントが機能するには、インストールスクリプトと初期化メソッドがウェブサイトのすべてのページに存在する必要があります。ただし、アプリケーションにトップフレームと同じドメインからの子フレームがある場合は除きます。この場合、インストールスクリプトをアプリケーションのトップフレームに追加することで、Pendoを子フレームに自動的にインストールするようにインストールスクリプトを設定することができます。これらのフレームのいずれかで訪問者IDまたはメタデータに加えられた変更は、すべてのフレームに適用されます。

スニペット

注:インストールスクリプトが存在しても、トラッキングが行われることにはなりません。トラッキングを行うには、インストールスクリプトを初期化する必要があります。詳しくは、初期化メソッドをご覧ください。

アプリケーション(API)キー

インストールスクリプトは、Pendoをライブラリとして読み込み、その機能をウィンドウレベルで使用できるようにし、コードブロックに含まれる32桁のアプリケーション(API)キーを渡します。

APIキーは、サブスクリプションのアプリケーションの詳細に事前入力されており、[インストール(Install)]ページまたは[アプリの設定(App Settings)]にあります。

初期化メソッド

使用状況分析の追跡、フィードバックの収集、およびガイドの提供を開始する前に、Pendoエージェントを初期化する必要があります。初期化は、次の場合のPendoインストールスクリプトのJavaScript関数です。

  • 訪問者IDおよびアカウントIDとして渡したい値を決定します。
  • Pendoに提供するメタデータをカスタマイズします。
  • Pendo Feedbackの自動タグを作成します。詳しくは、Feedbackにおける自動タグ付けをご覧ください。

初期化コードブロックを使用すると、訪問者とアカウントを識別し、アナリティクスをセグメント化したり、アプリケーション変数(ユーザーオブジェクトなど)から渡されたメタデータを使用してガイドをターゲット化したり、Feedbackリクエストに自動タグを付けたりすることができます。

pendo.initalize()が実行される前に、インストールスクリプトに渡されるすべての変数を定義する必要があります。Pendoに渡されたすべての変数が初期化時に存在しない場合、Pendoは正しく初期化されません。 詳細については、条件付きでPendoを初期化するを参照してください。

初期化は、訪問者が認証された後のウィンドウの再読み込みごと、またはサイトにiframeがある場合はフレームごとに実行する必要があります。複数ページのアプリケーションを使用している場合はログインページだけでなく各ページ、またはグローバルテンプレートがある場合はそのページで、Pendoを初期化する必要があります。

以下は初期化コードブロックの例です。これは[インストール(Install)]ページまたは[アプリの設定(App Settings)]にあります。この例をカスタマイズして、サブスクリプションのニーズを満たすことができます。

この記事は役に立ちましたか?
2人中1人がこの記事が役に立ったと言っています