エージェントやインテグレーションを介しては渡されないデータをPendoに追加する場合、カスタムメタデータフィールドを使用してそのデータを提供できます。その後、ガイドのターゲティング用のレポートやセグメントを作成する際にこのデータを活用すれば、より具体的なユーザーのコホートに焦点を当てることができます。
ステップ1. カスタムメタデータフィールドを追加する
カスタムメタデータの値をユーザーに割り当てる前に、管理者はまず、データマッピングページにカスタムメタデータフィールドを追加する必要があります。
- [設定(Setting)]>[ データマッピング(Data Mappings)]に移動します。
- デフォルトでは、訪問者レベルのメタデータが表示されます。アカウントまたは親アカウント用にカスタムメタデータフィールドを追加したい場合は、対応するタブを選択します。
- [メタデータ(Metadata)]テーブルの下部で、[表示名(Display Name)]として[カスタムフィールドを追加(Add Custom Field)]があるフィールドを見つけます。
- 任意の表示名を入力し、ドロップダウンメニューから適切な[タイプ(Type)] (テキスト、ブール値、数値、日付)を指定して、[+追加(+ Add)]を選択します。
追加すると、表示名は[フィールド名(Field Name)]の列にコピーされ、変更できなくなります。ただし、この表示名は後でいつでも変更できます。 - 必要に応じて、カスタムフィールドごとにステップ2から4を繰り返します。
カスタムフィールドを追加すると、[詳細(Details)]>[カスタム(Custom)]より、特定の訪問者またはアカウントの[訪問者の詳細情報(Visitor Details)]または[アカウントの詳細情報(Account Details)]ページでそのフィールドを確認できます。
ステップ 2. ユーザーにカスタム値を追加する
[データマッピング]に追加すると、訪問者またはアカウントにカスタム値を追加できます。訪問者とアカウントのカスタムメタデータ値を追加または更新するには、いくつかの方法があります。
カスタムフィールドを手動で更新する
特定の訪問者またはアカウントの[訪問者の詳細情報(Visitor Details)]ページまたは[アカウントの詳細情報(Account Details)]ページに移動して、単一の訪問者およびアカウントのカスタムメタデータフィールドを手動で更新できます。上部の[詳細(Details)]セクションを開き、 [カスタム(Custom)]セクションを見つけて、関連するフィールドを変更します。
この方法は、セグメントで少数のフィールドのみを更新する必要がある場合に便利です。
CSVアップロードでカスタムフィールドを更新する
1回のCSVアップロードで複数の訪問者またはアカウントレコードを更新でき、1ファイルあたり最大24のメタデータフィールドを使用できます。
注:すべての訪問者ID、アカウントID、メタデータフィールドが、Pendoで表示されるのとまったく同じようにファイルに表示されていることを確認することが重要です。ファイルに既存の訪問者またはアカウントと一致しない訪問者IDまたはアカウントIDが含まれている場合、Pendoに新しいレコードが作成されます。ファイルにデータマッピングページの内容と正確に一致しないメタデータフィールドが含まれている場合、CSVのアップロードは失敗します。
- CSVファイルの例のコピーを保存し、それを使ってデータを入力します。ファイルを保存するには、Googleアカウントにサインインしている必要があります。
Googleアカウントをお持ちでない場合は、お好きなテキストエディターで独自のファイルを作成できます。独自のファイルを作成する場合は、上記のスクリーンショットの例と同様に、最初の列ヘッダーがvisitIdであり、後続の各列ヘッダーに各カスタムメタデータフィールドが含まれていることを確認してください。 - 訪問者ではなくアカウントを更新する場合は、最初の列ヘッダーをaccountIdに更新します。親アカウントを更新する場合は、最初の列ヘッダーをparentAccountIdに更新します。
- 後続の列ヘッダーのメタデータフィールド名の例を、データマッピングページに表示される正しいフィールド名に置き換えます。すべての訪問者ID、アカウントID、メタデータフィールド、および値では大文字と小文字が区別されます。
- 必要に応じて列を追加または削除し、メタデータフィールドがデータマッピングとまったく同じように表示されるようにします。
- 必要な値をすべて更新したら、ファイルをCSV形式で保存します。Googleスプレッドシートを使用している場合は、 [ファイル(File)]>[ダウンロード(Download)]>[カンマ区切りの値 (.csv)(Comma Separated Values (.csv))]を選択して保存します。
- [ピープル(People)]>[訪問者(Visitors)]または[ピープル(People)]>[アカウント(Account)]に移動し、一番下の[訪問者]または[アカウント(Account)]リストを見つけ、テーブルの右上にある[CSVをアップロード(Upload CSV)]を選択します。
- [ファイルを選択(Choose File)]を選択し、デバイスに保存したCSVファイルを選択して、[ファイルをアップロード(Upload File)]を選択します。更新されたメタデータの値がPendoに表示されるまで、15分ほどかかることがあります。
- 必要に応じて、テーブルの右上にある[列を管理(Manage Columns)]アイコンを選択し、関連するメタデータフィールドを列としてテーブルに追加します。
APIを使用してカスタムフィールドを更新する
また、APIを使ってカスタムフィールドを1つずつ、または一括で更新することもできます。
PostmanなどのAPIツールを使用すると、APIエンドポイントを使用して単一のレコードを更新できます。 使用するAPIエンドポイントは、Pendoにアクセスする環境によって異なります。 対応するエンドポイントの表を参照し、以下のガイドラインに従ってください。
環境 | エンドポイント |
米国 | https://app.pendo.io/api/v1/metadata/visitor/custom/value |
EU | https://app.eu.pendo.io/api/v1/metadata/visitor/custom/value |
JPN | https://app.jpn.pendo.io/api/v1/metadata/visitor/custom/value |
US1 | https://us1.app.pendo.io/api/v1/metadata/visitor/custom/value |
- まず、[x-pendo-integration-key]の横にあるAPIコールの[ヘッダー(Headers)]セクションにインテグレーションキーを追加します。インテグレーションキーを作成するには、Pendo管理者が[設定]>[インテグレーション(Integrations)]>[インテグレーションキー(Integration Keys)]に移動して、[インテグレーションキーを追加(Add Integration Key)]を選択します。さらに[書き込みアクセスを許可(Allow Write Access)]を選択すれば、そのキーでPendoにデータを正しくプッシュできます。
- 次に、リクエストの[本文(Body)]を以下のように記述します。このとき、「john.doe@pendo.io」を適切な訪問者IDに、「Role」をカスタムメタデータフィールドに、「Field Sales」をカスタムメタデータ値に置き換えます。
[{
"visitorId": "john.doe@pendo.io",
"values": {
"role": "Field Sales"
}
}]
APIを使用して複数の訪問者IDを更新する場合も、必要なAPIコールは、単一のレコードを更新するための上記の内容と同様です。Pendoに渡したいメタデータが別のシステムに存在し、そのデータにアクセスできない場合は、開発チームの支援が必要になる可能性があります。詳しくは、API資料の一連のエージェントまたはカスタムフィールドに値を設定するを参照してください。