この記事は、アプリケーションにPendo Launcherを導入し、Pendoをインストールするためのコンポーネントと手順をまとめたものです。これは概ね次の2つのステップで行われます。
始める前に
始める前に、Pendo Launcherの実装を計画するの記事を参考に、対象となるブラウザやオペレーティングシステム、訪問者IDのソース、Pendoに取り込むメタデータを決定してください。
本記事のステップ1には、対象となるブラウザやオペレーティングシステムに応じて利用可能な導入オプションの表が含まれます。
本記事のステップ2には、選択したブラウザやオペレーティングシステムに応じて利用可能な訪問者IDおよびメタデータオプションの表が含まれます。
ステップ1. エンドユーザーにブラウザ拡張機能をインストールする
Pendo Launcher拡張機能を導入する最初のステップは、管理設定ポリシーを使ってエンドユーザーのブラウザにPendo Launcher拡張機能をインストールすることです。サポートされているすべてのブラウザは、次の2つのいずれかの方式でブラウザ拡張機能の管理インストールに対応しています。
- 強制インストール(推奨):拡張機能はエンドユーザーのブラウザにインストールされ、削除できません。
- 標準インストール:拡張機能はエンドユーザーのブラウザにインストールされ、エンドユーザーが削除できます。
Pendoは、すべてのユーザーに対して強制インストールを推奨しています。社内の一部のリソースの開発などのために拡張機能を削除する必要がある場合、標準インストールされた拡張機能を受け取るユーザーのサブグループを作成できます。このポリシーの適用に使用されるExtensionSettings
属性のブラウザ固有の詳細については、次の関連ドキュメントを参照してください。
- Chrome:ExtensionSettings:拡張機能の管理設定
- Microsoft Edge:ExtensionSettingsポリシーを使用した拡張機能の構成に関する詳細ガイド
- Firefox:Mozilla policy-templates README.md:ExtensionsSettings
選択した拡張機能ポリシーを適用するためのインストール方法は以下のとおりです。
インストール方法
Pendo Launcherブラウザ拡張機能の管理インストールは、以下の方法で行うことができます。お客様の組織にとって最適な選択は、既存のIT構成やツールによって異なります。インストール方法を選択する前に、本記事のステップ2でも必要となる訪問者IDやメタデータの入手方法も決めておいてください。
選択する方法によっては、同じツールを使用してインストールや構成が可能な場合があります。たとえば、インストールにChrome管理コンソールを使用すると、Chrome管理コンソールを使用してAPIキーも構成することができます。
注:下表のそれぞれの方法に関するドキュメントは、現在更新中です。
Mac | Windows | すべてのOS | |
Chrome* | |||
Edge | 構成プロファイルを使用してmacOS版Edgeにインストールする | 該当なし | |
Firefox | GPOを使用してFirefoxにインストールする | policies.jsonを使用してWindows版またはmacOS版のFirefoxにインストールする |
* Chromeは、管理コンソールとOS固有の導入方法の同時使用をサポートしていません。お客様の会社が他のChrome拡張機能でこれらのオプションのいずれかを使用している場合、Pendo Launcherを導入する際も同じ導入方法をとる必要があります。
ステップ2. エンドユーザーのデバイスで拡張機能を構成する
Pendo Launcher拡張機能の構成には、APIキー(必須)、訪問者ID(必須)、メタデータ(推奨)の構成方法を選択する必要があります。表から以下の項目を選択します。
- 対象となるブラウザとOSの組み合わせごとにAPIキーを構成する1つのオプション(必須)
- 対象となるブラウザとOSの組み合わせごとに訪問者IDを構成する1つのオプション(必須)
- 対象となるブラウザとOSの組み合わせごとの1つ以上のメタデータのソース(任意)
可能であれば、APIキーと訪問者IDを構成する際に、同じオプションを選択することを推奨します。
さらに、メタデータのソースを少なくとも1つ選択することを推奨します。メタデータは、Pendoのアナリティクスとガイドのターゲット設定を強化します。一部のメタデータのソースは併用可能です。
注:下表のそれぞれの構成オプションに関するドキュメントは、現在更新中です。
構成ツール | ブラウザ | OS | 構成可否 | ||
---|---|---|---|---|---|
APIキー | 訪問者ID | メタデータ | |||
Google管理コンソール | Chrome | すべて | ✔ | ✘ | ✘ |
MDM、macOS版Chrome | Chrome | Mac | ✔ | ✔ | ✔ |
Jamf、macOS版Chrome | Chrome | Mac | ✔ | ✔ | ✔ |
GPO、Windows版Chrome | Chrome | Windows | ✔ | ✔ | ✔ |
Intune、Windows版Chrome | Chrome | Windows | ✔ | ✔ | ✔ |
MDM、macOS版Edge | Edge | Mac | ✔ | ✔ | ✔ |
GPO、Windows版Edge | Edge | Windows | ✔ | ✔ | ✔ |
MDM、Mac版Firefox | Firefox | Mac | ✔ | ✔ | ✔ |
GPO、Windows版Firefox | Firefox | Windows | ✔ | ✔ | ✔ |
Browser scripting | すべて | すべて | ✘ | ✔ | ✔ |
Salesforceコンポーネント | すべて | すべて | ✘ | ✔ | ✔ |
Active Directoryスクリプト* | すべて | Windows | ✘ | ✘ | ✔ |
Oktaワークフロー* | すべて | すべて | ✘ | ✘ | ✔ |
CSVアップロード * | すべて | すべて | ✘ | ✘ | ✔ |
API* | すべて | すべて | ✘ | ✘ | ✔ |
ChromeまたはEdge | すべて | ✘ | ✔ | ✘ | |
ChromeまたはEdge | すべて | ✘ | ✔ | ✘ | |
ブラウザプロファイル* | ChromeまたはEdge | すべて | ✘ | ✔ | ✘ |
*これらのオプションを使用すると、他のソースからのメタデータを補足できます。
拡張機能の構成オプション
選択した構成方法に応じて、APIKey
、dataEnvironment
、visitor
のプロパティをPendo Launcherの拡張機能にプッシュできます。これらのプロパティは、Windowsではレジストリキー、macOSではJSONキーの形式をとります。
APIキー
これはサブスクリプションの識別キーであり、b3e5a9c1-f273-4b45-7c96-0e1dd2a9b8a0
のような形式をとります。管理者ユーザーであれば、[設定(Settings)]>[サブスクリプション設定(Subscription Settings)]に移動してAPIキーを確認できます。
dataEnvironment
これは任意のプロパティであり、io
、us1
、eu
、またはjpn
を値として含めることができます。
io
はデフォルト値です。dataEnvironment
プロパティは、GDPR要件などにより、別のデータ環境に保存されているサブスクリプションを指定する必要がある場合にのみ設定します。
訪問者
このプロパティにはユーザーの一意の識別情報が含まれており、以下のように表示されます。
{
“id”: “john.doe@example.com”,
“office”: “Raleigh”,
“role”: “engineer”
}
id
値は必須です。それ以外の値は追加的なメタデータを提供するもので、アナリティクスやガイドのターゲット設定に利用されます。CSV形式のアップロードファイルやOktaワークフローのインテグレーションを介して、他のソースからメタデータを補うことができます。
訪問者IDの優先順位付け
訪問者IDに複数のソースを選択した場合、特定の訪問者には1つのソースのみが適用されます。たとえば、ある方法から別の方法に移行する際に、一時的な重複が発生する場合などが該当します。複数のソースを適用した場合の優先順位は以下のとおりです。
- MDMツールによるIT管理機能
- Salesforceスニペットを含むJavaScriptスニペット
- ブラウザのログインID(ChromeまたはEdgeのみ)
- ランダムに生成された匿名ID。この場合、訪問者はガイドを取得できますが、デフォルトではそのデータはアナリティクスに表示されません。詳細については、匿名の訪問者を参照してください。