訪問者の識別
Marketing Hub
- Professional or Enterprise
Sales Hub
- Professional or Enterprise
Service Hub
- Professional or Enterprise
CMS Hub
- Professional or Enterprise
注:
- 訪問者の識別APIは、訪問者が誰なのかをHubSpotに伝えることを目的としており、貴社のプラットフォームでのユーザー認証に使用することは推奨されません。
- 訪問者の識別APIを使用するには、ProfessionalまたはEnterpriseのサブスクリプションが必要となります。アカウントで必要なサブスクリプションが登録されていない場合は、APIから
403
エラー応答が返されます。
訪問者の識別機能との連携を使用するには、認証システムを備えた既存のWebアプリケーションが必要です。

1. フロントエンドで、ウィンドウ上のhsConversationsSettingsオブジェクトのloadImmediatelyをfalseに設定します。このように設定しないと、識別情報が渡される前にチャットウィジェットが読み込まれる場合があります。詳細については、以下のチャットウィジェットSDK入門をご確認ください。
hsConversationsSettings
プロパティーをisConversationsAPIReady
関数の外部で設定します。- また、呼び出しの前に
hsConversationsSettings
を設定しておく必要があります。設定しない場合、ウィジェットの読み込みを妨げる競合状態が発生する可能性があります。
2. 訪問者の識別APIに認証済み訪問者のEメールアドレスを渡して、トークンを生成します。この操作は、Webアプリケーションのバックエンドで行う必要があります。リクエストの例については、「エンドポイント」タブを参照してください。
- 訪問者の識別APIによって作成された新しいコンタクト
- 氏名がまだ登録されていない既存のコンタクト
この機能は、外部システムには氏名の情報がすでに登録されているが、HubSpotにはまだ登録されていない認証済みの訪問者に対してパーソナライズされたメッセージを作成する際に有効です。パラメーターの指定は任意で、必須ではありません。
3. ステップ2で生成したトークンを使用して、ウィンドウ上のhsConversationsSettings
オブジェクトで次のプロパティーを設定します。
4. ウィジェットを読み込みます。
認証済み訪問者に対してページが読み込まれるたびに、ウィンドウ上のhsConversationsSettings
オブジェクトでトークンとEメールを設定する必要があります。これらのパラメーターが設定されなくなると、以降のページの読み込み時に、コンテキストは自動的に保持されません。トークンは一時的なもので、12時間後に期限切れになります。トークンが少なくとも12時間に1回更新される場合、トークンをキャッシュして、ページを読み込むたびにトークンを再取得しなくて済むようにできます。
訪問者の識別機能との連携が完了したら、連携が想定通りに機能していることを確認します。以下に示すように、実装に応じて2通りの方法で確認できます。具体的な要件に合わせて、以下の例を調整する必要がある場合があります。
- 1つ以上の公開ページ上および認証システムの背後にチャットウィジェットを追加している場合:
- チャットウィジェットで訪問者を識別しないページに移動し、コミュニケーションを開始します。
- HubSpotで受信トレイを開き、受信したチャットが「不明な訪問者」に属していることを確認します。そうでない場合は、非公開のブラウザーウィンドウで次の手順を試してみてください。
- チャットウィジェットで訪問者の識別APIを使用して訪問者を識別するページに移動し、コミュニケーションを開始します。
- HubSpotで受信トレイを開き、ログインに使用したコンタクトにチャットが属性として正しく結び付けられていることを確認します。正しい関連付けが確認された場合、コンタクトの名前の横に、このコンタクトが訪問者の識別APIで正常に識別されたことを示すバッジが表示されます。
- 認証システムの背後にあるページにのみチャットウィジェットを追加しており、複数のテスト ユーザー アカウントにアクセスできる場合:
- 最初のテストユーザーとしてHubSpotにログインし、チャットウィジェットが読み込まれるページに移動して、コミュニケーションを開始します。
- HubSpotからログアウトし、2番目のテストユーザーとして再度ログインします。チャットウィジェットが読み込まれるページに移動し、コミュニケーションを開始します。
- HubSpotで受信トレイを開き、最初のテストアカウントと2番目のテストアカウントからそれぞれチャットが送信されていて、両方のレコードでコンタクト名の横にバッジが表示されていることを確認します。
注:訪問者の識別APIによって認証されたユーザーの場合、HubSpotはmessagesUtk
Cookieを設定しません。また、すでにEメールが登録されているため、Eメールキャプチャーの質問もスキップされます。このようなチャットでは、messagesUtk
CookieとEメールキャプチャーは適用されないため、訪問者の識別APIを介して認識されたユーザーにはチャットフローに関連する設定は表示されません。
hsConversationsSettings
オブジェクト
このオブジェクトを使用すると、設定オプションを指定してからウィジェットを初期化できます。訪問者の識別機能を使用するには、以下のフィールドを設定する必要があります。
パラメーター | データ型 | 説明 | 既定値 |
---|---|---|---|
loadImmediately
| ブール | ウィジェットを暗黙的に読み込むか、または |
true
|
identificationToken
| 文字列 | 訪問者の識別APIと連携するために使用されます。訪問者の識別API上のトークン生成エンドポイントによって提供されるトークンで、この訪問者が認証済みであることを証明するものとして使用されます。 |
""
|
identificationEmail
| 文字列 | ウィジェットを読み込む、識別済みの訪問者のEメールアドレス。 |
""
|
コミュニケーションSDKの詳細をご確認ください。
貴重なご意見をありがとうございました。