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