Browser Unified SDKリファレンス

本リファレンスでは、@amplitude/unifiedのすべてのパブリックエクスポートおよびinitAll()に渡すことができるすべてのオプションについて、バージョン1.1.43に基づき記載しています。このバージョンではBrowser SDK 2.48.1(@amplitude/analytics-browser)がバンドルされているため、すべての分析メソッドはBrowser SDK 2リファレンスに記載されているとおりに動作します。バージョン間の変更点については、@amplitude/unified変更履歴を参照してください。

ts
import * as amplitude from "@amplitude/unified";

トップレベルの関数はデフォルトのインスタンスで動作します。createInstance()の各インスタンスは、共通のメソッドとプラスinit()を保持しています。

エクスポート

トップレベルモジュールはinit()をエクスポートしません。代わりにinitAll()を呼び出してください。

セットアップ

initAll

分析を初期化し、セッションリプレイ、機能実験、ガイドとサーベイを追加します。各ページロード時に、インスタンスごとに1回呼び出します。

ts
initAll(apiKey: string, unifiedOptions?: UnifiedOptions): Promise<void>

initAll()は、AmplitudeReturnではなくプレーンなPromiseを返します。そのため、直接awaitしてください。すべてのプロダクトのセットアップが完了した後に解決されます。解決される前に行われた呼び出しは、キューで待機し、その後順番に実行されます。

以前の呼び出しがまだ保留中の状態で行われたinitAll()呼び出しでは、同じ promise が返されます。 前の呼び出しが解決された後に行われた呼び出しでは、完全なセットアップが再度実行されます。initAll()repeat呼び出しは、分析を再度初期化し、ページビュー追跡が有効になっている場合に別のページビューを追跡し、セッションリプレイを再起動します。また、Plugin with name @amplitude/unified-library-plugin already exists, skipping registrationをログに記録します。

ts
await amplitude.initAll("YOUR_API_KEY", {
  serverZone: "EU",
  sessionReplay: { sampleRate: 0.1 },
});

実験

Feature実験クライアント、またはinitAll()がそれを追加する前のundefinedを返します。

ts
experiment(): IExperimentClient | undefined

クライアントは実験JavaScript SDKクライアントです。クライアントはinitAll()期間中にフラグを取得しません。fetch()をvariant()の前に呼び出します。

ts
const experiment = amplitude.experiment();
await experiment?.fetch();
const variant = experiment?.variant("checkout-redesign");

sessionReplay

セッションリプレイクライアント、またはinitAll()がそれを追加する前のundefinedを返します。

ts
sessionReplay(): AmplitudeSessionReplay | undefined
ts
const replay = amplitude.sessionReplay();
replay?.stop();

録画オプションについては、セッションリプレイプラグインを参照してください。

createInstance

独自の分析設定、ID、キュー、プラグインを使用して独立したインスタンスを作成します。

ts
createInstance(): UnifiedClient
ts
const marketing = amplitude.createInstance();
await marketing.initAll("MARKETING_API_KEY", { instanceName: "marketing" });
marketing.track("Signup Completed");

ガイドとサーベイは、ページごとに一度初期化されます。 最初のインスタンスの後にinitAll()を呼び出すインスタンスは、そのengagementオプションを無視します。

UnifiedClient

デフォルトのインスタンスが実装して返すインターフェイス。 createInstance()これは、Browser SDK 2 BrowserClientを次のメンバーで拡張します:

統合オプション

initAll()に渡すオプションオブジェクト。すべてのオプションはオプションです。

共有オプション

initAll()はこれらのオプションをすべてのプロダクトに渡し、各プロダクトブロックの同じ名前のオプションにマージします。設定されていない共有オプションは、同じ名前のプロダクトオプションをundefinedで上書きします。

プロダクトオプション

実験オプション

エンゲージメントオプション

これは役に立ちましたか?

For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

このページでは