Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The selectURL()
method of the WindowSharedStorage
interface executes a URL Selection operation that is registered in a module added to the current origin's SharedStorageWorklet
.
Note: The URL Selection output gate is used to select a URL from a provided list to display to the user, based on shared storage data.
SyntaxselectURL(name, urls)
selectURL(name, urls, options)
Parameters
name
A string representing the registered operation's name within the shared storage worklet module. It must match the name given to the operation when it is registered with SharedStorageWorkletGlobalScope.register()
.
urls
An array of objects representing the URLs to be chosen between by the URL Selection operation. Each object contains two properties:
url
A string representing the URL.
reportingMetadata
Optional
An object containing properties where names are event types and values are URLs pointing to reporting destinations, for example "click" : "my-reports/report1.html"
. The URLs act as destinations for reports submitted with a destination of type "shared-storage-select-url"
, typically submitted via a Fence.reportEvent()
or Fence.setReportEventDataForAutomaticBeacons()
method call.
options
Optional
An options object, which can contain the following properties:
data
Optional
An object representing any data required for executing the operation.
keepAlive
Optional
A boolean value. If set to true
, the SharedStorageWorkletGlobalScope
of the associated worklet is kept alive, and the operation can be run again. Therefore, you need to set keepAlive
to true
for each operation that is not intended to be the last one. The default value, false
, means that the SharedStorageWorkletGlobalScope
is terminated after the operation is run and cannot be run again.
resolveToConfig
Optional
A boolean value. If set to true
, the fulfillment value of the Promise
returned by run()
will be a FencedFrameConfig
object that can be used to load content into a <fencedframe>
via its config
attribute. The default value, false
, means that the fulfillment value will be a URL that can be used to load content into an <iframe>
.
A Promise
that fulfills with a FencedFrameConfig
object or a string representing a URL, depending on the value of the resolveToConfig
option.
TypeError
Thrown if:
addModule()
.urls
is empty or exceeds the maximum allowed length (which is browser-specific).url
property contains an invalid URL.// Randomly assigns a user to a group 0 or 1
function getExperimentGroup() {
return Math.round(Math.random());
}
async function injectContent() {
// Add the module to the shared storage worklet
await window.sharedStorage.worklet.addModule("ab-testing-worklet.js");
// Assign user to a random group (0 or 1) and store it in shared storage
window.sharedStorage.set("ab-testing-group", getExperimentGroup(), {
ignoreIfPresent: true,
});
// Run the URL selection operation
const fencedFrameConfig = await window.sharedStorage.selectURL(
"ab-testing",
[
{ url: `https://your-server.example/content/default-content.html` },
{ url: `https://your-server.example/content/experiment-content-a.html` },
],
{
resolveToConfig: true,
},
);
// Render the chosen URL into a fenced frame
document.getElementById("content-slot").config = fencedFrameConfig;
}
injectContent();
See the Shared Storage API landing page for a walkthrough of this example and links to other examples.
Specifications Browser compatibility See alsoRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4