選択
概要
IntegrationLauncher.selectPlacements の結果として利用可能な Rokt 選択を表すオブジェクト。
メソッド
close
▸ close(): Promise<void>
選択内のすべてのプレースメントを閉じます。Rokt の選択プロセスが進行中かどうかに応じて、このメソッドは次のいずれかを行います:
- すでにページに追加されたプレースメントを削除する
- プレースメントが最初に追加されるのを防ぐ
戻り値: Promise<void>
getPlacements
▸ getPlacements(): Promise<Array<Placement>>
選択に返されたすべてのプレースメントを取得します。このメソッドは、Rokt の選択プロセスがページに表示可能なプレースメントがあると結論付けた時点で返されますが、プレースメントがページに読み込まれる前に返されます。
ページに利用可能なプレースメントがない場合、このメソッドは空の配列で解決されます。何らかの理由で選択プロセスが失敗した場合、このメソッドはエラーでプロミスを拒否します。
戻り値: Promise<void>
on
▸ on<T>(event: string): Subscriber<SelectionEvent<T>>
特定の名前を持つイベントにサブスクライブすることを可能にします。これは、選択内の任意の配置から発生します。このメソッドは、各配置に対して呼び出されるPlacement.onに効果的にサブスクライブします。
パラメーター:
| 名前 | 型 | 説明 |
|---|---|---|
event | string | サブスクライブするイベントの名前 |
戻り値: Subscriber<T>
ready
▸ ready(): Promise<T>
各配置が準備完了になるのを待つことを可能にします 。選択内の各Placement's readyが解決されるのを待つのと実質的に同じです。
選択内の配置のいずれかが何らかの理由で読み込まれなかった場合、プロミスはエラーで拒否されます。
戻り値: Promise<void>
send
▸ send<T>(name: string, data?: T): Promise<void>
各プレースメントにイベントを送信することを可能にします。選択された各プレースメントに対して Placement.send を呼び出すのと実質的に同じです。
すべてのプレースメントがメッセージを処理した後に、返されたプロミスが解決されます。
パラメーター:
| 名前 | 型 | 説明 |
|---|---|---|
name | string | イベントの名前 |
data | T | 指定されたイベントの期待されるペイロード |
戻り値: Promise<void>
setAttributes
▸ setAttributes(): Promise<void>
選択に対して追加の属性を設定することを可能にします。
関連性のために、すべての属性は 選択を行う際 に送信されるべきです。
戻り値: Promise<void>
プロパティ
context
• context : SelectionContext
Roktによって行われた選択のコンテキスト。