Browser Unified SDKの利用を開始する

npmv1.2.3121.0 kB gzip
For web developers10分Beginner

このガイドでは、Browser Unified SDK(@amplitude/unified)をインストールし、そのSDKに含まれるすべてのプロダクトを1回の呼び出しで初期化し、Amplitudeに1つのカスタムイベントを送信する方法について説明します。完全なオプションリストについては、UnifiedOptionsを参照してください。バージョン間の変更点については、@amplitude/unifiedchangelogを参照してください。

Unified SDKでは、Browser SDK 2 (@amplitude/analytics-browser)をセッションリプレイ、実験、ガイドとサーベイとバンドルしています。すべての分析のメソッドとオプションは、Browser SDK 2と同じように機能します。分析のみが必要な場合は、Browser SDK 2をインストールしてください。同じページに両方のパッケージをインストールしないでください。 npm、Unified Script、およびGoogle Tag Managerを比較するには、「ブラウザのインストールを選択する」を参照してください。

前提条件

  • AmplitudeプロジェクトとそのAPIキー。 キーを見つけるには、_設定 > プロジェクト_に移動し、プロジェクトを選択して「一般」を開きます。
  • 組織が使用しているデータセンター:米国(デフォルト)またはEU。
  • webpack、Vite、esbuildなどのJavaScriptバンドラ。 Unified SDKはnpmからのみインストールされます。 スクリプトタグの場合は、Unified Scriptを使用します。
  • ページはhttp://またはhttps://を使用して提供されます。file://から開かれたページはクッキーを設定できないため、SDKはロードの間でIDを永続化することはできません。

SDKをインストールする

bash
npm install @amplitude/unified

次に、パッケージをインポートします:

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

インストールに関する問題を修正

SDKの初期化

initAll()できるだけ早く、一度呼び出してください。この操作はまず分析を初期化し、次にセッションリプレイ、実験(機能)、ガイドとサーベイをプラグインとして追加します。SDKは、initAll()が完了する前にあなたが作成したすべての呼び出しをキューに格納し、完了後に実行します。

ts
amplitude.initAll("YOUR_API_KEY", {
  serverZone: "EU", // Omit for US projects.
  analytics: { autocapture: true },
  sessionReplay: { sampleRate: 1 }, // Records every session. Lower this before production.
});

最上位レベルでserverZoneを設定してください(analytics内ではありません)。initAll()は、トップレベルの値をすべてのプロダクトに渡し、トップレベルの値を未設定のままにした場合でも、プロダクトごとの値を上書きします。

セッションリプレイは、sessionReplay.sampleRateを0より上に設定するまで何も記録しません。

initAll() はユーザーID引数を受け入れません。その後にamplitude.setUserId()呼び出します。

初期化に関する問題を修正

クッキーや自動キャプチャの警告などの分析の初期化エラーについては、「ブラウザSDK 2の初期化問題を修正する」を参照してください。

最初のイベントを送信する

1つのカスタムイベントを追跡し、アップロード結果を待機します。track()は、アップロードの試行後にpromiseが解決されるオブジェクトを返します。

ts
const result = await amplitude.track("Sign Up Clicked", {
  plan: "starter",
}).promise;
console.log(result.code, result.message);
// 200 "Event tracked successfully"

アップロードに関する問題を修正

Unified SDKはバンドルされているBrowser SDK 2を通じてイベントをアップロードするため、結果コードはBrowser SDK 2と一致します。各エラーresult.codeおよびresult.messageステータスについては、「Browser SDK 2のアップロード問題の修正」を参照してください。

Amplitudeでイベントを確認する

  1. Amplitudeで、ユーザー検索を開き、amplitude.getDeviceId()デバイスIDを検索します。
  2. アクティビティタブを開き、ライブイベントの更新をオンにします。
  3. Sign Up Clicked が plan プロパティと一緒に表示されることを確認します。

イベントが1分以内に表示されない場合は、「イベントの確認」に従ってください。

次のステップ

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

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.

このページでは