Migrate from Javascript SDK to Browser SDK 2.0

Amplitude Browser SDK 2.0 (@amplitude/analytics-browser@2+) features:

• Plugin architecture
• Built-in type definition
• Broader support for front-end frameworks
• Autocapture
• Improved marketing attribution tracking
• Identical interfaces across platform with other Amplitude SDKs

Browser SDK 2.0 isn't backwards compatible with amplitude-js.

To migrate to @amplitude/analytics-browser@2+, update your dependencies and instrumentation.

this.init('API_KEY', {
  deviceId: 'device_id',
  userId: 'user_id',
});

Terminology

• amplitude-js: Maintenance Browser SDK
• @amplitude/analytics-browser@2+: Browser SDK 2.0

Dependency

For snippet installation, update your project's snippet loader.

For Node projects, update your dependency list in package.json.

{
  "dependencies": {
    "amplitude-js": "^8"
  }
}

{
  "dependencies": {
    "@amplitude/analytics-browser": "^2.11.8"
  }
}

Instrumentation

Browser SDK 2.0 offers an API to instrument events. To migrate to the Browser SDK 2.0, update a few calls. The following sections detail which calls have changed.

Initialization

getInstance() has been removed. To initialize the SDK, call init(), with the same parameters. However, config comes in a different shape. See Configuration.

import amplitude from "amplitude-js"

amplitude.getInstance().init(API_KEY, OPTIONAL_USER_ID, config)

import * as amplitude from "@amplitude/analytics-browser"

amplitude.init(API_KEY, OPTIONAL_USER_ID, config)

Configuration

Tracking events

The maintenance Browser SDK offered a variety of logEvent APIs like logEventWithTimestamp, logEventWithGroups to override specific properties in the event payload. Instead of these, use the unified track API in @amplitude/analytics-browser@2+.

logEvent()

The logEvent() API maps to track().

const eventType = "Button Clicked"
const eventProperties = {
  type: "primary",
}
amplitude.getInstance().logEvent(
  eventType,
  eventProperties,
)

const eventType = "Button Clicked"
const eventProperties = {
  type: "primary",
}
amplitude.track(
  eventType,
  eventProperties,
)

logEventWithTimestamp()

The logEventWithTimestamp() API maps to track().

const eventType = "Button Clicked"
const eventProperties = {
  type: "primary",
}
const timestamp = Date.now()
amplitude.getInstance().logEventWithTimestamp(
  eventType,
  eventProperties,
  timestamp,
)

const eventType = "Button Clicked"
const eventProperties = {
  type: "primary",
}
const eventOptions = {
  time = Date.now()
}
amplitude.track(
  eventType,
  eventProperties,
  eventOptions
)

logEventWithGroups()

The logEventWithGroups() API maps to track().

const eventType = "Button Clicked"
const eventProperties = {
  type: "primary",
}
const groups = {
  orgId: "12345",
}
amplitude.getInstance().logEventWithGroups(
  eventType,
  eventProperties,
  groups,
)

const event_type = "Button Clicked"
const event_properties = {
  type: "primary",
}
const groups = {
  orgId: "12345",
}
const event = {
  event_type,
  event_properties,
  groups
}
amplitude.track(event)

sendEvents()

The sendEvents() API maps to flush().

amplitude.getInstance().sendEvents()

amplitude.flush()

Set user properties

The APIs for setting user properties are the same, except for the removal of getInstance(). Here are code snippets to migrate APIs for user properties.

setUserId()

Set a userId when you invoke amplitude without calling getInstance()

const userId = "1"
amplitude.getInstance().setUserId(userId)

const userId = "1"
amplitude.setUserId(userId)

setDeviceId()

Set a deviceId when you invoke amplitude without calling getInstance()

const deviceId = "1"
amplitude.getInstance().setDeviceId(deviceId)

const deviceId = "1"
amplitude.setDeviceId(deviceId)

setSessionId()

Set a sessionId when you invoke amplitude without calling getInstance()

const sessionId = Date.now()
amplitude.getInstance().setSessionId(sessionId)

const sessionId = Date.now()
amplitude.setSessionId(sessionId)

clearUserProperties()

The clearUserProperties API has been removed. Use the unified identify API to remove user properties.

amplitude.getInstance().clearUserProperties()

amplitude.identify(
  new amplitude.Identify().identify.clearAll()
)

setUserProperties()

The setUserProperties API has been removed. Use the unified identify API to add user properties.

amplitude.getInstance().setUserProperties({
  membership, "paid",
  payment, "bank",
})

