Implement Real-Time Audiences for Feature Experimentation for client-side SDKs

After creating an audience with Real-Time Audiences for Feature ExperimentationReal-Time Audiences for Feature Experimentation and assigning it to a flag ruleflag rule, you can integrate the audience segments in your client-side code.

If you are not familiar with targeted deliveries and experiments in Feature Experimentation, it is recommended you follow the QuickstartQuickstart guide for your specific SDK first before following this document.

The first step is to install and initialize the Feature Experimentation SDK in your application. When initializing the SDK, you must enable the Optimizely Data Platform (ODP) audiences and the ODPManager. See the Customize configurationCustomize configuration section for information on ODPManager customization options.

Android

Flutter

JavaScript – SDK versions 6.0.0 and later.

JavaScript (Browser) – SDK versions 5.3.5 and earlier.

React

React Native

Swift

To fetch the audience segments your user qualifies for, you can use OptimizelyUserContext.

If you have a userID, you can create an OptimizelyUserContext object as usual with your Feature Experimentation userID and additional attributes. The OptimizelyUserContext object lets you make flag decisions and track events for a user context.

To evaluate if your user would qualify in your audience, you can call fetchQualifiedSegments on the OptimizelyUserContext to fetch the ODP segments for the specific userID.

See your specific SDK's documentation on creating a user context for details and code samples.

For information on the Real-Time Audience methods, fetchQualifiedSegments and isQualifiedFor refer to the following documentation:

If you do not have a userID, you can still see if the anonymous user qualifies for an audience segment using OptimizelyUserContext.

You can select whether client-side SDKs automatically generate a VUID or device IDVUID or device ID if one cannot be found upon instantiation. If you enable it, the SDK sends a register event to ODP with the VUID automatically when the SDK is instantiated. This is helpful when sending decision data before the user is logged in, such as in anonymous segmentation.

To evaluate if your anonymous user would qualify for your audience, you can callOptimizelyUserContext with no userID to fetch the user's ODP segments. Refer to your specific SDK's documentation on creating user context for details and code samples:

You can use the standard Decide methodsDecide methods enriched with Real-Time Audiences for Feature Experimentation to return flag decisions for a user using a userID or VUID. The flag decision includes the status if the flag is enabled or disabled and the flag variation. When an ODP-type audience condition is required for the decision, the SDK can look up the ODP segments saved in the current user context. Refer to your specific SDK's documentation on calling these methods:

Android

Flutter

JavaScript – SDK versions 6.0.0 and later.

JavaScript (Browser) – SDK versions 5.3.5 and earlier.

React

React Native

Swift

You can call sendOdpEvent() on the OptimizelyClient for sending arbitrary event data to ODP. For example, stitching an email address identifier to the Feature Experimentation userID identifier. Refer to your SDK to learn more:

You must implement the ODPManager parameter when you initialize the SDK for the Real-Time Audiences integration to work. You can customize the ODPManager or override the entire ODPManager with a custom one. Each Feature Experimentation SDK implements its own way of supporting it. Refer to your desired SDK to learn more.