Browser Unified SDKリファレンス
本リファレンスでは、@amplitude/unifiedのすべてのパブリックエクスポートおよびinitAll()に渡すことができるすべてのオプションについて、バージョン1.1.43に基づき記載しています。このバージョンではBrowser SDK 2.48.1(@amplitude/analytics-browser)がバンドルされているため、すべての分析メソッドはBrowser SDK 2リファレンスに記載されているとおりに動作します。バージョン間の変更点については、@amplitude/unified変更履歴を参照してください。
import * as amplitude from "@amplitude/unified";
トップレベルの関数はデフォルトのインスタンスで動作します。createInstance()の各インスタンスは、共通のメソッドとプラスinit()を保持しています。
エクスポート
| エクスポート | 概要 |
|---|---|
initAll、experiment、sessionReplay、createInstance | Unified SDKに固有のものです。 このページで説明されています。 |
track, logEvent, identify, groupIdentify, setGroup, revenue, flush, add, remove, setTransport, getUserId, setUserId, getDeviceId, setDeviceId, getIdentity, setIdentity, getSessionId, setSessionId, extendSession, reset, getOptOut, setOptOut | Browser SDK 2のメソッド。Browser SDK 2リファレンスに移動します。 |
Identify, Revenue, Types | Browser SDK 2から再エクスポートされました。Identify、Revenue、Typesに移動します。 |
UnifiedOptions, UnifiedSharedOptions, UnifiedClient | TypeScript型のみであり、ランタイム値は持ちません。UnifiedOptionsとUnifiedClientに移動します。 |
トップレベルモジュールはinit()をエクスポートしません。代わりにinitAll()を呼び出してください。
セットアップ
initAll
分析を初期化し、セッションリプレイ、機能実験、ガイドとサーベイを追加します。各ページロード時に、インスタンスごとに1回呼び出します。
initAll(apiKey: string, unifiedOptions?: UnifiedOptions): Promise<void>
| パラメータ | タイプ | 概要 |
|---|---|---|
apiKey | string | AmplitudeプロジェクトのAPIキー。 |
unifiedOptions | UnifiedOptions | オプションです。UnifiedOptionsに移動します。 |
initAll()は、AmplitudeReturnではなくプレーンなPromiseを返します。そのため、直接awaitしてください。すべてのプロダクトのセットアップが完了した後に解決されます。解決される前に行われた呼び出しは、キューで待機し、その後順番に実行されます。
以前の呼び出しがまだ保留中の状態で行われたinitAll()呼び出しでは、同じ promise が返されます。 前の呼び出しが解決された後に行われた呼び出しでは、完全なセットアップが再度実行されます。initAll()repeat呼び出しは、分析を再度初期化し、ページビュー追跡が有効になっている場合に別のページビューを追跡し、セッションリプレイを再起動します。また、Plugin with name @amplitude/unified-library-plugin already exists, skipping registrationをログに記録します。
await amplitude.initAll("YOUR_API_KEY", {
serverZone: "EU",
sessionReplay: { sampleRate: 0.1 },
});
実験
Feature実験クライアント、またはinitAll()がそれを追加する前のundefinedを返します。
experiment(): IExperimentClient | undefined
クライアントは実験JavaScript SDKクライアントです。クライアントはinitAll()期間中にフラグを取得しません。fetch()をvariant()の前に呼び出します。
const experiment = amplitude.experiment();
await experiment?.fetch();
const variant = experiment?.variant("checkout-redesign");
sessionReplay
セッションリプレイクライアント、またはinitAll()がそれを追加する前のundefinedを返します。
sessionReplay(): AmplitudeSessionReplay | undefined
| メソッド | 概要 |
|---|---|
start(): AmplitudeReturn<void> | 録画を開始または再開します。 録画は引き続きサンプルレート、ターゲティング、オプトアウト、リモートキャプチャの設定を尊重します。 |
stop(): void | SDKを破棄することなく録画を一時停止します。 再開するにはstart()を呼び出します。 |
shutdown(): void | 録画を停止し、イベントリスナーを削除します。 |
flush(useRetry: boolean): Promise<void> | 記録済みのデータを今すぐアップロードします。 失敗したアップロードを再試行するには、trueを渡します。 |
getSessionReplayProperties(): { [key: string]: boolean | string | null } | セッションリプレイがセッションを記録している間は true{ "[Amplitude] Session Replay ID": "..." } を、そうでない場合は false{} を返します。 |
getSessionId(): string | number | undefined | セッションリプレイの記録に対して、セッションIDを返します。 |
setSessionId(sessionId: string | number, deviceId?: string): AmplitudeReturn<void> | セッションリプレイが記録の対象とするセッションIDを設定します。 |
init, evaluateTargetingAndCapture | プラグインはセットアップ期間中にこれらを呼び出します。直接呼び出さないでください。 |
const replay = amplitude.sessionReplay();
replay?.stop();
録画オプションについては、セッションリプレイプラグインを参照してください。
createInstance
独自の分析設定、ID、キュー、プラグインを使用して独立したインスタンスを作成します。
createInstance(): UnifiedClient
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を参照してください。 |
experiment | 実験を参照してください。 |
sessionReplay | sessionReplayを参照してください。 |
init | Browser SDK 2 init()と同様に、分析のみを初期化します。トップレベルのエクスポートではなく、インスタンス(createInstance()以降)で利用可能です。 |
統合オプション
initAll()に渡すオプションオブジェクト。すべてのオプションはオプションです。
共有オプション
initAll()はこれらのオプションをすべてのプロダクトに渡し、各プロダクトブロックの同じ名前のオプションにマージします。設定されていない共有オプションは、同じ名前のプロダクトオプションをundefinedで上書きします。
| オプション | タイプ | デフォルト | 概要 |
|---|---|---|---|
serverZone | "US"または"EU" | "US" | すべてのプロダクトのためのデータセンター。analytics ではなく、ここに設定します。 |
instanceName | string | "$default_instance" | すべてのプロダクトのインスタンス名。 createInstance()からの各インスタンスには、異なる名前を使用してください。 |
プロダクトオプション
| オプション | タイプ | デフォルト | 概要 |
|---|---|---|---|
analytics | BrowserOptions | {} | Browser SDK 2のオプション。 設定オプションに移動します。 |
sessionReplay | SessionReplayOptions、共有オプションなしで | {} | セッションリプレイプラグインのオプション。sampleRateデフォルトは0です。これは何も記録しません。セッションリプレイプラグインに移動します。 |
experiment | ExperimentPluginConfig、共有オプションなしで | {} | 実験 JavaScript SDKのオプション、プラスdeploymentKey。実験オプションに移動します。 |
engagement | ガイドとサーベイInitOptions(共有オプションなし) | {} | ガイドとサーベイのオプション、プラスskip。エンゲージメントオプションに移動します。 |
実験オプション
| オプション | タイプ | デフォルト | 概要 |
|---|---|---|---|
deploymentKey | string | プロジェクトのAPIキー | 実験クライアントのデプロイメントキー。 |
| その他のオプション | 状況によって異なります | 状況によって異なります | すべての実験JavaScript SDKのオプション。バージョン1.1.43には、ベータリリースである@amplitude/plugin-experiment-browser1.0.0-beta.51が含まれています。 |
エンゲージメントオプション
| オプション | タイプ | デフォルト | 概要 |
|---|---|---|---|
skip | boolean | false | trueの場合、ガイドとサーベイは何もダウンロードせず、リクエストも送信せず、ストレージへの書き込みも行いません。@amplitude/unified1.1.11以降が必要です。 |
| その他のオプション | 状況によって異なります | 状況によって異なります | すべてのガイドとサーベイのオプション。 |
これは役に立ちましたか?
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.