HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Decide methods

This topic gives an overview of the decide methods which can be used to return a flag decision for a user in Optimizely Full Stack.

Use the Decide methods to return a flag decision for a user. The flag decision includes flag enabled/disabled status and flag variation.

This page describes the following Decide methods:

Decide

Version

SDK 3.8 and higher

Description

Returns a decision result for a flag key for a user. The decision result is returned in an OptimizelyDecision object and contains all data required to deliver the flag rule.

Decide is a method of the UserContext object. See OptimizelyUserContext for details.

See the OptimizelyDecision for details of the returned decision object.

Parameters

The following table describes parameters for the Decide method:

ParameterTypeDescription
flagKeyStringThe key of the feature flag
options (optional)ArrayArray of OptimizelyDecideOption enums. See following table.

OptimizelyDecideOption

The following example shows how you can set options individually on any Decide method, or as global defaults when you instantiate the Optimizely client.

using OptimizelySDK;
using OptimizelySDK.OptimizelyDecisions;
using System;
namespace ConsoleApp
{
    class Program
    {
        static void Main()
        {
            var optimizelyClient = OptimizelyFactory.NewDefaultInstance(sdkKey: "<YOUR_SDK_KEY>");

            var user = optimizelyClient.CreateUserContext("user123");

            // set additional options in a decide call
            var decisionResultsMap = user.DecideAll(new OptimizelyDecideOption[] {
                OptimizelyDecideOption.ENABLED_FLAGS_ONLY,
                OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICE,
                OptimizelyDecideOption.DISABLE_DECISION_EVENT
            });

            Console.ReadKey();
        }
    }
}

The following table shows details for the Optimizely client. See Initialize SDK.

options you can set on Decide methods.

OptimizelyDecideOption enumIf set:
OptimizelyDecideOption.DISABLE_DECISION_EVENTPrevents the visitor from firing an impression while still being served the variation, which disables displaying results of the Decide method on the Optimizely application's Results page.

This setting can be why the Decision Event Dispatched enum is false in the returned OptimizelyDecision object or the DECIDE notification listener payload.
OptimizelyDecideOption.ENABLED_FLAGS_ONLYReturn decisions for enabled flags only. This is a valid option only for methods that decide multiple flags, like the Decide All method. This option is ignored if it is invalid. When this option is not set, the SDK returns all decisions regardless of whether the flag is enabled or not.
OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICEWhen set, the SDK bypasses UPS (both lookup and save) for the decision.

When this option is not set, UPS overrides audience targeting, traffic allocation, and experiment mutual exclusion groups.
OptimizelyDecideOption.INCLUDE_REASONSReturn log messages in the Reasons field of OptimizelyDecision object. Note that unlike info or debug messages, critical error messages are always returned, regardless of this setting.
OptimizelyDecideOption.EXCLUDE_VARIABLESExclude flag variable values from the decision result. Use this option to minimize the returned decision by skipping large JSON variables.

Returns

The Decide method returns an OptimizelyDecision object. For more information, see OptimizelyDecision.

If the method encounters a critical error (SDK not ready, invalid flag key, etc), then it returns a decision with a null Variation Key field and populates the Reasons field with error messages (regardless of the Include Reasons option).

Example Decision

The following is an example of calling the Decide method and accessing the returned OptimizelyDecision object:

// create the user and decide which flag rule & variation they bucket into 
var attributes = new UserAttributes();
attributes.Add("logged_in", true);
var user = optimizely.CreateUserContext("user123", attributes);

var decision = user.Decide("product_sort");

// variation. if null, decision fail with a critical error
var variationKey = decision.VariationKey;

// flag enabled state
var enabled = decision.Enabled;

// all variable values
var variables = decision.Variables;

// String variable value
string vs = null;
try 
{
    vs = variables.GetValue<string>("sort_method");
} 
catch (Exception e) 
{
  Console.WriteLine(e.ToString());
}

// Boolean variable value
var vb = (bool) variables.ToDictionary()["k_boolean"];

// flag decision reasons
string flagKey = decision.FlagKey;

// user for which the decision was made
var userContext = decision.UserContext;
   
// reasons for the decision
var reasons = decision.Reasons;

Side Effects

Invokes the DECISION notification listener if this listener is enabled.

Decide All

Returns decisions for all active (unarchived) flags for a user.

See OptimizelyDecision for details.

Version

SDK v3.7 and higher

Description

Use the Decide All method to return a dictionary of flag decisions for a user.

Parameters

The following table describes parameters for the Decide All method:

ParameterTypeDescription
options (optional)ArrayArray of OptimizelyDecideOption enums. See Decide Parameters.

Returns

The Decide All method returns a map of OptimizelyDecisions. For more information, see OptimizelyDecision.

If the method fails for all flags (for example, the SDK is not ready or the user context is invalid), then 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.

Examples

The following is an example of getting flags for the user with the Decide All call:

var options = new OptimizelyDecideOption[] { OptimizelyDecideOption.ENABLED_FLAGS_ONLY };
var decisions = user.DecideAll(options);

var allKeys = decisions.Keys;
var decisionForFlag1 = decisions["flag_1"];

Side effects

Invokes the DECISION notification listener for each decision, if this listener is enabled.

Decide For Keys

The Decide For Keys method returns a map of flag decisions for specified flag keys.

Version

SDK v3.7 and higher

Description

Get a map of flag decisions for an array of flag keys.

Parameters

The following table describes parameters for the Decide for Keys method:

ParameterTypeDescription
keysArrayArray of string flag keys.
options (optional)ArrayArray of OptimizelyDecideOption enums. See OptimizelyDecideOption.

Returns

Returns a map of OptimizelyDecisions. For more information, see OptimizelyDecision.

If the method fails for all flags (for example, the SDK isn't ready or the user context is invalid), then 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

The following is an example of getting specified flags for the user:

// make decisions for specific flags
var keys = new string[] { "flag-1", "flag-2" };
var decisions = user.DecideForKeys(keys);
        
var decision1 = decisions["flag-1"];
var decision2 = decisions["flag-2"];

Side effects

Invokes the DECISION notification listener for each decision, if this listener is enabled.

Source files

The language/platform source files containing the implementation for csharp are at Optimizely.cs.