Real-Time Segments for Feature Experimentation segment qualification methods for the JavaScript (Browser) SDK
Use the Real-Time Segments for Feature Experimentation segment methods to fetch external audience mapping for the user. You can fetch user segments with the user identifier of the user context.
Prerequisites
You must enable and configure Real-Time Segments for Feature Experimentation before fetching qualified segments and checking if the user is qualified for the given audience segment.
fetchQualifiedSegments
Minimum SDK Version
5.0.0
Description
Fetches all qualified segments for the user context.
fetchQualifiedSegments
is a method of the UserContext
object. See OptimizelyUserContext for details.
Parameters
The following table describes the parameters for the fetchQualifiedSegments
method:
Parameter | Type | Description |
---|---|---|
options (optional) | OptimizelySegmentOption[] | A set of options for fetching qualified segments from ODP. |
Returns
This method returns a Promise<bool>
, which will resolve with true
if segments are fetched successfully, and false
otherwise.
Note
You can read and write directly to the qualified segments array. This lets bypass the remote fetching process from ODP or utilize your own fetching service. This can be helpful when testing or debugging.
Example fetchQualifiedSegments
The following is an example of calling the fetchQualifiedSegments method and accessing the returned completion object:
const attributes = { "app_version": "1.3.2" };
const user = optimizely.createUserContext("user123", attributes);
const asyncFunction = async () => {
const fetched = await user.fetchQualifiedSegments()
Ā console.log(fetched) // true
Ā console.log(user.qualifiedSegments) // Updated qualified segments for target user
}
After the segments are fetched, they are cached. This means that if the same user is requesting the segments again (when new user contexts are created), the audience segment information can be retrieved from the cache instead of being fetched again from the remote ODP server.
The cache is used for the fetchQualifiedSegments
call. This method is called on the user context (the user context is fixed, including the real-time segments the user qualifies for).
The cache only applies when calling the fetchQualifiedSegments
call. If you set the cache timeout to 0, the cache is disabled. Optimizely uses the LRU algorithm, so the oldest record is bumped out when the maximum size is reached. If there is a cache miss upon the method call, Optimizely makes a network request.
If you would like to bypass caching, you can add the following options to your options
array:
OptimizelySegmentOption.IGNORE_CACHE
ā Bypass segments cache for lookup and save.OptimizelySegmentOption.RESET_CACHE
ā Reset all segments cache.
fetchQualifiedSegments network diagram
The following diagram shows the network calls between your application, the JavaScript (Browser) SDK, and the ODP server when calling fetchQualifiedSegments
:
- Call the
fetchQualifiedSegments
method. - JavaScript (Browser) SDK makes a GraphQL call to ODP to fetch segments.
- ODP responds with segments.
- Fetched segments mapping user IDs to segments are cached.
- Appropriate variations are returned for the user.
isQualifiedFor
Version
5.0.0
Description
Check if the user is qualified for the given segment.
Parameters
The following table describes the parameters for the isQualifiedFor
method:
Parameter | Type | Description |
---|---|---|
segment | String | The ODP audience segment name to check if the user is qualified for |
Returns
true
if the user is qualified.
Examples
The following is an example of whether or not the user is qualified for an ODP segment:
const attributes = { "laptop_os": "mac" };
const user = optimizely.createUserContext("user123", attributes);
const isQualified = user.isQualifiedFor('segment1');
console.log(isQualified); // true
Source files
The language and platform source files containing the implementation for the JavaScript (Browser) SDK are available on Github.
Updated 7 months ago