Feedbackのインストールに関する開発者向けガイド

この記事では、既存のEngage(インサイトとガイダンス)をご利用のお客様が、PendoプロダクトにFeedbackを追加する場合の手順を説明します。続行する前に、まず開発者向けPendoインストールガイド をお読みになることをお勧めします。

Pendo Feedbackは、Pendo Engageとは異なる情報を使用して動作し、通常はアプリケーションのインストールスクリプト(「スニペット」)を編集することで、次のことをできるようにします。

    • メールアドレスのフィールドなど、追加のメタデータを渡す
    • Feedbackでセグメントの自動タグを作成する

このプロセスの詳細については、Pendoアカデミーの動画、スニペットによるPendo Feedbackのインストールをご覧ください。

旧Feedbackをご利用のお客様で、最新の体験をご利用になりたい場合、またはEngageとFeedbackの両方を新たにご利用になる場合は、開発者向けPendoインストールガイドに記載されている新規ユーザー向けの手順に従い、この記事の「ステップ1:初期化方法の変更を確認する」で説明しているメタデータと自動タグの追加設定のアドバイスをご確認ください。

Feedbackのインストールプロセス

まず、Pendoをセルフホストしている場合は、お使いのPendoエージェントが最新バージョンであることを確認します。[設定(Settings)]に記載されているバージョン番号と、Pendoウェブエージェントアーカイブに記載されている最新バージョンを比較します。または、コンソールでpendo.getVersion()コマンドを使用して確認します。

次に、インストールコードの初期化方法に加える変更を特定します。詳細については、「ステップ1:初期化方法の変更を確認する」 をご覧ください。

最後に、メタデータフィールドへの変更でコードを更新して、Feedbackを追加します。手順については、「ステップ2:インストールスクリプトを再構成する」を参照してください。その後、Pendoはオンボーディングプロセスの一環としてFeedbackを有効にします。

ステップ1:初期化方法の変更を確認する

Pendo Feedbackは、Pendo Engage(インサイトとガイダンス)とは異なる情報を使用することで、最適に動作します。この情報には以下が含まれます。

    • 一意のアカウントID(必須)
    • 訪問者メタデータとしてのメールアドレス(通信用に強く推奨)
    • 追加のコンテキストのための訪問者メタデータとしての氏名
    • 訪問者レベルとアカウントレベルの自動タグ
    • アカウントが有料顧客であるかどうか
    • アカウントの価値(通常、月次または年次の定期的な価値)

FeedbackSnippet.png

FeedbackのアカウントID

Engage(インサイトとガイダンス)とは異なり、FeedbackにはアカウントIDが必要です。訪問者がFeedbackで一意のレコードを作成するには、自分に関連づけられたアカウントIDが必要になります。これは、リクエストを送信したユーザーに関する重要な詳細情報を提供するものです。

正確なFeedbackの使用状況データを得るためには、アカウントIDを変更しないでください。

現在、Pendo Feedbackは訪問者を親アカウントにマッピングしません。エンドユーザーが同じ訪問者IDを持つ複数のアカウントに属している場合、Feedbackはそれらを一意の訪問者としてカウントします。

複数のアカウントがレポートに影響を与える可能性があるため、リクエストが関連付けられている訪問者を確認することが重要です。Feedbackでは重複したユーザーが作成されますが、訪問者とアカウントの両方が表示され、機能リクエストを訪問者とアカウントに関連付けることができます。

Pendo Feedbackでは、匿名の訪問者はサポートされていません。

メールアドレスのメタデータ

また、インストールスクリプトのメタデータフィールド(「スニペット」)にメールアドレスを渡すことを強くお勧めします。これは、メールアドレスを訪問者IDとして使用することとは異なります。

メールのメタデータは、Pendoのレポートからアクセスでき、カスタムセグメントを作成したり、Pendo Feedbackの中心的な部分として利用したりできます。インストールスクリプトに訪問者のメールアドレスを含めることで、オプションとして、ユーザーが配信登録しているリクエストの更新を知らせるメール通知や、エンゲージメントおよびプロダクトに関するメールを送信することができます。

メール通知は選択式にすることができます。訪問者はリクエストを作成、投票、コメントする際に、配信を停止できます。詳細については、フィードバックメールの通知をご覧ください。

フィードバックにおける自動タグ付け

Feedback UIでは、リクエスト、チームユーザー、訪問者、アカウントにタグを追加できます。訪問者およびアカウントレベルでタグ付けする最も効率的な方法は、自動タグ付けを使用することです。

