統合ランチャーオプション
概要
IntegrationLauncher のインスタンス用オプション。統合ランチャーのインスタンスを作成する際には、あなたのユニークな Rokt アカウント ID を渡す必要があります。他のパラメータはオプションであり、統合の動作を設定することができます。
プロパティ
accountId
• accountId : string
あなたのユニークな Rokt アカウント ID。Rokt アカウント ID の見つけ方については、Where can I find my Rokt Account ID? を参照してください。
noFunctional (オプション)
• noFunctional? : boolean
default false
機能的なクッキーに対するユーザーの好みを管理するためのブールフラグです。機能的なクッキーは、あなたのサイト上で最も関連性が高く最適な顧客体験を提供するために、パーソナライズを強化します。また、チェックアウト内の高度な機能（例：アップセルの販売）をサポートします。実際には、この値を true に設定すると、Rokt が1stパーティのトラッキング ID を使用することを防ぎます。このオプションの機能と影響についての詳細。
pageInitTimestamp (オプション)
• pageInitTimestamp? : Date
SPA (シングルページアプリケーション) の仮想ページでIntegration Launcherが初期化される場合、この値を使用して初期化されるページのタイムスタンプを提供できます。これにより、Roktはそのページがトリガーされた際のロードパフォーマンスを正確に測定でき、ユーザーがそのページに到達するまでの時間などの外部要因を排除できます。この情報を基に、Roktはロード時間の異常を検出し、統合の効率に影響を与える可能性のある問題を特定できます。
デフォルト PerformanceNavigationTiming.responseStart
異常検出 で、Roktがロードパフォーマンスをどのように追跡するかを参照してください。
シングルページアプリケーション でSPA統合の詳細を参照してください
sandbox (オプション)
• sandbox? : boolean
デフォルト false
セッションにサンドボックス環境を使用するかどうかを示すブールフラグです。
本番環境では、これをtrueに設定しないでください。
このフラグは以下のケースで有用です:
- パートナーが本番環境の設定に対してユーザー受け入れテストを行い、本番でのローンチ前にリファラルを生成しないようにする場合。
- パートナー側の継続的インテグレーション環境でサンドボックスが使用される場 合。
参照 サンドボックス統合 で追加情報と例を確認してください。
sessionId (オプション)
• sessionId? : string
既に生成されたセッションIDがある場合に渡すRoktセッションID。
例えば、タグが表示されるページを訪れる前にRoktバックエンドと接続してセッションIDを生成することが可能です。この場合、事前に生成されたRoktセッションIDをこのパラメータとして提供することで、Roktが両方のインタラクションを結びつけることができます。
overrideLinkNavigation (オプション)
• overrideLinkNavigation? : boolean
default false
trueに設定すると、Roktはリンクのオープンを直接処理しなくなります。代わりに、LINK_NAVIGATION_REQUEST パートナーイベントが発行されます。
このフラグは、パートナーがカスタマイズされたリンク処理を必要とするシナリオで役立ちます。一般的なユースケースとしては、Roktや広告主からのリンクを外部ブラウザで開く一方で、リンクをWebView内で開くなど、異なるリンク動作を管理するこ とです。Roktと広告主のリンクを区別するために、パートナーはURLに"rokt.com"というサブストリングが含まれているかを確認できます。
適切なイベント処理を確保するために、タイムアウトメカニズムが導入されています。LINK_NAVIGATION_REQUESTイベントが3秒以内に消費されない場合、エラーが発生します。この予防策は、イベントを処理するためのアクティブなサブスクリプションがパートナー側に存在することを保証し、それがない場合にはRoktに通知されます。