インテグレーション
Salesforce Interaction SDK には、Web SDK に固有のイベントにリスナーをバインドするために使用できる組み込み CustomEvents があります。このイベントにより渡されたデータは、リスナーのコールバック関数に渡されるイベントオブジェクトの詳細プロパティ内にあります。
Salesforce Interaction SDK 組み込みカスタムイベント。
1SalesforceInteractions.CustomEvents = {
2 OnBeforeEventSend: "interactions:onBeforeEventSend",
3 OnClearPersistedIdentities: "interactions:onClearPersistedIdentities",
4 OnConsentRevoke: "interactions:onConsentRevoke",
5 OnEventSend: "interactions:onEventSend",
6 OnException: "interactions:onException",
7 OnInit: "interactions:onInit",
8 OnInitSitemap: "interactions:onInitSitemap",
9 OnPageMatchStatusUpdated: "interactions:onPageMatchStatusUpdated",
10 OnResetAnonymousId: "interactions:onResetAnonymousId",
11 OnSetAnonymousId: "interactions:onSetAnonymousId",
12 OnShutDown: "interactions:onShutDown"
13}| カスタムイベント | 説明 |
|---|---|
| OnBeforeEventSend | このイベントは、SalesforceInteractions.sendEvent に渡されるデータが消費モジュールに配信される前に表示されます。 |
| OnClearPersistedIdentities | このイベントは、SalesforceInteractions.clearPersistedIdentities が呼び出されたときに表示されます。 |
| OnConsentRevoke | OnConsentRevoke イベントは、同意を提供したユーザが後で同意を取り消した場合にディスパッチされます。 |
| OnEventSend |
OnEventSend イベントは、イベント API への要求が SalesforceInteractions.sendEvent を介して送信されるたびにディスパッチされます。このイベントには、イベントパイプラインで処理された actionEvent ペイロー��が含まれます。 |
| OnException |
OnException イベントは、操作が失敗した場合にディスパッチされ、エラーに関する情報とそのコンテンツを含みます。OnException イベントは、ランタイムエラーのデバッグと記録に使用できます。 |
| OnInit | OnInit イベントは、Web SDK が初期化されたときにディスパッチされます。OnInit イベントは単一ページアプリケーション (SPA) のデバッグに使用できます。通常、単一ページアプリケーションでは、ページ読み込みイベントなしでビーコンとサイトマップを再初期化する必要があります。 |
| OnInitSitemap |
OnInitSitemap イベントは、Web SDK サイトマップが SalesforceInteractions.initSitemap 関数を介して初期化されるたびにディスパッチされます。 |
| OnPageMatchStatusUpdated |
OnPageMatchStatusUpdated イベントは、サイトマップのページ種別の一致状況が更新されるたびにディスパッチされます。matchStatus 配列は、イベントがディスパッチされるたびに、一致状況が更新された順序で蓄積されます。状況が running の場合、PageMatchStatus には開始時刻が含まれます。逆に、状況が selected、rejected、または matched の場合、PageMatchStatus には終了時刻が含まれます。selected ページ種別は、照合される最初のページ種別です。サイトマップでは、他の matched ページ種別は評価されません。 |
| OnResetAnonymousId | このイベントは、SalesforceInteractions.resetAnonymousId が呼び出されたときに表示されます。 |
| OnSetAnonymousId | OnSetAnonymousId は、Web SDK によって新しい追跡 ID が顧客に割り当てられたときに表示されます。 |
| OnShutDown | OnShutDown イベントは、Web SDK にシャットダウン信号が送信されたときにディスパッチされます。 |
例
1document.addEventListener('salesforce:onEventSend', (customEvent) => {
2 console.log('On Event Send: ', customEvent.detail)
3});
4
5SalesforceInteractions.sendEvent({
6 interaction: {
7 name: 'integration_hook_test'
8 }
9})