Class ABTestSegment

Object representing an AB-test segment in the Commerce Cloud Digital.

Each AB-test defines 1 or more segments to which customers are randomly assigned by the platform when they qualify for the AB-test. Customers are assigned to segments according to allocation percentages controlled by the merchant. Each AB-test segment defines a set of “experiences” that the merchant is testing and which which apply only to the customers in that segment. There is always one “control” segment which contains only the default set of experiences for that site.

Property Summary 

PropertyDescription
ABTest: ABTest (read-only)Get the AB-test to which this segment belongs.
ID: String (read-only)Get the ID of the AB-test segment.
controlSegment: Boolean (read-only)Returns true if this is the “control segment” for the AB-test, meaning the segment that has no experiences associated with it.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
getABTest()Get the AB-test to which this segment belongs.
getID()Get the ID of the AB-test segment.
isControlSegment()Returns true if this is the “control segment” for the AB-test, meaning the segment that has no experiences associated with it.

Methods inherited from class PersistentObject 

getCreationDate, getLastModified, getUUID

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

ABTest 

ABTest: ABTest (read-only)

Get the AB-test to which this segment belongs.


ID 

ID: String (read-only)

Get the ID of the AB-test segment.


controlSegment 

controlSegment: Boolean (read-only)

Returns true if this is the "control segment" for the AB-test, meaning the segment that has no experiences associated with it.


Method Details 

getABTest() 

getABTest(): ABTest

Get the AB-test to which this segment belongs.

Returns:

  • the AB-test to which this segment belongs.

getID() 

getID(): String

Get the ID of the AB-test segment.

Returns:

  • the ID of the AB-test segment.

isControlSegment() 

isControlSegment(): Boolean

Returns true if this is the "control segment" for the AB-test, meaning the segment that has no experiences associated with it.

Returns:

  • true if this segment is the "control segment" for the AB-test, or false otherwise.