Returns the status of the experiment. Possible values:
CREATING, ACTIVE, APPLYING,
APPLIED, REMOVED, UNABLE_TO_CREATE,
UNABLE_TO_APPLY, GRADUATED,
FINISHED.
Return values:
Type
Description
String
The status of the experiment.
getSuffix()
Returns the suffix attached to experiment campaigns names created in the
experiment.
Return values:
Type
Description
String
The suffix attached to experiment campaign names.
getTrafficSplitPercent()
Returns the traffic split percent (percent of traffic directed to ads from
the experiment campaign) of this experiment.
Return values:
Type
Description
int
The traffic split percent (percent of traffic directed to ads from
the experiment campaign) of this experiment.
getType()
Returns the type of the experiment.
Return values:
Type
Description
String
The type of the experiment.
graduate(budget)
Graduates the experiment, establishing the experiment campaign as an
active, full-fledged campaign immediately. Requires a new Budget to be set.
Removes the experiment, thereby removing its associated experiment
campaign, but not removing the associated base campaign.
Returns nothing.
setEndDate(date)
Sets the experiment's end date from either an object containing year,
month, and day fields, or an 8-digit string in YYYYMMDD
format.
For instance, experiment.setEndDate("20130503"); is
equivalent to experiment.setEndDate({year: 2013, month: 5, day:
3});.
The change will fail and report an error if:
the given date is invalid (for example:
{year: 2013, month: 5, day: 55}),
the given date is after the base campaign's end date,
it's a date in the past, or
it's a date after the latest allowed end date of December 30, 2037.
Returns nothing.
Arguments:
Name
Type
Description
date
Object
The new experiment end date.
setName(name)
Sets the name of the experiment.
Returns nothing.
Arguments:
Name
Type
Description
name
String
The new name for the experiment.
setStartDate(date)
Sets the experiment's start date from either an object containing year,
month, and day fields, or an 8-digit string in YYYYMMDD
format.
For instance, experiment.setStartDate("20130503"); is
equivalent to experiment.setStartDate({year: 2013, month: 5, day:
3});.
The change will fail and report an error if:
the experiment has already started,
the given date is invalid (for example:
{year: 2013, month: 5, day: 55}),
the given date is after the experiment's end date,
the given date is after the base campaign's end date,
it's a date in the past, or
it's a date after 1 year into the future from the current date.
it's a date after the latest allowed end date of December 30, 2037.
Returns nothing.
Arguments:
Name
Type
Description
date
Object
The new experiment end date.
startApplying()
Starts applying the experiment's changes back to the base campaign. Does
not wait for completion. View this experiment in the All experiments
tab of the UI to see if its changes are finished being applied.
Returns nothing.
startScheduling()
Schedules the experiment according to the start date set. Materializes the
virtual in_design campaigns to experiment campaigns. There should be some
changes made to the in_design campaigns before the experiment can be
scheduled. Does not wait for completion. View this experiment in the All
experiments tab of the UI to see if the experiment is successfully
scheduled.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-18 UTC."],[],[]]
