統合ランチャー
概要
統合ランチャーは、ページに読み込まれるシングルトンサービスで、ユーザーのサイト利用中にRoktエコシステムとのインタラクションを可能にします。
メソッド
'captureConversion'
▸ captureConversion(options): CaptureConversionOptions): Promise<void>
広告主が潜在的なコンバージョンを記録することを可能にします。このメソッドは広告主専用であり、そのためページ上にプレースメントを表示することが予想される場合には使用しないでください。この場合、代わりに IntegrationLauncher.selectPlacements を使用するべきです。
コンバージョンの報告方法については、コンバージョンの報告を参照してください。
パラメーター:
| 名前 | タイプ |
|---|---|
options | CaptureConversionOptions |
戻り値: Promise<void>
'hashAttributes'
▸ hashAttributes(attributes: Attributes): Promise<Record<string, string>>
渡された属性をRoktの推奨ハッシュ方式（現在はSHA256）でハッシュするユーティリティメソッド。このメソッドは、各属性値を正規化し、属性名を変更してその値がハッシュされたことを示す複雑さを隠すため、カスタム実装よりも推奨されます。
詳細については、ハッシュ属性を参照してください。
パラメーター:
| 名前 | 型 |
|---|---|
attributes | Attributes |
戻り値: Promise<Record<string, string>>
'selectPlacements'
▸ selectPlacements(options: SelectPlacementsOptions): Promise<Selection>
ページに表示されるプレースメントを選択し、Selection の返されたインスタンスを介してそれと対話することを可能にします。このメソッドは、選択が完了する前に返され、ページに表示される前に選択されたプレースメントと対話できるようにします。たとえば、イベントへのリスナーを設定したり、関連性がなくなった場合に選択を閉じたりします。
このメソッドは、広告主がコンバージョンを追跡するためにも使用できます。
パラメーター:
| 名前 | 型 |
|---|---|
options | SelectPlacementsOptions |
戻り値: Promise<Selection>
'terminate'
▸ terminate(): Promise<void>
ページからRokt統合を終了し、クリーンアップします。
戻り値: Promise<void>
'use<T>'
▸ use<T>(): Promise<T>
コアの統合ランチャーでサポートされていない追加機能（拡張機能）をリクエストすることができます。
パラメータ:
| Name | Type |
|---|---|
name | 拡張機能の名前。 名前が既知の拡張機能にマップされない場合、メソッドはエラーで拒否されます。 |
戻り値: Promise<T>
戻り値: Promise<void>
プロパティ
'version'
• version: string
ページで使用されている統合ランチャーのバージョン。