Integration Launcher
概要
統合ランチャーは、ユーザーがサイト上での旅を通じてRoktエコシステムとの対話を可能にする、ページにロードされるシングルトンサービスです。
メソッド
'captureConversion'
▸ captureConversion(options): CaptureConversionOptions): Promise<void>
広告主が潜在的なコンバージョンを記録するためのメソッドです。このメソッドは広告主専用であり、ページ上にプレースメントを表示することが期待されている場合は使用しないでください。その場合は、IntegrationLauncher.selectPlacementsを代わりに使用する必要があります。
参照
コンバージョンの報告 には、コンバージョンの報告方法に関する情報が記載されています。
パラメーター:
名前 | タイプ |
---|---|
options | CaptureConversionOptions |
戻り値: Promise<void>
'hashAttributes'
▸ hashAttributes(attributes: Attributes): Promise<Record<string, string>>
Roktの推奨ハッシュメソッド(現在はSHA256)を使用して、渡された属性をハッシュ化するためのユーティリティメソッドです。このメソッドは、各属性値の正規化と属性名の変更による値のハッシュ化を隠すため、カスタム実装よりも優れています。
詳細については、Two-step data integrationを参照してください。
パラメータ:
名前 | タイプ |
---|---|
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 | 拡張機能の名前。 名前が既知の拡張機能にマップされていない場合、メソッドはエラーで拒否されます。 |
戻り値: Promise<T>
戻り値: Promise<void>
プロパティ
'version'
• version: string
ページで使用されている統合ランチャーのバージョン。