--- title: "POST /v23/customers/{+customerId}/experiments:mutate" method: POST path: "/v23/customers/{+customerId}/experiments:mutate" tags: ["customers"] --- # POST /v23/customers/{+customerId}/experiments:mutate `POST /v23/customers/{+customerId}/experiments:mutate` Creates, updates, or removes experiments. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ExperimentError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() ## Path parameters - `customerId` string, required ## Request body - GoogleAdsSearchads360V23ServicesMutateExperimentsRequest — Request message for ExperimentService.MutateExperiments. - `validateOnly` boolean — If true, the request is validated but not executed. Only errors are returned, not results. - `operations` GoogleAdsSearchads360V23ServicesExperimentOperation[] — Required. The list of operations to perform on individual experiments. - `create` GoogleAdsSearchads360V23ResourcesExperiment — A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. - `experimentId` string, int64 — Output only. The ID of the experiment. Read only. - `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. - `endDate` 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 - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'DISPLAY_AND_VIDEO_360' | 'AD_VARIATION' | 'YOUTUBE_CUSTOM' | 'DISPLAY_CUSTOM' | 'SEARCH_CUSTOM' | 'DISPLAY_AUTOMATED_BIDDING_STRATEGY' | 'SEARCH_AUTOMATED_BIDDING_STRATEGY' | 'SHOPPING_AUTOMATED_BIDDING_STRATEGY' | 'SMART_MATCHING' | 'HOTEL_CUSTOM' — Required. The product/feature that uses this experiment. - `status` 'UNSPECIFIED' | 'UNKNOWN' | 'ENABLED' | 'REMOVED' | 'HALTED' | 'PROMOTED' | 'SETUP' | 'INITIATED' | 'GRADUATED' — The Advertiser-chosen status of this experiment. - `goals` GoogleAdsSearchads360V23CommonMetricGoal[] — The goals of this experiment. - `metric` 'UNSPECIFIED' | 'UNKNOWN' | 'CLICKS' | 'IMPRESSIONS' | 'COST' | 'CONVERSIONS_PER_INTERACTION_RATE' | 'COST_PER_CONVERSION' | 'CONVERSIONS_VALUE_PER_COST' | 'AVERAGE_CPC' | 'CTR' | 'INCREMENTAL_CONVERSIONS' | 'COMPLETED_VIDEO_VIEWS' | 'CUSTOM_ALGORITHMS' | 'CONVERSIONS' | 'CONVERSION_VALUE' — The metric of the goal. For example, clicks, impressions, cost, conversions, etc. - `direction` 'UNSPECIFIED' | 'UNKNOWN' | 'NO_CHANGE' | 'INCREASE' | 'DECREASE' | 'NO_CHANGE_OR_INCREASE' | 'NO_CHANGE_OR_DECREASE' — The metric direction of the goal. For example, increase, decrease, no change. - `promoteStatus` 'UNSPECIFIED' | 'UNKNOWN' | 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'COMPLETED_WITH_WARNING' — Output only. The status of the experiment promotion process. - `syncEnabled` boolean — 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. - `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. - `longRunningOperation` 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. - `description` string — The description of the experiment. It must have a minimum length of 1 and maximum length of 2048. - `resourceName` string — Immutable. The resource name of the experiment. Experiment resource names have the form: `customers/{customer_id}/experiments/{experiment_id}` - `startDate` 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 - `update` GoogleAdsSearchads360V23ResourcesExperiment — A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. - `experimentId` string, int64 — Output only. The ID of the experiment. Read only. - `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. - `endDate` 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 - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'DISPLAY_AND_VIDEO_360' | 'AD_VARIATION' | 'YOUTUBE_CUSTOM' | 'DISPLAY_CUSTOM' | 'SEARCH_CUSTOM' | 'DISPLAY_AUTOMATED_BIDDING_STRATEGY' | 'SEARCH_AUTOMATED_BIDDING_STRATEGY' | 'SHOPPING_AUTOMATED_BIDDING_STRATEGY' | 'SMART_MATCHING' | 'HOTEL_CUSTOM' — Required. The product/feature that uses this experiment. - `status` 'UNSPECIFIED' | 'UNKNOWN' | 'ENABLED' | 'REMOVED' | 'HALTED' | 'PROMOTED' | 'SETUP' | 'INITIATED' | 'GRADUATED' — The Advertiser-chosen status of this experiment. - `goals` GoogleAdsSearchads360V23CommonMetricGoal[] — The goals of this experiment. - `metric` 'UNSPECIFIED' | 'UNKNOWN' | 'CLICKS' | 'IMPRESSIONS' | 'COST' | 'CONVERSIONS_PER_INTERACTION_RATE' | 'COST_PER_CONVERSION' | 'CONVERSIONS_VALUE_PER_COST' | 'AVERAGE_CPC' | 'CTR' | 'INCREMENTAL_CONVERSIONS' | 'COMPLETED_VIDEO_VIEWS' | 'CUSTOM_ALGORITHMS' | 'CONVERSIONS' | 'CONVERSION_VALUE' — The metric of the goal. For example, clicks, impressions, cost, conversions, etc. - `direction` 'UNSPECIFIED' | 'UNKNOWN' | 'NO_CHANGE' | 'INCREASE' | 'DECREASE' | 'NO_CHANGE_OR_INCREASE' | 'NO_CHANGE_OR_DECREASE' — The metric direction of the goal. For example, increase, decrease, no change. - `promoteStatus` 'UNSPECIFIED' | 'UNKNOWN' | 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'COMPLETED_WITH_WARNING' — Output only. The status of the experiment promotion process. - `syncEnabled` boolean — 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. - `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. - `longRunningOperation` 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. - `description` string — The description of the experiment. It must have a minimum length of 1 and maximum length of 2048. - `resourceName` string — Immutable. The resource name of the experiment. Experiment resource names have the form: `customers/{customer_id}/experiments/{experiment_id}` - `startDate` 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 - `remove` string — Remove operation: The experiment is expected to have a valid resource name, in this format: `customers/{customer_id}/experiments/{campaign_experiment_id}` - `updateMask` string, google-fieldmask — FieldMask that determines which resource fields are modified in an update. - `partialFailure` boolean — If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/searchads360.md) · [All operations](https://skmtc.net/google/apis/searchads360/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/searchads360/versions/40d087435afd/schema)