自動タグ付けは次の目的で使用できます。

  • アカウントレベルおよび訪問者レベルのタグに基づいて、Feedbackでリクエストのレポートを作成します。インストールスクリプトに自動タグを追加した後、[Feedback]>[レポート(Reports)]>[詳細設定(Advanced)]で、[ユーザーフィルター(User Filters)][アカウントフィルター(Account Filters)]の下にあるタグを選択してフィルタリングできます。
  • Engage(インサイトとガイダンス)のメタデータフィールドがFeedbackのメタデータフィールドと1対1で関連付けられていないことから生じる状態を解決します。たとえば、Engageにユーザー権限、役割、部門などの訪問者メタデータがある場合、これらをFeedbackで自動タグとして設定できます。

特定の訪問者またはアカウントからのリクエストに自動タグを付けることができます。特定のURLからのリクエストや他の条件に基づいてリクエストに自動タグを付けることはできません。

メタデータと同様に、何を自動タグとして送信するかは、PIIを念頭に置きながら、組織のポリシーに基づいて決定する必要があります。

自動タグ付けの詳細については、Feedbackにおける自動タグ付け(Auto-tagging in Feedback)を参照してください。

ステップ2:インストールスクリプトを再構成する

開発者向けPendoインストールガイド「ステップ2:アプリケーションにPendoをインストールする」で説明されている手順でインストールスクリプト(スニペット)を再構成するか、以下の方法で再構成します。

  1. ブラウザでapp.pendo.ioから、[Pendoのプロダクト(Pendo Products)] >[Feedback]>[プロダクト設定(Product Settings)]に移動します。
  2. [Feedbackのインストール(Install Feedback)]を選択し、[Pendoの設定(Pendo Settings)]で[スニペットのインストール(Install Snippet)]を選択します。
  3. アプリのカードにカーソルを合わせて、[アプリの詳細を表示(View App Details)]をクリックします。
  4. [インストール設定(Install Settings)]を選択します。
  5. コードをテキストエディタにコピーして編集します。
  6. スニペットの訪問者オブジェクトとアカウントオブジェクト内のフィールド名を設定します。
  7. アプリ内のメタデータとタグをコードに取り込みます。
  8. アプリケーションのすべてのページにあるHTMLテンプレートのHeadタグにコードを貼り付けて、コードをアプリコードにコピーします。

追加の設定

一部のエンドユーザーに対してFeedbackを無効にする

一部のユーザーのFeedbackへのアクセスをブロックするには、isableFeedback:trueを使用します。これで、そのユーザーに対してFeedbackが初期化されないようにすることができます。つまり、Feedbackはそのユーザーのデータを収集しないため、訪問者レコードが作成されず、そのユーザーはFeedbackにアクセスできなくなります。

これによって、Pendo Engageによるユーザーの追跡が防げられるわけではありません。

トラブルシューティング

自動タグがPendo Feedbackに表示されない

Feedbackは、initializeメソッドに書き込まれた訪問者タグとアカウントタグの値を受け取ります。Pendoエージェントから収集したメタデータの値をFeedback UIに表示するには、訪問者タグとアカウントタグのキー値ペアを配列形式で追加します。

フィードバックでの自動タグ付けについて詳しくはこちらをご覧ください。

コードテンプレート

visitor:{
  id:'VISITOR-UNIQUE-ID'// Required if user is logged in// email:        // Recommended if using Pendo Feedback, or NPS Email// full_name:    // Recommended if using Pendo Feedback// role:         // Optional
// tags: // Recommended if using Pendo Feedback // You can add any additional visitor level key-values here,// as long as it's not one of the above reserved names.}, account:{// id: 'ACCOUNT-UNIQUE-ID' // Highly recommended// name: // Optional// monthly_value:// Recommended if using Pendo Feedback// is_paying: // Recommended if using Pendo Feedback// planLevel: // Optional// planPrice: // Optional// creationDate: // Optional
// tags: // Recommended if using Pendo Feedback // You can add any additional account level key-values here,// as long as it's not one of the above reserved names.}

メタデータを用いたコード例

visitor:{
  id:              $user.ID,
  email:'$user.email',
  full_name:'$user.full_name',
  role:'$user.accessLevel',
  creationDate:    $user.creationDate,
tags: ['$user.accessLevel','$user.creationDate'] }, account:{ id:'$account.ID', name:'$account.name', is_paying:'$account.is_paying', monthly_value:'$account.monthly_value', planLevel: $account.subscriptionCost, isFoo: $account.isFoo,
tags: ['$account.subscriptionCost','$account.isFoo'] }

Pendoに送られたコード例

visitor:{
  id:62343,
  email:'john@doe.com',
  full_name:'John Doe',
  role:'admin',
  creationDate:1404326949156},

account:{
  id:17,
  name:'Acme, inc',
  monthly_value:'99.99',
  is_paying:true,
  planLevel:995,
  isFoo:false}