Pendoは、リソースセンターのコンテキストでネイティブのZendeskウェブウィジェットを使用できるように、Zendeskヘルプセンターのインテグレーション体験をアップグレードしました。
この記事では、PendoサブスクリプションにインストールされているZendeskヘルプセンターインテグレーションの旧バージョンからアップグレードする方法について説明します。最新版のZendeskヘルプセンターインテグレーションのみをインストールする場合は、ZendeskナレッジベースとPendoのインテグレーションを参照してください。
これはZendeskとの3つのインテグレーションのうちの1つで、PendoリソースセンターからZendeskウェブウィジェットを展開します。
- Zendeskチャットインテグレーションにより、ウェブウィジェットのライブチャット機能が起動します。
- Zendeskヘルプセンターインテグレーションにより、ウェブウィジェットのヘルプセンター機能が起動します。
- Zendeskメッセージングインテグレーションは、ZendeskチャットとZendeskヘルプセンターの両方に対して優先されます。
ZendeskチャットとZendeskヘルプセンターをそれぞれ展開することも、Zendeskメッセージングを展開してヘルプセンターにメッセージング機能を組み込むこともできます。
仕組み
旧バージョンのZendeskヘルプセンターモジュールは、Pendoリソースセンターのiframe内でレンダリングされます。今回のアップグレードにより、Zendeskヘルプセンターは、リソースセンターモジュールを介してZendeskウェブウィジェットで起動します。これにより、Zendeskウェブウィジェットによりこれまで生成されていた起動ボタンが非表示になります。
新しいインテグレーションでは、旧バージョンでは不要であったインストール手順が追加されています。
- 新しいZendeskヘルプセンターインテグレーションをPendoサブスクリプションに追加する必要があります。インテグレーションをPendoサブスクリプションに追加するには、Pendoカスタマーサクセスまたは営業担当者にご連絡ください。
- 新しいZendeskヘルプセンターモジュールをリソースセンターに追加する必要があります。
- 旧バージョンのZendeskヘルプセンターモジュールを削除する必要があります。
- Zendeskウェブウィジェットスニペットをアプリケーションのヘッダーに追加する必要があります。
Pendoリソースセンターが一度にサポートできるのは単一のヘルプセンターインテグレーションのみであるため、リストにある最初のモジュールのみをロードします。
前提条件
Pendoサブスクリプションに対して有効なZendeskヘルプセンターインテグレーションが必要です。また、PendoとZendeskの両方のアカウントに管理者権限があり、Pendoでリソースセンターを公開している必要があります。
さらに、Zendeskスニペットは、ページヘッダーのPendoスニペットの下にインストールする必要があります。リソースセンターでZendeskヘルプセンターモジュールを公開せずにZendeskスニペットをインストールすると、Zendeskウェブウィジェット起動バッジがUIにロードされます。
インストール
Zendeskヘルプセンターのアップグレードは、3段階で行います。
- ヘルプセンターモジュールをリソースセンターに追加します。
- 旧バージョンのヘルプセンターモジュールをリソースセンターから削除します。
- ヘルプセンターモジュールを使用するすべてのページにZendeskウェブウィジェットスニペットをインストールします。
Zendeskスニペットがインストールされていて、ヘルプセンターモジュールが公開されていない場合、ZendeskスニペットはUI上にZendeskの起動ボタンををロードします。公開されているリソースセンターにヘルプセンターモジュールがある場合、アプリケーションにインストールされているZendeskスニペットが検出されるまで、そのモジュールはリソースセンターに表示されません。このインストール順序がフェールセーフとなり、ヘルプセンターモジュールは機能しているときのみ表示されるようになります。
ステップ1. Zendeskヘルプセンターモジュールをリソースセンターに追加する
ヘルプセンターモジュールをリソースセンターに追加する前に、Zendeskヘルプセンターインテグレーションをサブスクリプションに追加する必要があります。アプリケーションにスニペットをインストールする前に、ヘルプセンターモジュールをリソースセンターに追加し、公開する必要があります。これを行わないと、リソースセンターモジュールが追加されるまで、Zendeskは起動バッジを表示します。
- ［設定（Settings）］>［インテグレーション（Integrations）］に移動します。
- ナレッジベースインテグレーションでZendeskヘルプセンターインテグレーションを探し、［インテグレーションを編集（Edit Integration）］を選択します。
- リソースセンターモジュールの詳細を編集します。
- ［ステージングに保存（Save to staging）］を選択して、リソースセンターでインテグレーションを利用できるようにします。
- ［ガイド（Guides）］>［リソースセンター（Resource Center）］に移動します。
- ［モジュールを追加（Add Modules）］を選択して、Zendeskヘルプセンターモジュールを追加します。
- ［モジュールを追加］を選択して、新しいモジュールをリソースセンターのドラフトに保存します。
ステップ2. 旧バージョンのZendeskヘルプセンターモジュールをリソースセンターから削除する
- ドラフトのリソースセンターのモジュールの一覧で、旧バージョンのZendeskヘルプセンターインテグレーションモジュールを探します。
- ［モジュール詳細を表示（View Module Details）］を選択して、旧バージョンのZendeskヘルプセンターモジュールを削除します。この操作では、現在公開されているリソースセンター上のヘルプセンターモジュールは削除されません。このバージョンのリソースセンターが公開されるまで、変更は反映されません。
- ［ステージングへプッシュ（Push to Staging）］を選択して、リソースセンターをステージングに移行させます。新しいリソースセンターを確認し、ステージング環境でインテグレーションをテストすることをお勧めします。
- ［本番環境へプッシュ（Push to Production）］を選択して、新しいリソースセンターをステージングから本番環境に移行させます。これにより、リソースセンターでZendeskヘルプセンターモジュールが使用できるようになります。
リソースセンターモジュールの順番変更やその他の変更を行う場合は、［自分のアプリで管理（Manage in My App）］を選択します。セグメントを適用することもできます。ヘルプセンターモジュールは、セグメント外のユーザーには表示されません。デフォルトは［全員（Everyone）］です。
ステップ3. Zendeskウェブウィジェットスニペットをインストールする
Zendeskでは、ウェブウィジェットスニペットをインストールするためのインストール手順を提供しています。このプロセスは、インストールスクリプトを使用してPendoをインストールするプロセスと同様です。スニペットは、Zendeskヘルプセンターを使用するすべてのページの<head>に追加する必要があります。スニペットがページ上に存在しない限り、リソースセンターのヘルプセンターモジュールはロードされません。
Zendeskヘルプセンタースニペットは、<head>内のPendoインストールスクリプトの下にインストールする必要があります。ZendeskスニペットがPendoの前にロードされた場合、Zendeskはリソースセンターモジュールを使用せずに起動ボタンをロードします。