const identify = new amplitude.Identify()
identify
  .set("membership", "paid")
  .set("payment", "bank")
amplitude.identify(identify)

identify()

Make an identify call on amplitude without calling getInstance().

const identify = new amplitude.Identify()
identify.set("membership", "paid")
amplitude.getInstance().identify(identify)

const identify = new amplitude.Identify()
identify.set("membership", "paid")
amplitude.identify(identify)

Set group properties

groupIdentify()

Make an identify call on amplitude without calling getInstance().

const identify = new amplitude.Identify()
identify.set("membership", "paid")
amplitude.getInstance().groupIdentify(identify)

const identify = new amplitude.Identify()
identify.set("membership", "paid")
amplitude.groupIdentify(identify)

Track revenue

logRevenueV2()

Track revenue using revenue() API on amplitude without calling getInstance().

const revenue = new amplitude.Revenue()
revenue
  .setProductId("productId")
  .setPrice(10)
amplitude.getInstance().logRevenueV2(revenue)

const revenue = new amplitude.Revenue()
revenue
  .setProductId("productId")
  .setPrice(10)
amplitude.revenue(revenue)

Patterns

Plugins

The configs config.language, config.library, config.platform were available in amplitude-js to allow modification of event payloads for these specific fields. Although @amplitude/analytics-browser@2+ doesn't support these configurations, you can add plugins to the new Browser SDK to enrich event payloads.

import { BrowserConfig, EnrichmentPlugin, Event, PluginType } from "@amplitude/analytics-types"

export class LibraryModifierPlugin implements EnrichmentPlugin {
  name = 'library-modifier'
  type = PluginType.ENRICHMENT as const

  /**
  * setup() is called on plugin installation
  * example: client.add(new LibraryModifierPlugin());
  */
  setup(config: BrowserConfig): Promise<undefined> {
    this.config = config
  }

  /**
  * execute() is called on each event instrumented
  * example: client.track('New Event');
  */
  execute(event: Event): Promise<Event> {
    event.library = 'my-library-name/1.0.0'
    return Promise.resolve(event)
  }
}

To install your custom plugin, use add() with your custom plugin as a parameter.

import * as amplitude from '@amplitude/analytics-browser'

amplitude.add(new LibraryModifierPlugin())
amplitude.init(API_KEY, OPTIONAL_USER_ID)

Defer initialization

To defer initialization in amplitude-js, call init with config.deferInitialization set to true, and eventually call enableTracking() to formalize initialization and send all enqueued events.

amplitude.getInstance().init(API_KEY, OPTIONAL_USER_ID, {
  deferInitialization: true,
})

amplitude.getInstance().logEvent("Event 1")
amplitude.getInstance().logEvent("Event 2")
amplitude.getInstance().logEvent("Event 3")

amplitude.getInstance().enableTracking()

amplitude.track("Event 1")
amplitude.track("Event 2")
amplitude.track("Event 3")

amplitude.init(API_KEY, OPTIONAL_USER_ID)

Web attribution

In amplitude-js, enable web attribution through the following configurations:

• config.includeGclid
• config.includeFbclid
• config.includeReferrer
• config.includeUtm

In @amplitude/analytics-browser@2+, the single configuration config.autocapture.attribution controls the web attribution. This configuration's default setting is true, and it captures all campaign parameters. These are the same campaign parameters supported in amplitude-js.

Flush or onExitPage

Sometimes you should send events immediately, like when a user navigates away from a page. This is common when tracking button clicks that direct the user to another page while sending event payload in batches.

In amplitude-js do this by using onExitPage() callback.

amplitude.getInstance().init(API_KEY, OPTIONAL_USER_ID, {
  onExitPage: () => {
    amplitude.sendEvents()
  },
})

window.addEventListener('pagehide', () => {
  // Set https transport to use sendBeacon API
  amplitude.setTransport('beacon')
  // Send all pending events to server
  amplitude.flush()
});

Callback

amplitude-js passes one init callback function for executing any function after initialization and two separate callback functions for success and error network requests. With @amplitude/analytics-browser@2+ supporting promises (and async/await), the asynchronous methods like init(), track(), identify(), groupIdentify() return a custom promise interface.

const initResult = await amplitude.init("YOUR_API_KEY").promise
if (initResult.code === 200) {
  // success logic
} else {
  // error logic
}

const result = await amplitude.track("Button Clicked").promise
if (result.code === 200) {
  // success logic
} else {
  // error logic
}