Experiment
Stay organized with collections
Save and categorize content based on your preferences.
A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.
| Fields |
resource_name
|
string
Immutable. The resource name of the experiment. Experiment resource names have the form: customers/{customer_id}/experiments/{experiment_id}
|
name
|
string
Required. The name of the experiment. It must have a minimum length of 1 and maximum length of 1024. It must be unique under a customer.
|
description
|
string
The description of the experiment. It must have a minimum length of 1 and maximum length of 2048.
|
suffix
|
string
For system managed experiments, the advertiser must provide a suffix during construction, in the setup stage before moving to initiated. The suffix will be appended to the in-design and experiment campaign names so that the name is base campaign name + suffix.
|
type
|
ExperimentType
Required. The product/feature that uses this experiment.
|
status
|
ExperimentStatus
The Advertiser-chosen status of this experiment.
|
goals[]
|
MetricGoal
The goals of this experiment.
|
|
AsyncActionStatus
Output only. The status of the experiment promotion process.
|
experiment_id
|
int64
Output only. The ID of the experiment. Read only.
|
start_date
|
string
Date when the experiment starts. By default, the experiment starts now or on the campaign's start date, whichever is later. If this field is set, then the experiment starts at the beginning of the specified date in the customer's time zone. Format: YYYY-MM-DD Example: 2019-03-14
|
end_date
|
string
Date when the experiment ends. By default, the experiment ends on the campaign's end date. If this field is set, then the experiment ends at the end of the specified date in the customer's time zone. Format: YYYY-MM-DD Example: 2019-04-18
|
long_running_operation
|
string
Output only. The resource name of the long-running operation that can be used to poll for completion of experiment schedule or promote. The most recent long running operation is returned.
|
sync_enabled
|
bool
Immutable. Set to true if changes to base campaigns should be synced to the trial campaigns. Any changes made directly to trial campaigns will be preserved. This field can only be set when the experiment is being created.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["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-08-07 UTC."],[],[],null,["# Experiment\n\nA Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.\n\n| Fields ||\n|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `resource_name` | `string` Immutable. The resource name of the experiment. Experiment resource names have the form: `customers/{customer_id}/experiments/{experiment_id}` |\n| ### `name` | `string` Required. The name of the experiment. It must have a minimum length of 1 and maximum length of 1024. It must be unique under a customer. |\n| ### `description` | `string` The description of the experiment. It must have a minimum length of 1 and maximum length of 2048. |\n| ### `suffix` | `string` For system managed experiments, the advertiser must provide a suffix during construction, in the setup stage before moving to initiated. The suffix will be appended to the in-design and experiment campaign names so that the name is base campaign name + suffix. |\n| ### `type` | [ExperimentType](/google-ads/api/reference/rpc/v21/ExperimentTypeEnum.ExperimentType) Required. The product/feature that uses this experiment. |\n| ### `status` | [ExperimentStatus](/google-ads/api/reference/rpc/v21/ExperimentStatusEnum.ExperimentStatus) The Advertiser-chosen status of this experiment. |\n| ### `goals[]` | [MetricGoal](/google-ads/api/reference/rpc/v21/MetricGoal) The goals of this experiment. |\n| ### `promote_status` | [AsyncActionStatus](/google-ads/api/reference/rpc/v21/AsyncActionStatusEnum.AsyncActionStatus) Output only. The status of the experiment promotion process. |\n| ### `experiment_id` | `int64` Output only. The ID of the experiment. Read only. |\n| ### `start_date` | `string` Date when the experiment starts. By default, the experiment starts now or on the campaign's start date, whichever is later. If this field is set, then the experiment starts at the beginning of the specified date in the customer's time zone. Format: YYYY-MM-DD Example: 2019-03-14 |\n| ### `end_date` | `string` Date when the experiment ends. By default, the experiment ends on the campaign's end date. If this field is set, then the experiment ends at the end of the specified date in the customer's time zone. Format: YYYY-MM-DD Example: 2019-04-18 |\n| ### `long_running_operation` | `string` Output only. The resource name of the long-running operation that can be used to poll for completion of experiment schedule or promote. The most recent long running operation is returned. |\n| ### `sync_enabled` | `bool` Immutable. Set to true if changes to base campaigns should be synced to the trial campaigns. Any changes made directly to trial campaigns will be preserved. This field can only be set when the experiment is being created. |"]]
