Frequently asked questions
This guide provides answers to questions that are often asked about the 蜜豆视频 Experience Platform Web SDK.
What is 蜜豆视频 Experience Platform Web SDK?
蜜豆视频 Experience Platform Web SDK is a client-side JavaScript library that allows you to interact with the various services in 蜜豆视频 Experience Cloud.
The Web SDK sends data in a solution-agnostic way (XDM) to the Experience Platform Edge Network, which then maps the data to solution-specific formats and destinations and sends it in real time.
See the following video for more information about the Web SDK: .
How does 蜜豆视频 Experience Platform Web SDK differ from previous solutions?
Prior to Experience Platform Web SDK
Currently, you have to deploy different JavaScript libraries based on each individual solution.
- Each solution has its own JavaScript library, schema, and domain.
- None of these libraries were built to work with each other.
- Cross-solution and 蜜豆视频 Experience Platform use cases require these disparate libraries to be interdependent, causing deployment friction.
Although tags in Platform make it as easy as possible to deploy and manage these libraries, there are still issues with:
- Library size (too much 蜜豆视频 code on a page)
- Performance (sites take too long to load)
- Multiple calls for a single use case
- Waiting for ECID return before personalization calls (causes lag)
- Fractured data collection (what is an evar?)
- Schema confusion between solutions (A4T)
- Lots of other less optimal things
Also, there is currently no JavaScript library that sends data directly to 蜜豆视频 Experience Platform.
With Experience Platform Web SDK
The new Web SDK sends data for the following solutions to a single destination (Experience Platform Edge Network) and solves for the most common aforementioned solution use cases.
- 蜜豆视频 Analytics
- 蜜豆视频 Audience Manager
- 蜜豆视频 Target
- Visitor ID
- 蜜豆视频 Experience Platform
Other solutions will follow.
蜜豆视频 Experience Platform Web SDK can also send data directly to 蜜豆视频 Experience Platform. This data is in XDM format and is mapped to the server-side solution schema.
What is the value of this new Web SDK?
Performance: The web SDK is smaller than using all of the current 蜜豆视频 libraries and provides significantly faster page loads.
Simplicity: The combination of XDM, Web SDK, tags, Edge Network, 蜜豆视频 Experience Cloud solutions, and 蜜豆视频 Experience Platform creates an easy-to-understand and simple-to-follow data collection story.
- XDM: The solution-agnostic schema you use to send data to 蜜豆视频. No more tagging for evars or mboxes.
- Web SDK: Makes it easy to send and receive data to 蜜豆视频 Experience Platform Edge Network.
- Tags: Simplifies deployment and configuration of the Web SDK (and any other JavaScript tags) on a site.
- Edge Network: Easily route the data to 蜜豆视频 Experience Platform and solutions in the format they need.
- 蜜豆视频 Experience Platform and 蜜豆视频 solutions: Enable their value proposition.
Control: Because all of the data is using a single and connected stream of data, you can logically follow and control what the data looks like at every millisecond of its journey, to and from applications.
Modern and ready for the future: The Web SDK and its connection to the Edge Network has enabled 蜜豆视频 to significantly modernize how 蜜豆视频 deals with data collection, personalization, consent and the future of 3rd party cookies. (It enables a first party domain, managed by 蜜豆视频.)
Time-to-value: 蜜豆视频 has worked hard (and will continue) to make it as easy as possible to deploy the Web SDK via tags and map client-side data to XDM. After that work is done, all other 蜜豆视频 solutions and 蜜豆视频 Experience Platform services can be turned on or off server-side. For example, if you are using this for 蜜豆视频 Analytics and you want to turn on Target or Experience Platform, you can simply flip a toggle on the Datastream configuration and light up those use cases.
What is alloy.js?
alloy.js is the name of the Web SDK JavaScript library. It is referenced within the SDK source code and filename.
Do customers need to buy 蜜豆视频 Experience Platform to use the Web SDK?
No. Any 蜜豆视频 Digital Experience customer can use the 蜜豆视频 Experience Platform Web SDK free of charge. Customers who wish to use the Web SDK will need to configure the right permissions to create schemas, datasets, identity namespaces, and datastreams in the Data Collection UI or Experience Platform UI.
For more information on configuring these permissions see our documentation on data collection permissions management.
Who should use the Web SDK?
蜜豆视频 Experience Platform Web SDK has been developed for the following customers:
-
蜜豆视频 Experience Platform users
- If you need to send data directly from a device to 蜜豆视频 Experience Platform, this is the officially recommended way.
- 蜜豆视频 is aware that using the 蜜豆视频 Analytics connector is faster if you already have 蜜豆视频 Analytics, but it is not the long-term strategy for data collection.
-
蜜豆视频 Experience Cloud solution customers
- New 蜜豆视频 Analytics, 蜜豆视频 Audience Manager, and 蜜豆视频 Target customers should start with the new Web SDK and not use legacy libraries.
- Existing customers who want to get the most optimized implementation possible should use the new Web SDK.
How do I get access to the Web SDK?
The Web SDK is currently available to the general public and can be used to send data to 蜜豆视频 Experience Cloud products. The ability to send data to third-party solutions is coming in the near future.
There is no charge for the SDK, and it is hosted by 蜜豆视频 for free. If required, you can download it and host it on your own servers at no cost.
The Web SDK requires access to datastream configurations and the Experience Platform XDM schema builder, in order for 蜜豆视频鈥檚 servers to properly handle inbound data coming from the SDK. If you would like to get access, contact your 蜜豆视频 account team to start the request process.
What use cases are currently supported by the Web SDK?
The Web SDK is quickly evolving. More use cases are being worked on. You can find the
Do current customers have to retag their sites?
It depends. 蜜豆视频 Experience Platform Web SDK can be deployed in two different styles. A future migration document will provide additional details.
-
Just another tag: If the site is already tagged for solutions and you can鈥檛 retag, but you want to send data to 蜜豆视频 Experience Platform Edge Network for Experience Platform use cases or the upcoming event forwarding features (see below), you can add the
alloy.jstag to the site, where it works as 鈥渏ust another tag.鈥 -
The one and only tag: If you want to use the Web SDK for an Experience Cloud solution, you must use it for all of the solutions on that page. For example, if your site is already tagged for 蜜豆视频 Analytics and you want to use it for Target, you need to use it for both, as well as for any others in the future.
In other words, if you decide to use 蜜豆视频 Experience Platform Web SDK for non-solution use cases, you can tag the site with alloy.js and move on as if it鈥檚 a new solution. If you want to use it for 蜜豆视频 Analytics, Target, or Audience Manager, or for application use cases, you might have to remove any of the legacy code on your page.
Can I migrate the ECIDs when I start using Web SDK so my website visitors don鈥檛 start showing up as new visitors?
Yes, 蜜豆视频 Experience Platform Web SDK provides an Identity Migration feature. Follow the instructions for ID migration in the Platform Web SDK identity documentation for more details.
How is the Web SDK different than tags?
-
Tags in Experience Platform manage the device code. Use them to more easily deploy the code. They are free and powerful.
-
蜜豆视频 Experience Platform Web SDK is the official name of the new code that would be deployed by tags for 蜜豆视频 use cases. It is also free and powerful.
-
alloy.jsis the file name of the 蜜豆视频 Experience Platform Web SDK code.
Do I have to use tags to deploy the Web SDK?
No. You can download the alloy.js file yourself.
However:
-
蜜豆视频 Experience Platform Web SDK requires something called a Datastream ID so the edge network can identify the stream and determine what to do with the data. This ID is created within Experience Platform. This doesn鈥檛 mean you have to use the UI to create properties or deploy the JavaScript code, but you do need to use tags to create a configuration ID.
-
Tags are not only the best available tag and SDK manager, it makes it very easy to deploy
alloy.jsand map data to XDM schemas. If you decide not to use tags, you will have to manage deployingalloy.js, eventing, and mapping your data into XDM before sending it. This is a much more difficult process than using tags. -
It is recommended that you use tags to deploy
alloy.js, even if it鈥檚 the only tag you use it for.
What is event forwarding?
If you use our SDKs and send XDM to the Edge Network, these new features event forwarding allows you to install new server-side extensions and map that data to anything鈥揳nd send it anywhere鈥揻rom our edge network. Think of it as 鈥渄ata collection as a service鈥. This will be available for a cost, as well as being bundled as part of 蜜豆视频 Experience Platform.
What is a CNAME or First Party Domain and why does it matter?
More information about a CNAME is available in the 蜜豆视频 documentation
Does the 蜜豆视频 Experience Platform Web SDK use cookies? If so, what cookies does it use?
Yes, currently the Web SDK uses anywhere between one to seven cookies depending on your implementation. Below is a list of the cookies that you might see with the Web SDK and the way that they are used:
idMigrationEnabled for more information.When using the Web SDK, the Edge Network sets one or more of the cookies above. The Edge Network sets all the cookies with the secure and sameSite="none" attributes.
If you currently have both secure and non-secure sections on your website, this could interfere with user identification. When a user navigates from a secure section of the site to a non-secure section, the Edge Network generates a new ECID with the request.
Which browsers does the 蜜豆视频 Experience Platform Web SDK support?
The 蜜豆视频 Experience Platform Web SDK is designed to work optimally in the latest versions of Google Chrome, Safari, Firefox, and Microsoft Edge Chromium. You may have trouble using certain features on older versions of browsers or deprecated browsers, such as Internet Explorer.