Live ChatのPeopleトラッキングSDK

PeopleトラッキングSDKは、PeopleウェブSDK (opens in a new tab) 機能をLive Chatに統合します。これにより、Live Chatを使用してウェブサイトでのユーザー クティビティを追跡し、Live Chatセッション中に同じプロファイルを維持することで、統一されたパーソンプロファイルを構築できます。

このSDKを使用すると、顧客についてより掘り下げたインサイトが得られ、顧客ニーズについての理解が一段と深まります。

主な用語

このドキュメントでは、次の用語が使用されています：

• Live Chatページ：Live Chatが統合されているウェブサイト。
• Live Chatユーザー：Live Chatページにアクセスするユーザー。
• ビジター：チャットを開始していない、または認証されていない Live Chatページの匿名ビジター。
• ユーザー：チャットを開始した、または認証されたリードまたは認証済みユーザー。認証の詳細については、[ユーザーと認証]について詳述しているドキュメントをご参照ください。
• ユーザーアクティビティ：ユーザーについて追跡し、保存され、それぞれのプロファイルに一覧表示されるあらゆるイベント。
• パーソンプロファイル：特定のパーソンについて作成された、閲覧可能なプロファイル。
• ビジタープロファイル：ビジター用に作成されたプロファイル。ビジターがパーソンになるまでは閲覧できません。

PeopleトラッキングSDK機能

PeopleトラッキングSDKを使用すると、以下が可能です：

• Session started (セッション開始)、Session ended (セッション終了)または Page view (べージビュー)といったユーザーアクティビティのイベントの追跡。
• 定義したカスタムイベントの追跡。
• パーソンのプロパティと属性の更新。

Session started (セッション開始)は、最初のユーザーアクティビティ(ページビューやカスタムイベントなど) が記録された時にトリガーされます。セッションは、最後に記録されたユーザーアクティビティから30分後に期限切れになり、その時点でSession ended (セッション終了)イベントがトリガーされます。新しいセッションは、次に記録されたユーザーアクティビティから開始されます。

Page view (べージビュー)イベントは、ユーザーが Live Chatページを開いた際にSDKが初期化された時にトリガーされます。詳しくは、 Peopleのイベント について詳述しているドキュメントをご参照ください。

プロファイルの選択

ユーザーアクティビティの追跡に使用されるプロファイルは、Live Chatセッションに基づいて決定されます。Live Chatセッションは、ユーザーがチャットを開始するかユーザーが認証された時に確立されます。

下記の表は、様々な状況で選択されるプロファイルをまとめています：

ビジターのライフサイクル

ユーザーが初めてLive Chatページにアクセスすると、新しいビジタープロファイルが作成されます。このプロファイルは、最後のビジターアクティビティから45日間 アクティブな状態で保たれます。ビジターがチャットを開始するか認証を行うまでは、ページに戻るたびにこのプロファイルが再利用されます。

45日以内にアクティビティが発生しない場合、ビジタープロファイルは削除されます。新しいプロファイルは、次のアクティビティが追跡される時に作成されます。

PeopleトラッキングSDKの使用法

まず、すべてのSDK関数へのアクセスを提供するSDKのインスタンスを作成 (SDKオブジェクトを取得)します。

const sdk = new PeopleTrackingSDK();

提供されている関数

SDKには、Live Chatのユーザープロファイルの構築や管理に使用可能な以下の関数が含まれています。

init()

例

sdk.init('725f7...55b9');

初期化後、 (Live Chatセッションのユーザーが存在しない場合) 新しいLive Chatユーザー用のビジタープロファイルが作成され、ページビューイベントが追跡されます。既存のLive Chatセッションがある場合、対応するユーザープロファイルがアクティビティ追跡用に自動的に選択されます。

track()

例

pe.track('action', { name: 'Button clicked', label: 'add-to-favorites' });

updatePerson()

例

sdk.updatePerson({ 
  address: 'Kirchmayer street 97', 
  birthDate: '1993-01-01',
  city: 'Prague',
  contactInformation: {
    email: [{ address: 'email@infobip.com' }],
    phone: [{ number: '421905123450' }]
  },
  country: 'Czech Republic',
  customAttributes: { car: 'Mercedes' },
  firstName: 'Semi',
  gender: 'male',
  lastName: 'Holsen',
  middleName: 'Gabcik',
  preferredLanguage: 'it-it',
  profilePicture: 'https://profile.com',
  tags: ['reading', 'technology']
});

appendToList()

例

pe.appendToList('category', { name: 'special' });

応答

各関数は、オブジェクトに解決されるPromiseを返します。keyプロパティはsuccessで、操作の結果を示します。successがtrueの場合、警告などの追加の詳細がdataプロパティに含まれることがあります。successがfalseの場合、追加の詳細情報がerrorプロパティに含まれます。

解決されたPromiseの例

{
  "success": true,
  "data": null
}

解決に失敗したPromiseの例

{
  "success": false,
  "error": {
    "code": 2015,
    "name": "NotInitializedPeopleTrackingError",
    "message": "People tracking SDK is not initialized. Call init() first",
    "origin": "fe-snippet",
    "platform": "fe-snippet"
  }
}

エラーのプロパティ

originプロパティはシステム内でエラーが発生した場所を指定し、platformプロパティはエラーが表面化した場所または報告された場所を示します。

エラーの解釈に役立つ、最も重要なプロパティは code、name、そして特にエラーの原因に関する詳細情報を提供する messageです。

一般的なSDKエラー

次の表は、SDKの使用中に発生する可能性のあるエラーの一覧です。