The Full Stack Developer Guide Developer Hub

Welcome to the Full Stack Developer Guide developer hub. You'll find comprehensive guides and documentation to help you start working with the Full Stack Developer Guide as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Set Forced Variation

Forces a user into a variation for a given experiment for the lifetime of the Optimizely client.

The purpose of this method is to force a user into a specific variation or personalized experience for a given experiment. The forced variation value doesn't persist across application launches.

Version

SDK v3.0, v3.1

Description

Forces a user into a variation for a given experiment for the lifetime of the Optimizely client. Any future calls to Activate, Is Feature Enabled, Get Feature Variable, and Track for the given user ID returns the forced variation.

Forced bucketing variations take precedence over whitelisted variations, variations saved in a User Profile Service (if one exists), and the normal bucketed variation. Impression and conversion events are still tracked when forced bucketing is enabled.

Variations are overwritten with each set method call. To clear the forced variations so that the normal bucketing flow can occur, pass null as the variation key parameter. To get the variation that has been forced, use Get Forced Variation.

This call will fail and return false if the experiment key is not in the project file or if the variation key is not in the experiment.

You can also use Set Forced Variation for feature tests.

Parameters

This table lists the required and optional parameters for the Python SDK.

Parameter
Type
Description

experiment_key
required

string

The key of the experiment to set with the forced variation.

user_id
required

string

The ID of the user to force into the variation.

variation_key
optional

string

The key of the forced variation. Set the value to null to clear the existing experiment-to-variation mapping.

Returns

A Boolean value that indicates if the set completed successfully.

Example

optimizely_client.set_forced_variation('my_experiment_key', 'user_123', 'some_variation_key')

Side effects

In the receiving client instance, sets the forced variation for the specified user in the specified experiment. This forced variation is used instead of the variation that Optimizely would normally determine for that user and experiment.

Source files

The language/platform source files containing the implementation for Python is optimizely.py.

Updated about a year ago


Set Forced Variation


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.