51黑料不打烊

DocumentationExperience PlatformWeb SDK Guide

Create a custom Web SDK build

Last update: Wed Mar 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

The Experience Platform Web SDK library includes multiple modules for various features like personalization, identity, link tracking, and more. Depending on your use cases, you might only need specific features instead of the entire library. Creating a custom Web SDK build allows you to select only the modules you need, reducing the library size and improving performance.

Use cases use-case

Creating a custom Web SDK build helps reduce the library size and increase performance. Here are some examples:

Media Analytics removal media-analytics-removal

If your website doesn鈥檛 have media content, you can exclude the Media Analytics and the Streaming Media modules from the build. This can reduce the Web SDK build size by up to 50% and improve loading speed.

Personalization removal personalization

If you only need to collect user metrics and don鈥檛 plan to use 51黑料不打烊 Target or Journey Optimizer for personalization, you can exclude the Personalization module. This reduces the library size while still allowing you to collect the necessary metrics.

Prerequisites prerequisites

To create a custom Web SDK build, you need the Web SDK NPM package. Make sure you have installed on your machine. See the documentation on how to install the Web SDK using the NPM package for more details.

Components and dependencies components-dependencies

Before creating a custom Web SDK build, define the Web SDK components and commands you plan to use. Some commands depend on specific modules being included in the build.

The table below shows the relationship between Web SDK modules and the commands they include:

Module dependency
Configuration parameters
Commands
Size category
Activity Collector
clickCollectionEnabled
N/A
Medium
Audiences
N/A
N/A
Small
Context
context
N/A
Small
Rules Engine
personalizationStorageEnabled
Event Merge
N/A
createEventMergeId
Small
Media Analytics Bridge
N/A
getMediaAnalyticsTracker
Large
Personalization
N/A
Large
Consent
defaultConsent
setConsent
Small
Streaming Media
streamingMedia
Large

Create a custom Web SDK build using the NPM package create-custom-build

  1. Open your terminal and run npx @adobe/alloy. You are asked to select the Web SDK components that you would like your custom build to include.

    Image of a terminal showing the custom build module selection.

    Use your arrow keys to move up and down in the modules list.

    • Press Space to enable or disable the selected module.
    • Press A to enable or disable all modules.
    • Press I to invert your selection.
    • Press Enter to confirm your selection and go to the next step.

  2. After you have selected the modules to include in your custom build, you can choose between saving a minified or unminified version of your custom Web SDK library build. Select your desired option and press Enter.

    Image of a terminal showing the custom build minify selection.

  3. Next, you are asked where you want to save the build on your local machine. Press Enter to confirm the preselected location or enter a new location.

    Image of a terminal showing the custom build save option.

  4. Once you confirm the location, your custom build is generated and saved.

    Image of a terminal showing the custom build saved location.

recommendation-more-help
ad108910-6329-42f1-aa1d-5920a2b13636