提供: Bright Pattern Documentation
• English
onWebScreenPopCustom
このコールバックを使用すると、Webスクリーンポップハンドラをカスタマイズし、既定のWebスクリーンポップの動作をブラウザのポップアップで上書きすることができます。リスナーがtrueを返す場合、既定の動作は実行されません。リスナーがfalseを返す場合、既定のハンドラが、あなたの処理の後にデータを処理中です。
リクエスト
構文
| on('ON_WEB_SCREEN_POP_CUSTOM', handler: OnWebScreenPopCustomHandler): void
アクション: 'OPEN_WEB_PAGE' | 'DISPLAY_TEXT' url: string コンテンツ: string ラベル: string ポップアップする: boolean keepPopupOpenAfterFinish: boolean popup: boolean secondaryUrls?: { [key: number]: WebScreenPopSecondaryUrl } }
ラベル?: string url?: string } |
パラメータ
| パラメータ | パラメータ値 | データ型 | オプション/必須 | 説明 |
| itemId | 文字列 | 必須 | この画面ポップインの発生元となった項目のid | |
| webScreenPop | ||||
| アクション | 文字列 | 必須 | 画面ポップインのタイプです。オプションは以下の通りです:
| |
| url | 文字列 | 必須 | メインのURLです。「OPEN_WEB_PAGE」アクションオプションでのみ使用されます。 | |
| コンテンツ | 文字列 | 必須 | 表示するテキストです。アクションオプション「DISPLAY_TEXT」でのみ使用されます。 | |
| ラベル | 文字列 | 必須 | このポップアップ画面の見出し | |
| popUponAnswer | ブール値 | 必須 | true に設定すると、インタラクションがエージェントにルーティングされた時点で画面ポップアップが表示されます。false に設定すると、エージェントがインタラクションを承認した後にのみ画面ポップアップが表示されます。 | |
| keepPopupOpenAfterFinish | ブール値 | 必須 | true に設定すると、インタラクション終了後も画面ポップアップは開いたままになります。false に設定すると、インタラクション終了時に画面ポップアップは閉じられます。 | |
| popup | ブール値 | 必須 | true に設定すると、スクリーンポップはポップアップウィンドウとなり、false に設定すると、スクリーンポップはインラインのスクリーンポップとなります。 | |
| secondaryUrls | オプション | 複数のスクリーンポップを同時に表示するための追加の URL の値を含むオブジェクト |
リクエスト例
function webScreenPopCustomHandler(itemId: string, screenPopData: WebScreenPop) {
window.open(screenPopData.url, "_blank");
return true;
}
adApi.on("ON_WEB_SCREEN_POP_CUSTOM", webScreenPopCustomHandler);
戻り値
デフォルトのハンドラーの動作を阻止するかどうかによって、ブール値(true または false)が返されます。