Live ChatのトラッキングSDK People

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

この SDK を使用すると、顧客についてより深い洞察が得られ、顧客のニーズをより深く理解できます。

主な用語

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

• Live Chat ページ: Live Chat が統合されている Web サイト。
• Live Chat ユーザー: Live Chat ページにアクセスするユーザー。
• 訪問者: チャットを開始していない、または認証されていない Live Chat ページの匿名訪問者。
• ユーザー:チャットを開始した、または認証されたリードまたは認証済みユーザー。認証の詳細については、「ユーザーと認証」を参照してください。
• ユーザー アクティビティ: ユーザーについて追跡されたイベントで、保存され、プロファイルに一覧表示されます。
• 個人プロフィール: 個人用に作成されたプロフィールで、表示できます。
• 訪問者プロファイル: 訪問者用に作成されたプロファイル。訪問者が人になるまでは閲覧できません。

People tracking SDK 機能

People tracking SDK を使用すると、次のことができます。

• 「セッション開始」、「セッション終了」、「ページビュー」などのユーザーのアクティビティイベントを追跡します。
• 定義したカスタムイベントを追跡します。
• ユーザーのプロパティと属性を更新します。

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

「ページビュー」イベントは、ユーザーが Live Chat ページを開いたときに SDK が初期化されたときにトリガーされます。詳細は People events を参照してください。

プロファイルの選択

ユーザー アクティビティの追跡に使用されるプロファイルは、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 セッションがある場合、対応するユーザープロファイルがアクティビティ追跡用に自動的に選択されます。

トラック()

例

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' },
  externalId: 'number123456',
  firstName: 'Semi',
  gender: 'male',
  integrations: { salesforce: { contactId: '123', leadId: '456' }},
  lastName: 'Holsen',
  middleName: 'Gabcik',
  preferredLanguage: 'it-it',
  profilePicture: 'https://profile.com',
  tags: ['reading', 'technology']
});

appendToList()

例

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

応答

各関数は、オブジェクトに解決される Promise を返します。キープロパティはsuccessで、操作の結果を示します。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 の使用中に発生する可能性のあるエラーの一覧です。