ビジネスメッセージウィジェット

Business Messages ウィジェットの JavaScript ライブラリは、プログラムによってビジネスメッセージウィジェットのエンゲージメントトラッキングを有効にします。

関数とプロパティ

関数とプロパティでは要素をきめ細かく制御できる初期化します。

init

広告で使用する HTML 要素を動的に初期化します。ビジネスメッセージウィジェット。この関数は、次の場合に解決される Promise を返します。初期化を完了します。

window.bmwidget.init(HTMLElement, {agentId, context}):Promise

HTMLElement は、ウィジェットとして初期化する要素です。
{agentId, context} は、data-bm-widget-agent-id と data-bm-widget-context HTML 属性。

スキャン

ドキュメントをスキャンして、 data-bm-widget-agent-id 属性を取得し、それらの要素を Business メッセージウィジェット。window.bmwidget.scan() はページの読み込み時に自動的に呼び出されますスクリプトの初期化時に行われます。

window.bmwidget.scan():void

サポート対象

読み取り専用のブール値のフラグ。ユーザーのデバイスがサポートしていれば、true になります。ビジネスメッセージ。

window.bmwidget.supported:boolean

イベント

ライブラリは、次のように初期化される HTML 要素でイベントをトリガーします。ビジネスメッセージウィジェット。

バインド成功

bm-widget-bind-success イベントは、HTML 要素がビジネスメッセージウィジェットとしてバインドされ、使用できるようになりました。

domNode.addEventListener('bm-widget-bind-success', (event) => {
  console.log(event.data);
});

バインド失敗

bm-widget-bind-fail イベントは、HTML にバインドしようとするとトリガーされます。失敗します。URL の検証に失敗した場合や、これは HTML 要素を取得できない一般的な原因です。検証失敗 URL がビジネスメッセージウィジェットのエントリとして登録されていない場合に発生します。デバイスがサポートされていません。 event.data プロパティの詳細特定できます。

domNode.addEventListener('bm-widget-bind-fail', (event) => {
  console.log(event.data);
});

インテントトリガー

bm-widget-intent-trigger イベントは、初期化されたビジネスをユーザーがタップしたときにトリガーされます。メッセージウィジェットのエントリポイント。このイベントはタップを通知しますが、ビジネスメッセージの会話サーフェスが正常に初期化されたかどうか。

domNode.addEventListener('bm-widget-intent-trigger', (event) => {
  console.log(event.data);
});

ビジネス メッセージ ウィジェット