このページは Cloud Translation API によって翻訳されました。

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

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

関数とプロパティ

関数とプロパティにより、要素の初期化をきめ細かく制御できます。

init

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

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

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

スキャン

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

window.bmwidget.scan():void

サポート対象

ユーザーのデバイスがビジネスメッセージをサポートしている場合は、読み取り専用のブール値フラグです。

window.bmwidget.supported:boolean

イベント

このライブラリは、Business Messages ウィジェットとして初期化する 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);
});

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