セレクション
概要
これは、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のreadyが解決されるのを待つのと実質的に同じです。
選択内の配置のいずれかが何らかの理由でロードに失敗した場合、プロミスはエラーで拒否されます。
戻り値： Promise<void>
send
▸ send<T>(name: string, data?: T): Promise<void>
各配置にイベントを送信することを許可します。選択された各配置で Placement.send を呼び出すのと実質的に同じです。
すべての配置がメッセージを処理すると、返されたプロミスは解決されます。
パラメーター:
| 名前 | 型 | 説明 |
|---|---|---|
name | string | イベントの名前 |
data | T | 指定されたイベントに期待されるペイロード |
戻り値: Promise<void>
setAttributes
▸ setAttributes(): Promise<void>
選択に対して追加の属性を設定することを許可します。
関連性を保つため、すべての属性は making the selection の間に送信されるべきです。
戻り値: Promise<void>
プロパティ
context
• context : SelectionContext
Roktによって行われた選択のコンテキスト。