Browser SDK 2を使用開始する

npmv2.49.366.1 kB gzip
For web developers10分Beginner

このガイドでは、Browser SDK 2(@amplitude/analytics-browser)をインストールし、初期化し、Amplitudeに1つのカスタムイベントを送信する方法について説明します。 各ステップで問題を引き起こす一般的なブラウザ条件がリストされているため、問題が発生した時点で修正できます。完全なオプションリストについては、設定オプションを参照してください。

Browser SDK 2は、アナリティクス専用パッケージです。 セッションリプレイ、機能実験、またはガイドとサーベイも必要な場合は、代わりにBrowser Unified SDK(@amplitude/unified)をインストールしてください。 このパッケージにはBrowser SDK 2が含まれているため、両方のパッケージを同じページにインストールしないでください。

前提条件

  • AmplitudeプロジェクトとそのAPIキー。 設定 > プロジェクト > _一般_でキーを見つけます。
  • 組織が使用しているデータセンター:米国(デフォルト)またはEU。
  • 最新のBrowser SDK 2リリース、または使用している機能のBrowser SDK 2リリースノートと比較して確認したピン留めバージョン。
  • http://またはhttps://を使用して提供されるページ。file://から開かれたページはクッキーを設定できないため、SDKはロード間隔でIDを永続化することはできません。

SDKをインストールする

インストール方法を1つ選択します。 JavaScriptをバンドルしている場合は、npmまたはyarnを使用してください。直接、またはタグマネージャー経由でHTMLにタグを追加する場合は、スクリプトローダーを使用します。

bash
npm install @amplitude/analytics-browser
ts
import * as amplitude from "@amplitude/analytics-browser";

代わりにUnified SDKを使用するには、@amplitude/unifiedまたはnpm install @amplitude/unifiedを使用してyarn add @amplitude/unifiedインストールし、同じ方法でインポートします:

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

Unifiedパッケージは、同様のトラッキングtrack()および ID メソッドsetUserId()をエクスポートしますが、一部はエクスポートしませんinit()。代わりにanalyticsメソッドinitAll()を呼び出し、このガイドの分析オプションを以下の通り渡します:

ts
amplitude.initAll("YOUR_API_KEY", {
  serverZone: "EU", // Omit for US projects.
  analytics: { autocapture: true },
});

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

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

SDKの初期化

既知のユーザーIDなど、アプリに必要なコンテキストが用意され次第、なるべく早くinit()一度だけ呼び出します。完了前にinit()行った呼び出しは、キューで待機し、完了後に順番に実行されます。

ts
amplitude.init("YOUR_API_KEY", {
  autocapture: true,
});

すでに知っている場合は、ユーザーIDを2番目の引数として渡します。

ts
amplitude.init("YOUR_API_KEY", "user-12345", {
  autocapture: true,
});

プロジェクトでEUデータセンターを使用している場合は、以下serverZoneを設定します:

ts
amplitude.init("YOUR_API_KEY", {
  serverZone: "EU",
  autocapture: true,
});

autocapture: trueは、SDKがブール値を使用して有効にするすべての自動キャプチャ機能をオンにします。これには、要素のクリック、フラストレーションのインタラクション、失敗したネットワークリクエスト、Web Vitalsなどが含まれます。デフォルトのセット(ページビュー、セッション、アトリビューション、フォーム、ファイルのダウンロード)のみから始めるには、autocaptureを省略するか、オブジェクトを渡します。選択肢については、自動キャプチャを参照してください。

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

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

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

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

SDKは、最初のイベントがキューに入ってから約1秒後に、最大30個のイベントをまとめてリクエストとしてアップロードします。そのアップロード後にはpromise解決されるため、約1秒の遅延が予想されます。

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

Amplitudeでイベントを確認する

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

イベントが1分以内に表示されない場合は、Verify eventsに従ってください。このプロセスは、track()とAmplitudeのサーバー間の各段階を経由します。

次のステップ

  • setUserId()を使用して、サインイン済みのユーザーを識別し、サインアウトしたらreset()を呼び出します。
  • 保持するAutocaptureイベントを選択します。
  • トラッキングプランに必要なカスタムイベントとプロパティを追加します。イベントの追跡に移動します。

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

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.

このページでは