\n\n# Announcement 📣\n\nThe [Marketing Analytics Browser SDK](https://www.docs.developers.amplitude.com/data/sdks/marketing-analytics-browser/) is currently in maintenance mode. Amplitude has introduced the [Browser SDK 2.0](https://www.docs.developers.amplitude.com/data/sdks/browser-2/) as its replacement. This SDK offers improved marketing attribution tracking, a simplified interface, and a more lightweight package.\n\nTo learn more about the Browser 2.0 SDK, here are some useful links:\n\n* NPM: https://www.npmjs.com/package/@amplitude/analytics-browser\n* GitHub: https://github.com/amplitude/Amplitude-TypeScript\n* Documentation: https://www.docs.developers.amplitude.com/data/sdks/browser-2/\n\nPlease check what has been improved and the detailed migration guide at the [here](https://www.docs.developers.amplitude.com/data/sdks/marketing-analytics-browser/migration).\n\n# @amplitude/marketing-analytics-browser\n\nOfficial Amplitude SDK for Web and Marketing Analytics\n\n# Doc\n\nSee our [Typescript Analytics Browser SDK](https://amplitude.github.io/Amplitude-TypeScript/modules/_amplitude_marketing_analytics_browser.html) Reference for a list and description of all available SDK methods.\n\n# Installation and Quick Start\n\nPlease visit our :100:[Developer Center](https://www.docs.developers.amplitude.com/data/sdks/marketing-analytics-browser/) for instructions on installing and using our the SDK.\n\n## Installation\n\nTo get started with using Amplitude Marketing Analytics Browser SDK, install the package to your project via NPM or script loader.\n\n### Using Node package\n\nThis package is published on NPM registry and is available to be installed using npm and yarn.\n\n```sh\n# npm\nnpm install @amplitude/marketing-analytics-browser@^1.0.0\n\n# yarn\nyarn add @amplitude/marketing-analytics-browser@^1.0.0\n```\n\n### Using script loader\n\nAlternatively, the package is also distributed through a CDN. Copy and paste the script below to your html file.\n\n\n```html\n\n```\n\n\n## Usage\n\n### Initializing SDK\n\nInitialization is necessary before any instrumentation is done. The API key for your Amplitude project is required.\n\n```typescript\namplitude.init(API_KEY);\n\n// Config web attribution and auto page view tracking\namplitude.init(API_KEY, USER_ID, {\n // Config web attribution\n attribution: {\n resetSessionOnNewCampaign: true;\n },\n\n // Enable auto page view tracking\n pageViewTracking: {\n trackOn: 'attribution',\n }\n});\n```\n\n### Tracking an Event\n\nEvents represent how users interact with your application. For example, \"Button Clicked\" may be an action you want to note.\n\n```typescript\nimport { track } from '@amplitude/marketing-analytics-browser';\n\n// Track a basic event\ntrack('Button Clicked');\n\n// Track events with additional properties\nconst eventProperties = {\n selectedColors: ['red', 'blue'],\n};\ntrack('Button Clicked', eventProperties);\n```\n\n### User Properties\n\nUser properties help you understand your users at the time they performed some action within your app such as their device details, their preferences, or language.\n\n```typescript\nimport { Identify, identify } from '@amplitude/marketing-analytics-browser';\n\nconst event = new Identify();\n\n// sets the value of a user property\nevent.set('key1', 'value1');\n\n// sets the value of a user property only once\nevent.setOnce('key1', 'value1');\n\n// increments a user property by some numerical value.\nevent.add('value1', 10);\n\n// pre inserts a value or values to a user property\nevent.preInsert('ab-tests', 'new-user-test');\n\n// post inserts a value or values to a user property\nevent.postInsert('ab-tests', 'new-user-test');\n\n// removes a value or values to a user property\nevent.remove('ab-tests', 'new-user-test')\n\n// sends identify event\nidentify(event);\n```\n\n### prepend/append\n\n* append will append a value or values to a user property array.\n* prepend will prepend a value or values to a user property.\n\n### User Groups\n\n```typescript\nimport { setGroup } from '@amplitude/marketing-analytics-browser';\n\n// set group with single group name\nsetGroup('orgId', '15');\n\n// set group with multiple group names\nsetGroup('sport', ['soccer', 'tennis']);\n```\n\n### Group Identify\n\nThis feature is only available to Growth and Enterprise customers who have purchased the [Accounts add-on](https://amplitude.zendesk.com/hc/en-us/articles/115001765532).\n\nUse the Group Identify API to set or update properties of particular groups. However, these updates will only affect events going forward.\n\n```typescript\nimport { Identify, groupIdentify } from '@amplitude/marketing-analytics-browser';\n\nconst groupType = 'plan';\nconst groupName = 'enterprise';\nconst event = new Identify()\nevent.set('key1', 'value1');\n\ngroupIdentify(groupType, groupName, identify);\n```\n\n### Track Revenue\n\nRevenue instances will store each revenue transaction and allow you to define several special revenue properties (such as 'revenueType', 'productIdentifier', etc.) that are used in Amplitude's Event Segmentation and Revenue LTV charts. These Revenue instance objects are then passed into `revenue` to send as revenue events to Amplitude. This allows us to automatically display data relevant to revenue in the platform. You can use this to track both in-app and non-in-app purchases.\n\n```typescript\nimport { Revenue, revenue } from '@amplitude/marketing-analytics-browser';\n\nconst event = new Revenue()\n .setProductId('com.company.productId')\n .setPrice(3.99)\n .setQuantity(3);\n\nrevenue(event);\n```\n\n### Callback\n\nAll asynchronous API are optionally awaitable through a specific Promise interface. This also serves as callback interface.\n\n```typescript\n// Using async/await\nconst results = await track('Button Clicked').promise;\nresult.event; // {...} (The final event object sent to Amplitude)\nresult.code; // 200 (The HTTP response status code of the request.\nresult.message; // \"Event tracked successfully\" (The response message)\n\n// Using promises\ntrack('Button Clicked').promise.then((result) => {\n result.event; // {...} (The final event object sent to Amplitude)\n result.code; // 200 (The HTTP response status code of the request.\n result.message; // \"Event tracked successfully\" (The response message)\n});\n```\n\n### User Log out\n\nThis updates user ID and device ID. After calling `reset()` the succeeding events now belong to a new user identity.\n\n```typescript\nimport { reset } from '@amplitude/marketing-analytics-browser';\n\nreset();\n```\n","readmeFilename":"README.md"}
![](\"https://static.amplitude.com/lightning/46c85bfd91905de8047f1ee65c7c93d6fa9ee6ea/static/media/amplitude-logo-with-text.4fb9e463.svg\"){kind=logo}
\n \n