Rokt

RoktのUniversal Module Definition (UMD)バンドルは、windowオブジェクトに公開され、Roktのソリューションをページに読み込んだ後に利用可能になります。

概要

Roktのスクリプトをページに読み込んだ後、Rokt UMDバンドルはwindow.Roktとしてwindowオブジェクト上で利用可能になります。スクリプトの読み込みが完了した後にRoktプロパティと対話することができ、スクリプトが非同期で読み込まれる場合には追加の処理が必要になることがあります。

同期読み込みの例

<script
  crossorigin="anonymous"
  src="https://apps.rokt.com/wsdk/integrations/launcher.js"
></script>

const launcher = await window.Rokt.createLauncher({
  accountId: "rokt-account-id",
});

上記の引数リストで次の重要なパラメータに注意してください:

• https://apps.rokt.com/wsdk/integrations/launcher.js — Rokt Launcherの最新バージョンを指すURLです。
• rokt-account-id — あなたのユニークなRoktアカウントIDで、正しい値に置き換える必要があります。アカウントIDがわからない場合は、Where can I find my Rokt Account ID?を参照してください。

非同期読み込みの例

<script
  async
  crossorigin="anonymous"
  id="rokt-launcher"
  fetchpriority="high"
  src="https://apps.rokt.com/wsdk/integrations/launcher.js"
  type="module"
></script>

await new Promise((resolve) =>
  window.Rokt
    ? resolve()
    : (document.getElementById("rokt-launcher").onload = resolve)
);

const launcher = await window.Rokt.createLauncher({
  accountId: "rokt-account-id",
});

スクリプトタグに存在する追加の属性に注意してください:

• async - スクリプトの非同期読み込みを有効にします
• id="rokt-launcher" - スクリプト要素のIDです。document.getElementById('rokt-launcher')に渡されるIDと一致する必要があります。
• type="module" - 読み込まれるリソースの優先度を高めます。詳細はベストプラクティスを参照してください。

さらに、Rokt UMDバンドルを取得するには、Promiseでラップする必要があります（例のように）。これは、非同期で読み込まれたRoktスクリプトが利用可能になった後にのみコードが実行されることを保証するためです。

メソッド

createLauncher

▸ createLauncher: (options: IntegrationLauncherOptions): Promise<IntegrationLauncher>

IntegrationLauncher のインスタンスを作成します。これは Rokt との統合のエントリーポイントです。作成したオブジェクトへの参照を保持するのは統合者の責任です。

同時に存在できるインスタンスは1つだけです。別のインスタンスを作成しようとすると、前のインスタンスが終了されていない限りエラーになります。

パラメータ:

名前	型	説明
options	IntegrationLauncherOptions	統合をカスタマイズするためのオプション

戻り値: IntegrationLauncher