Get Variation Name

After successfully instantiating a VWO class, getVariationName API returns the variation assigned to the specified user if the user qualifies to become part of the specified campaign. This API doesn't activate the campaign i.e. it will not send any impression call to the VWO servers for tracking any data.

Description

The API method:

Validates the parameters passed.
Checks whether the user is whitelisted.
Checks if User Storage Service is provided to know whether the user is returning. If yes, show the previously assigned variation always.
Checks if the campaign is part of Mutually Exclusive Group and evaluates all the grouped campaigns to decide whether the user is eligible for the campaign.
Checks whether the user is eligible for a campaign based on pre-segmentation conditions.
Checks whether the user qualifies to become a part of the campaign based on traffic allocation.
Assigns a deterministic variation to the qualified user.
Does not send an impression event to the VWO server.

It takes the same parameters and returns the same value as Activate API. The only difference is that this API method does not send a tracking impression to the VWO server. This API method is used to get the variation assigned to the userId.
The behaviour of the two API methods, that is, activate and getVariationName is identical otherwise.

Use Get Variation Name API if Activate API has already been triggered to prevent a user from being tracked again. Also, this API is also helpful in retrieving the variation assignment to a particular User Id, respecting all other factors like segmentation, whitelisting, etc. without sending any impression call to the VWO servers.

Parameter definitions

Parameter	Type	Description
campaign_key Required	String	The campaign needs to be identified based on the unique test-key provided at the time of campaign creation.
user_id Required	String	The User ID which uniquely identifies each user.
options Optional	Object	Pass params for pre-segmentation and whitelisting customVariables(Object): Custom variables to be matched against Campaign's pre-segmentation. variationTargetingVariables(Object): Custom variation targeting variables to be matched against Campaign's forced variation/whitelisting conditions.

Returns

The name of the variation in which the user is bucketed, or is null if the user does not qualify for a campaign.

Value	Type	Description
Variation name	String	When a user qualifies for the campaign, variation name is returned.
null	Object	When a user is not qualified for a campaign, null is returned.

Usage

import vwo

settings_file = vwo.get_settings_file(account_id, sdk_key)
vwo_client_instance = vwo.launch(settings_file)

# campaign_key: you provide at the time of campaign creation
# user_id: how you identify a particular user
# custom_variables: pre-segmentation variables
# variation_targeting_variables: forced variation variables
variation_name = vwo_client_instance.get_variation_name(campaign_key, user_id, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)

if (variation_name == "Control"):
  # CODE: write code for Control
elif (variation_name == "Variation-1"):
  # CODE: write code for Variation-1
else:
  # CODE: User is not qualified for the campaign. Would be due to configuring campaign's percent-traffic less than 100% while creating or updating a FullStack campaign.

Campaign Activation with User Storage Service

If User Storage Service is provided, campaign activation is mandatory before tracking any goal, getting a variation of a campaign, and getting the value of the feature's variable.

Correct Usage

vwo_client_instance.activate(campaign_key, user_id)
vwo_client_instance.track(campaign_key, user_id, goal_identifier)

Wrong Usage

# Calling track API before activate API
# This will not track goal as campaign has not been activated yet.
vwo_client_instance.track(campaign_key, user_id, goal_identifier)

# After calling track API
vwo_client_instance.activate(campaign_key, user_id)