For the complete documentation index, see llms.txt. This page is also available as Markdown.

Variation Distribution

When running an A/B Test, you need to distribute users across Variations and implement the logic for each Variation. You can perform this user distribution through the Hackle SDK.

Variation

By passing an Experiment Key and user to the Variation() method, you can distribute the user and receive the result. Then implement logic for each Variation.

In the example code below, Experiment Key 42 is passed, the User Identifier is "ae2182e0", and two Variations, A and B, exist.

import "github.com/hackle-io/hackle-go-sdk/hackle"

// 실험 키가 42인 A/B 테스트에서
// "ae2182e0"라는 식별자를 가진 사용자에게 노출할 테스트 그룹을 결정합니다.
// 결정하지 못하는 상황인 경우 테스트 그룹 A를 반환합니다.
user := hackle.NewUserBuilder().ID("ae2182e0").Build()
variation := hackleClient.Variation(42, user)

// 할당받은 그룹에 대한 로직
if variation == "A" {
  // 그룹 A 로직
} else {
  // 그룹 B 로직
}

VariationDetail

The VariationDetail() method works the same as the Variation() method and additionally provides the reason for assignment to a specific Variation. This method is useful for checking whether distribution is working correctly. You must pass the Experiment Key as a parameter. In the example code below, Experiment Key 42 is passed.

The distribution decision reason is returned in the form of SDK_NOT_READY. Refer to the table below for details.

Distribution Reason
Description
Distribution Result

SDK_NOT_READY

The SDK is not ready to use.

(e.g., initialization attempted with an invalid SDK Key)

A (Control Group)

EXPERIMENT_NOT_FOUND

No A/B Test was found for the provided Experiment Key. The Experiment Key may be incorrect, or the experiment may be archived.

A (Control Group)

NOT_IN_MUTUAL_EXCLUSION_EXPERIMENT

The experiment is included in Mutually Exclusive Settings, but the user was not assigned to that Mutually Exclusive Group.

A (Control Group)

EXPERIMENT_DRAFT

The A/B Test is in draft state.

A (Control Group)

EXPERIMENT_PAUSED

The A/B Test is paused.

A (Control Group)

EXPERIMENT_COMPLETED

The A/B Test has ended.

Winning Variation selected at completion

OVERRIDDEN

The user was assigned to a specific group by Override.

Override-assigned group

NOT_IN_EXPERIMENT_TARGET

The user is not an A/B Test target.

A (Control Group)

TRAFFIC_NOT_ALLOCATED

The A/B Test is running, but the user was not allocated to the test.

A (Control Group)

TRAFFIC_ALLOCATED

The user has been allocated to the A/B Test.

Allocated group

VARIATION_DROPPED

The originally allocated group has been removed from the test.

A (Control Group)

INVALID_INPUT

The input value is invalid.

A (Control Group)

EXCEPTION

An unknown error occurred.

A (Control Group)

Parameter Settings

  • You can also receive the parameter values of the distributed Variation through the VariationDetail() method.

  • Since parameter values configured on the Hackle A/B Test screen exist as key-value pairs, you can use the methods below according to the configured parameter type to receive and use the configured parameter value.

GetString

  • Returns parameter values configured as STRING or JSON type.

  • Returns the value configured for the distributed Variation.

GetNumber

  • Returns the parameter value configured as Number type as a float64 type.

  • Returns the value configured for the distributed Variation.

GetBool

  • Returns parameter values configured as bool type.

  • Returns the value configured for the distributed Variation.

Last updated