Movatterモバイル変換


[0]ホーム

URL:


Dev guideRecipesAPI ReferenceChangelog
Dev guideAPI ReferenceRecipesChangelogUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog InFeature Experimentation
Dev guide
All
Pages
Start typing to search…

OptimizelyUserContext for the Swift SDK

Describes theOptimizelyUserContext object for the Swift SDK, which lets you make flag decisions and track events for a user context in Optimizely Feature Experimentation.

TheOptimizelyUserContext object lets you make flag decisions and track events for a user context you have already created using theCreate User Context method.

Also, if you haveReal-Time Audiences for Feature Experimentation, you can evaluate if your user qualifies for an audience segment.

OptimizelyUserContext minimum SDK version

SDK version 3.7 and higher.

Forced decision methods minimum SDK version

setForcedDecision(),getForcedDecision(),removeForcedDecision() andremoveAllForcedDecisions() methods are supported on SDK version 3.10.0 and higher.

Real-Time Audiences for Feature Experimentation minimum SDK version

fetchQualifiedSegments() andisQualifiedFor() methods are supported on version 4.0.0 and higher.

OptimizelyUserContext definition

The following code shows the object definition forOptimizelyUserContext:

public class OptimizelyUserContext {  public var userId: String  public var attributes: [String: Any?]    public init(optimizely: OptimizelyClient,              userId: String,               attributes: [String: Any]? = nil)    // Set an attribute for the user.  public func setAttribute(key: String, value: Any) -> Bool        // Make a decision about which flag variation the user buckets into for the flag key.  public func decide(key: String,                      options: [OptimizelyDecideOption]? = nil) -> OptimizelyDecision    // Make decisions about which flag variations the user buckets into for flag keys.  public func decide(keys: [String],                                    options: [OptimizelyDecideOption]? = nil) -> [String: OptimizelyDecision]    // Make decisions about which flag variations the user buckets into for all flags.  public func decideAll(options: [OptimizelyDecideOption]? = nil) -> [String: OptimizelyDecision]    // Track user event.  public func trackEvent(eventKey: String, eventTags:  [String: Any]? = nil)    // OptimizelyDecisionContext  public struct OptimizelyDecisionContext {    public let flagKey: String    public let ruleKey: String?  }    // OptimizelyForcedDecision  public struct OptimizelyForcedDecision {    public let variationKey:String  }    // Sets a forced decision (variationKey) for a given decision context (flagKey and optional ruleKey).  public func setForcedDecision(context: OptimizelyDecisionContext,                                 decision: OptimizelyForcedDecision) -> Bool    // Returns the forced decision (variationKey) for a given decision context (flagKey and optional ruleKey).  public func getForcedDecision(context: OptimizelyDecisionContext) -> OptimizelyForcedDecision?  // Removes the forced decision (variationKey) for a given decision context (flagKey and optional ruleKey).  public func removeForcedDecision(context: OptimizelyDecisionContext) -> Bool  // Removes all the forced decisions (variationKeys) for the user context.  public func removeAllForcedDecisions() -> Bool  //  // The following methods require Real-Time Audiences for Feature Experimentation.   // See note following this code sample.   //  // An array of audience segment names that the user is qualified for.   // The result of **fetchQualifiedSegments()** is saved here.   // Can be nil if not properly updated with fetchQualifiedSegments().   //   //  You can read and write directly to the qualified segments array.   //  This lets you bypass the remote fetching process from ODP   //  or for utilizing your own fetching service.     public var qualifiedSegments: [String]?   // Fetch all qualified audience segments for the user context.   //  // The segments fetched are saved in **qualifiedSegments** and can be accessed any time.  // On failure, **qualifiedSegments** is nil and one of the following errors are returned:  // - OptimizelyError.invalidSegmentIdentifier  // - OptimizelyError.fetchSegmentsFailed(String)  //  // - Parameters:  //   - options – (Optional) A set of options for fetching qualified segments.  //   - completionHandler – A completion handler to be called with the fetch result.   //     On success, it passes a non-nil segments array (can be empty) with a nil error.   //     On failure, it passes a non-nil error with a nil segments array.  public func fetchQualifiedSegments(options: [OptimizelySegmentOption] = [],                                     completionHandler: @escaping ([String]?, OptimizelyError?) -> Void)  //  Check is the user qualified for the given segment.   // - Parameter segment – The segment name to check qualification for.  // - Returns – True, if qualified.  public func isQualifiedFor(segment: String) -> Bool}
📘

Note

You must configureReal-Time Audiences for Feature Experimentation to access thequalifiedSegments variable and thefetchQualifiedSegments() andisQualifiedFor() methods.

Properties

The following table shows attributes for theOptimizelyUserContext object:

AttributeTypeComment
userIdStringThe ID of the user
attributesMapA map of custom key-value pairs specifying attributes for the user that are used foraudience targeting. You can pass the map with the user ID when you create the user.

Methods

The following table shows methods for theOptimizelyUserContext object:

Method

Comment

setAttribute

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 anOptimizelyDecision object containing all data required to deliver the flag rule.SeeDecide methods.

decideForKeys

Returns a map of flag decisions for specified flag keys.SeeDecide methods.

decideAll

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

trackEvent

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.SeeTrack Event.

setForcedDecision

Forces a user into a specific variation.SeeSet Forced Decision

getForcedDecision

Returns what variation the user was forced into.SeeGet Forced Decision.

removeForcedDecision

Removes a user from a specific forced variation.SeeRemove Forced Decision.

removeAllForcedDecisions

Removes a user from all forced variations.SeeRemove All Forced Decisions.

fetchQualifiedSegments **

Fetch Optimizely Data Platform (ODP) real-time audience segments that the user context qualified for.SeeReal-Time Audiences for Feature Experimentation segment qualification methods.

isQualifiedFor **

Check if the user context qualified for a given ODP real-time segment.SeeReal-Time Audiences for Feature Experimentation segment qualification methods.

** RequiresReal-Time Audiences for Feature Experimentation.

See also

Create User Context

Source files

The language and platform source files containing the implementation for Swift are available onGitHub.

Updated 17 days ago



[8]ページ先頭

©2009-2025 Movatter.jp