Decide methods for the Android SDK
Use the decide methods to return feature flag decisions for a user. Each decision includes whether the flag is enabled and which variation the user receives.
Decide
Returns a decision for a specific feature flag and user.
Minimum SDK version – v3.9+
Description
The decide method handles the variation decision for an individual experiment. It returns a decision result for a flag key for a user in an OptimizelyDecision object and contains the data required to deliver the flag rule.
This method ensures that Feature Experimentation properly buckets the user in experiment analytics, and you should use it if there is no need for pre-rendering decisions.
Decide is a method of the UserContext object. See OptimizelyUserContextOptimizelyUserContext for details.
See the `OptimizelyDecision``OptimizelyDecision` documentation for details of the returned decision object.
Key features
- Single experiment decision – Returns the variation for a specific experiment.
- Bucketing in results – Ensures Feature Experimentation records the user in the experiment results page for proper analysis.
- Complement to decide all method – If you use the decide all methoddecide all method to pre-fetch variations, you should also call the decide method for each experiment that the user interacts with. This dual approach guarantees that Feature Experimentation accurately tracks the user's participation and that the correct variation is served through caching.
- CMAB support – For CMAB experiments, decisions are automatically cached to reduce latency. The cache is invalidated when CMAB attributes change or TTL expires. Use CMAB-specific decide options (IGNORE_CMAB_CACHE, INVALIDATE_USER_CMAB_CACHE, and RESET_CMAB_CACHE) to override default caching behavior. See the following CMAB cache control information.
On Android, the synchronous decide method does not serve CMAB decisions. For flags with CMAB experiments, use decideAsync, or use decideBlocking on a background thread. The CMAB cache and CMAB decide options apply to both methods.
Parameters
The following table describes the parameters for the decide method:
Parameter | Type | Description |
|---|---|---|
flagKey | String | The key of the feature flag |
options (optional) | Array | Array of OptimizelyDecideOption enums. |
Returns
The decide method returns an OptimizelyDecision object. For information, see OptimizelyDecisionOptimizelyDecision.
If the method encounters a critical error (SDK not ready, invalid flag key, and so on), then it returns a decision with a null variationKey field and populates the reasons field with error messages (regardless of the OptimizelyDecideOption.INCLUDE_REASONS option).
Example decide
// Create the user and decide which flag rule and variation they bucket into
val attributes: MutableMap<String, Any> = HashMap()
attributes["logged_in"] = true
val user = optimizelyClient.createUserContext("user123", attributes)
val decision = user!!.decide("product_sort")
// Variation key. If null, the decision failed due to a critical error.
val variationKey = decision.variationKey
// The flag enabled state
val enabled = decision.enabled
// All variable values
val variables = decision.variables
// String variable value
var vs: String? = null
try {
vs = variables.getValue("sort_method", String::class.java)
} catch (e: JsonParseException) {
e.printStackTrace()
}
// Boolean variable value
val vb = variables.toMap()!!["k_boolean"] as Boolean?
// Flag key for which decision was made
val flagKey = decision.flagKey
// User for which the decision was made
val userContext = decision.userContext
// Reasons for the decision
val reasons = decision.reasons// Create the user and decide which flag rule and variation they bucket into
Map<String, Object> attributes = new HashMap<>();
attributes.put("logged_in", true);
OptimizelyUserContext user = optimizelyClient.createUserContext("user123", attributes);
OptimizelyDecision decision = user.decide("product_sort");
// Variation key. If null, the decision failed due to a critical error.
String variationKey = decision.getVariationKey();
// Flag enabled state
boolean enabled = decision.getEnabled();
// All variable values
OptimizelyJSON variables = decision.getVariables();
// String variable value
String vs = null;
try {
vs = variables.getValue("sort_method", String.class);
} catch (JsonParseException e) {
e.printStackTrace();
}
// Boolean variable value
Boolean vb = (Boolean) variables.toMap().get("k_boolean");
// Flag key for which decision was made
String flagKey = decision.getFlagKey();
// User for which the decision was made
OptimizelyUserContext userContext = decision.getUserContext();
// Reasons for the decision
List<String> reasons = decision.getReasons();Side effect
Invokes the decision notification listenerdecision notification listener if this listener is enabled.
Decide all
Returns decisions for all active (unarchived) flags for a user.
Minimum SDK version – v3.9+
Description
Use the decide all method to retrieve decisions for all active flags before rendering content. This is particularly useful when you need to serve the correct cached version of your page or component based on the user's variation. For example when using an edge workeredge worker or cloud functioncloud function.
Key features
- Pre-rendering decision – Lets you know all variation assignments ahead of time.
- Cache control – Lets you serve the correct cached content based on the user's pre-determined variations.
- Delay experiment tracking – Use DISABLE_DECISION_EVENT to prevent the SDK from recording a decision before the user sees the feature. This ensures that participation is only tracked when the experience is delivered.
- CMAB support – For CMAB experiments (SDK v5.2.0+), decisions are automatically cached to reduce latency. The cache is invalidated when CMAB attributes change or TTL expires. Use CMAB-specific decide options (ignoreCmabCache, invalidateUserCmabCache, resetCmabCache) to override default caching behavior. See CMAB cache controlCMAB cache control.
On Android, the synchronous decideAll and decideForKeys methods do not serve CMAB decisions. For flags with CMAB experiments, use decideAllAsync / decideForKeysAsync (or decideAllBlocking / decideForKeysBlocking on a background thread).
Parameters
The following table describes the parameters for the decide all method:
Parameter | Type | Description |
|---|---|---|
options (optional) | Array | Array of OptimizelyDecideOption enums. |
Returns
Returns a map of `OptimizelyDecisions``OptimizelyDecisions`.
If the method fails for all flags (for example, the SDK is not ready or the user context is invalid), it returns an empty map. If the method detects an error for a specific flag, it returns error messages in the reasons field of the decision for that flag.
Example decideAll
// make decisions for all active (unarchived) flags in the project for a user
val options = Arrays.asList(OptimizelyDecideOption.ENABLED_FLAGS_ONLY)
val decisions = user!!.decideAll(options)
val allKeys: Set<String> = decisions.keys
val decisionForFlag1 = decisions["flag_1"]// make decisions for all active (unarchived) flags in the project for a user
List<OptimizelyDecideOption> options = Arrays.asList(OptimizelyDecideOption.ENABLED_FLAGS_ONLY);
Map<String, OptimizelyDecision> decisions = user.decideAll(options);
Set<String> allKeys = decisions.keySet();
OptimizelyDecision decisionForFlag1 = decisions.get("flag_1");Side effect
Invokes the decision notification listenerdecision notification listener for each decision, if this listener is enabled.
Decide for keys
Returns a map of flag decisions for specified flag keys.
Minimum SDK version – v3.9+
Description
Returns a map of decisions for the specified flag keys.
Parameters
The following table describes parameters for the decide for keys method:
Parameter | Type | Description |
|---|---|---|
keys | Array | Array of string flag keys. |
options (optional) | Array | Array of OptimizelyDecideOption enums. |
Returns
Returns a map of OptimizelyDecisions. For information, see OptimizelyDecisionOptimizelyDecision.
If the method fails for all flags (for example, the SDK is not ready or the user context is invalid), it returns an empty map. If the method detects an error for a specific flag, it returns error messages in the reasons field of the decision for that flag.
Example decideForKeys
// make decisions for specific flags
val keys = Arrays.asList("flag-1", "flag-2")
val decisions = user!!.decideForKeys(keys)
val decision1 = decisions["flag-1"]
val decision2 = decisions["flag-2"]// make decisions for specific flags
List<String> keys = Arrays.asList("flag-1", "flag-2");
Map<String, OptimizelyDecision> decisions = user.decideForKeys(keys);
OptimizelyDecision decision1 = decisions.get("flag-1");
OptimizelyDecision decision2 = decisions.get("flag-2");Side effect
Invokes the decision notification listenerdecision notification listener for each decision, if this listener is enabled.
Decide async
Minimum SDK version – v5.1+
Description
Makes a decision asynchronously for a given flag key and user context. If a flag involves an asynchronous decision step (such as a CMAB experiment), this API should be used instead of the synchronous decide API.
Parameters
The following table describes parameters for the decide for keys method:
Parameter | Type | Description |
|---|---|---|
flagKey | String | The key of the feature flag. |
options (optional) | Array | Array of OptimizelyDecideOption enums. |
callback | OptimizelyDecisionCallback | A callback to invoke when the decision is available. |
Returns
This method has no return value. The result is delivered through the provided callback.
When the asynchronous decision completes, the Android SDK invokes the provided callback with an OptimizelyDecision result.
Example decideAsync
// Create the user and decide which flag rule and variation they bucket into
val attributes = mapOf<String, Any>(
"logged_in" to true
)
val user = optimizelyClient.createUserContext("user123", attributes)
user!!.decideAsync("product_sort") { decision: OptimizelyDecision ->
// Variation key. If null, the decision failed due to a critical error.
val variationKey: String? = decision.variationKey
// Flag enabled state
val enabled: Boolean = decision.enabled
// All variable values
val variables: OptimizelyJSON = decision.variables
// String variable value
val vs: String? = try {
variables.getValue("sort_method", String::class.java)
} catch (e: JsonParseException) {
e.printStackTrace()
null
}
// Boolean variable value
val vb: Boolean? = variables.toMap()["k_boolean"] as? Boolean
// Flag key for which decision was made
val flagKey: String = decision.flagKey
// User for which the decision was made
val userContext: OptimizelyUserContext = decision.userContext
// Reasons for the decision
val reasons: List<String> = decision.reasons
}// Create the user and decide which flag rule and variation they bucket into
Map<String, Object> attributes = new HashMap<>();
attributes.put("logged_in", true);
OptimizelyUserContextAndroid user = optimizelyClient.createUserContext("user123", attributes);
user.decideAsync("product_sort", (OptimizelyDecision decision) -> {
// Variation key. If null, the decision failed due to a critical error.
String variationKey = decision.getVariationKey();
// Flag enabled state
boolean enabled = decision.getEnabled();
// All variable values
OptimizelyJSON variables = decision.getVariables();
// String variable value
String vs = null;
try {
vs = variables.getValue("sort_method", String.class);
} catch (JsonParseException e) {
e.printStackTrace();
}
// Boolean variable value
Boolean vb = (Boolean) variables.toMap().get("k_boolean");
// Flag key for which decision was made
String flagKey = decision.getFlagKey();
// User for which the decision was made
OptimizelyUserContext userContext = decision.getUserContext();
// Reasons for the decision
List<String> reasons = decision.getReasons();
});Side effect
Invokes the decision notification listenerdecision notification listener for each decision, if this listener is enabled.
Decide all async
Minimum SDK version – v5.1+
Description
Makes decisions asynchronously for all active flag keys and user context. If any flag involves an asynchronous decision step (such as a CMAB experiment), this API should be used instead of the synchronous decideAll API.
Parameters
The following table describes parameters for the decide for keys method:
Parameter | Type | Description |
|---|---|---|
options (optional) | Array | Array of OptimizelyDecideOption enums. |
callback | OptimizelyDecisionsCallback | A callback to invoke when the decision is available. |
Returns
This method has no return value. The result is delivered through the provided callback.
When the asynchronous decision completes, the Android SDK invokes the provided callback with a map of keys to their corresponding OptimizelyDecision objects.
Example decideAllAsync
// make decisions for all active (unarchived) flags in the project for a user
val options = listOf(OptimizelyDecideOption.ENABLED_FLAGS_ONLY)
user!!.decideAllAsync(options) { decisions: Map<String, OptimizelyDecision> ->
val decisionForFlag1 = decisions["flag_1"]
}// make decisions for all active (unarchived) flags in the project for a user
List<OptimizelyDecideOption> options = Arrays.asList(OptimizelyDecideOption.ENABLED_FLAGS_ONLY);
user.decideAllAsync(options, (Map<String, OptimizelyDecision> decisions) -> {
OptimizelyDecision decisionForFlag1 = decisions.get("flag_1");
});Side effect
Invokes the decision notification listenerdecision notification listener for each decision, if this listener is enabled.
Decide for keys async
Minimum SDK version – v5.1+
Description
Makes decisions asynchronously for the specified flag keys and user context. If any flag involves an asynchronous decision step (such as a CMAB experiment), this API should be used instead of the synchronous decideForKeys API.
Parameters
The following table describes parameters for the decide for keys method:
Parameter | Type | Description |
|---|---|---|
keys | Array | Array of string flag keys. |
options (optional) | Array | Array of OptimizelyDecideOption enums. |
callback | OptimizelyDecisionsCallback | A callback to invoke when the decision is available. |
Returns
This method has no return value. The result is delivered through the provided callback.
When the asynchronous decision completes, the Android SDK invokes the provided callback with a map of keys to their corresponding OptimizelyDecision objects.
Example decideForKeysAsync
// make decisions for specific flags
val keys = listOf("flag-1", "flag-2")
user!!.decideForKeysAsync(keys) { decisions: Map<String, OptimizelyDecision> ->
val decision1 = decisions["flag-1"]
val decision2 = decisions["flag-2"]
}// make decisions for specific flags
List<String> keys = Arrays.asList("flag-1", "flag-2");
user.decideForKeysAsync(keys, (Map<String, OptimizelyDecision> decisions) -> {
OptimizelyDecision decision1 = decisions.get("flag-1");
OptimizelyDecision decision2 = decisions.get("flag-2");
});Side effect
Invokes the decision notification listenerdecision notification listener for each decision, if this listener is enabled.
OptimizelyDecideOption
The following table lists the OptimizelyDecideOption enum with an explanation what happens if you set them. In addition to setting these options individually for a decide method, you can also set them as global defaults when you instantiate the Optimizely client. See Initialize the Android SDK.
OptimizelyDecideOption enum | If set |
|---|---|
OptimizelyDecideOption.DISABLE_DECISION_EVENT | Prevents the SDK from dispatching an impressionimpression event when serving a variation. This disables decision tracking on the Optimizely Experiment Results pageOptimizely Experiment Results page. The decision notification listenerdecision notification listener is still called, with decisionEventDispatched set to false. |
OptimizelyDecideOption.ENABLED_FLAGS_ONLY | Returns decisions only for flags that are currently enabled. Used with the decide all method and decide for keys method. When this option is not set, the SDK returns all decisions regardless of whether the flag is enabled. |
OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICE | Bypasses the user profile service (both lookup and save) for the decision. When this option is not set, user profile service overrides audience targeting, traffic allocation, and experiment mutual exclusion groups. |
OptimizelyDecideOption.INCLUDE_REASONS | Adds log messages to the reasons field of the decision. Critical errors are always returned, even if this option is not set. |
OptimizelyDecideOption.EXCLUDE_VARIABLES | Excludes flag variable values from the decision result. Use this option to minimize the returned decision by skipping large JSON variables. |
OptimizelyDecideOption.IGNORE_CMAB_CACHE | Bypasses the CMAB cache and fetches a fresh decision from the CMAB service. Use when you need real-time decisions that reflect the latest context. |
OptimizelyDecideOption.INVALIDATE_USER_CMAB_CACHE | Removes the cached CMAB decision for this user and experiment before making the decision. Use when user context has changed significantly and you want to ensure a fresh decision. |
OptimizelyDecideOption.RESET_CMAB_CACHE | Clears all entries from the CMAB cache before making the decision. Use sparingly for testing or cache corruption scenarios. |
The following code sample shows how to implement the OptimizelyDecideOption as a global default and locally in a decide method call.
// Set global default decide options when initializing the client
var options: List<OptimizelyDecideOption>
options = Arrays.asList(OptimizelyDecideOption.DISABLE_DECISION_EVENT)
val optimizelyManager = OptimizelyManager.builder()
.withSDKKey("YOUR_SDK_KEY") // Replace with your SDK key
.withDefaultDecideOptions(options)
.build(context)
// Set additional options in a decide call
val optimizelyClient = optimizelyManager.initialize(context, R.raw.datafile)
val user = optimizelyClient.createUserContext("user123")
options = Arrays.asList(OptimizelyDecideOption.ENABLED_FLAGS_ONLY,
OptimizelyDecideOption.EXCLUDE_VARIABLES)
val decisions = user!!.decideAll(options)// Set global default decide options when initializing the client
List<OptimizelyDecideOption> options;
options = Arrays.asList(OptimizelyDecideOption.DISABLE_DECISION_EVENT);
OptimizelyManager optimizelyManager = OptimizelyManager.builder()
.withSDKKey("YOUR_SDK_KEY") // Replace with your SDK key
.withDefaultDecideOptions(options)
.build(context);
// Set additional options in a decide call
OptimizelyClient optimizelyClient = optimizelyManager.initialize(context, R.raw.datafile);
OptimizelyUserContext user = optimizelyClient.createUserContext("user123");
options = Arrays.asList(OptimizelyDecideOption.ENABLED_FLAGS_ONLY,
OptimizelyDecideOption.EXCLUDE_VARIABLES);
Map<String, OptimizelyDecision> decisions = user.decideAll(options);Best practices
- Early and late invocation
- Use the decide all method early in your application's rendering process to load the correct cached content. For example, on the CDN with an Edge SDKCDN with an Edge SDK.
- Use the decide method at the point of user interaction or when you must ensure Feature Experimentation records the decision in your experiment analytics.
- Combining methods – When using the decide and decide all methods, always pair the decide all method with the decide method for each experiment the user encounters. This prevents discrepancies between served content and analytics data.
- Parameter management – Ensure you use the DISABLE_DECISION_EVENT option with the decide all method to avoid premature bucketing, then use the decide method to handle the decision event when the user experiences the content.
Source files
The language and platform source files containing the implementation for the Android SDK are available on GitHub.