The OptimizelyUserContext object allows you to make flag decisions and track events for a user context that you have already created using the Create User Context method.
Additionally, if you have the Advanced Audience Targeting integration between Optimizely Data Platform (ODP) and Optimizely Feature Experimentation enabled, you can evaluate if your user would qualify for a real-time audience segment.
OptimizelyUserContext is supported on SDK v3.8 and higher.
remove_all_forced_decisions() methods are supported on v3.10.0 and higher.
qualified_for?() methods are supported on version 5.0.0-beta and higher. They also require enabling the Advanced Audience Targeting integration.
The following code shows the object definition for OptimizelyUserContext:
module Optimizely class OptimizelyUserContext attr_reader :user_id # Create an instance of the Optimizely User Context. Pass in user id and optionally user attributes def initialize(optimizely_client, user_id, user_attributes) # set an attribute for the user def set_attribute(attribute_key, attribute_value) # get attributes for the user def user_attributes # make a decision about which flag variation the user buckets into for the flag key def decide(key, options = nil) # make decisions about which flag variations the user buckets into for flag keys def decide_for_keys(keys, options = nil) # make decisions about which flag variations the user buckets into for all flags def decide_all(options = nil) # track user event def track_event(event_key, event_tags = nil) # OptimizelyDecisionContext OptimizelyDecisionContext = Struct.new(:flag_key, :rule_key) # OptimizelyForcedDecision OptimizelyForcedDecision = Struct.new(:variation_key) # Sets the forced decision (variation_key) for a given decision context def set_forced_decision(context, decision) # Returns the forced decision for a given decision context def get_forced_decision(context) # Removes the forced decision for a given decision context def remove_forced_decision(context) # Removes all forced decisions bound to this user context def remove_all_forced_decisions # The following methods require the Audience targeting with Optimizely Data Platform # integration enabled. See note below code sample. # An array of segment names that the user is qualified for. # The result of **fetch_qualified_segments()** will be saved here. # Can be nil if not properly updated with fetch_qualified_segments(). # # You can read and write directly to the qualified segments array. # This allows for bypassing the remote fetching process from ODP # or for utilizing your own fetching service. def qualified_segments # Fetch all qualified segments for the user context. # If no callback is provided, this method will fetch the qualified segments # and return a boolean signifying success. # # If a callback is provided, the method will fetch segments in a separate thread, # invoke the provided callback when results are available, and return the thread handle. def fetch_qualified_segments(options, &block) # Check is the user qualified for the given segment. def qualified_for?(segment) end end
You must first enable the Optimizely Data Platform Advanced Audience Targeting integration to be able to access the
qualified_for?()methods. Refer to Advanced Audience Targeting for more information.
The following table shows attributes for the OptimizelyUserContext object:
|user_id||String||The ID of the user|
|(optional) attributes||Map||A map of custom key-value pairs specifying attributes for the user that are used for audience targeting. You can pass the map with the user ID when you create the user.|
The following table shows methods for the OptimizelyUserContext object:
|set_attribute||Pass a custom user attribute as a key-value pair to the user context.|
|decide||Returns a decision result for a flag key for a user in an OptimizelyDecision object, which contains all data required to deliver the flag rule.|
See Decide methods
|decide_for_keys||Returns a map of flag decisions for specified flag keys.|
See Decide methods
|decide_all||Returns decisions for all active (unarchived) flags for a user.|
See Decide methods
|track_event||Tracks a conversion event for a user (an action a user takes) and logs an error message if the specified event key does not match any existing events.|
See Track Event
|set_forced_decision||Forces a user into a specific variation.|
See Set Forced Decision
|get_forced_decision||Returns what variation the user was forced into.|
See Get Forced Decision
|remove_forced_decision||Removes a user from a specific forced variation.|
See Remove Forced Decision
|remove_all_forced_decisions||Removes a user from all forced variations.|
See Remove All Forced Decisions
|fetch_qualified_segments **||Fetch all ODP real-time segments that the user context qualified for. See ODP Audience Segment Methods.|
|qualified_for? **||Check if the user context qualified for a given ODP real-time segment. ODP Audience Segment Methods.|
** Requires the Advanced Audience Targeting integration.
The language/platform source files containing the implementation for Ruby is optimizely.rb.
Updated about 2 months ago