Starts creating anExperiment. Returns
nothing, unlike calls toBuilder.build(). Navigate to theAll experimentstab of the UI to track the new experiment's
creation.
Returns nothing.
build()
Creates the experiment according to the configuration provided to the
builder.
Experiment builder with the specified campaign as base campaign.
withEndDate(date)
Sets the experiment's end date from either an object containing year,
month, and day fields, or an 8-digit string inYYYYMMDDformat. This field is optional and will default to the end date of the base
campaign if not specified.
For instance,experimentBuilder.withEndDate("20180503");is
equivalent toexperimentBuilder.withEndDate({year: 2018, month: 5,
day: 3});.
The change will fail and report an error if:
the given date is invalid (for example:{year: 2018, 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.
Sets the experiment's start date from either an object containing year,
month, and day fields, or an 8-digit string inYYYYMMDDformat. This field is optional and will default to the start date of the
base campaign if not specified.
For instance,experimentBuilder.withStartDate("20180503");is equivalent toexperimentBuilder.withStartDate({year: 2018, month:
5, day: 3});.
The change will fail and report an error if:
the given date is invalid (for example:{year: 2018, 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 the latest allowed end date of December 30, 2037.
Experiment builder with the specified suffix to be used for
experiment campaign name.
withTrafficSplitPercent(trafficSplitPercent)
Sets the traffic split percent (percent of traffic directed to ads from the
experiment campaign) of the new experiment to the specified value. Must be
an integer between 0 and 100, not inclusive. Required before building.
Experiment builder with the specified traffic split percent.
withTrafficSplitType(trafficSplitType)
Sets the traffic split type (cookie-based or search-based) of the new
experiment. Only supported on Search campaign experiments, but also
required for Search campaign experiments.
[[["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 2025-09-03 UTC."],[[["\u003cp\u003eThis page documents the \u003ccode\u003eExperimentBuilder\u003c/code\u003e for creating and configuring Google Ads experiments programmatically.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eExperimentBuilder\u003c/code\u003e allows setting essential parameters like name, campaign, traffic split, start and end dates, and goals for the experiment.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ebuild()\u003c/code\u003e method creates the experiment based on the provided configurations.\u003c/p\u003e\n"],["\u003cp\u003eSeveral methods like \u003ccode\u003ewithName()\u003c/code\u003e, \u003ccode\u003ewithCampaign()\u003c/code\u003e, \u003ccode\u003ewithTrafficSplitPercent()\u003c/code\u003e, etc., are used to set individual experiment properties.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the provided methods and their descriptions for detailed usage instructions and argument types.\u003c/p\u003e\n"]]],[],null,[]]
