GoogleAdsGoogleadsV25Services__MutateExperimentsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-google-ads-googleads-v25-services-mutate-experiments-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateExperimentsRequest",
  "description": "Request message for ExperimentService.MutateExperiments.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-experiments-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateExperimentsRequest",
  "type": "object",
  "properties": {
    "partialFailure": {
      "type": "boolean",
      "description": "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."
    },
    "operations": {
      "description": "Required. The list of operations to perform on individual experiments.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__ExperimentOperation"
      },
      "type": "array"
    },
    "validateOnly": {
      "type": "boolean",
      "description": "If true, the request is validated but not executed. Only errors are returned, not results."
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Common__MetricGoal": {
      "type": "object",
      "properties": {
        "metric": {
          "type": "string",
          "description": "The metric of the goal. For example, clicks, impressions, cost, conversions, etc.",
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "The goal of the experiment is clicks.",
            "The goal of the experiment is impressions.",
            "The goal of the experiment is cost.",
            "The goal of the experiment is conversion rate.",
            "The goal of the experiment is cost per conversion.",
            "The goal of the experiment is conversion value per cost.",
            "The goal of the experiment is avg cpc.",
            "The goal of the experiment is ctr.",
            "The goal of the experiment is incremental conversions.",
            "The goal of the experiment is completed video views.",
            "The goal of the experiment is custom algorithms.",
            "The goal of the experiment is conversions.",
            "The goal of the experiment is conversion value."
          ],
          "enum": [
            "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"
          ]
        },
        "direction": {
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "The goal of the experiment is to not change the metric.",
            "The goal of the experiment is to increate the metric.",
            "The goal of the experiment is to decrease the metric.",
            "The goal of the experiment is to either not change or increase the metric.",
            "The goal of the experiment is to either not change or decrease the metric."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "NO_CHANGE",
            "INCREASE",
            "DECREASE",
            "NO_CHANGE_OR_INCREASE",
            "NO_CHANGE_OR_DECREASE"
          ],
          "type": "string",
          "description": "The metric direction of the goal. For example, increase, decrease, no change."
        }
      },
      "description": "A metric goal for an experiment."
    },
    "GoogleAdsGoogleadsV25Common__OptimizeAssetsExperimentInfo": {
      "description": "Configuration for an Optimize Assets experiment.",
      "type": "object",
      "properties": {
        "optimizeAssetsExperimentSubtype": {
          "description": "The subtype of the Optimize Assets experiment.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "The experiment is testing adding assets to assetless retail PMax experiment.",
            "The experiment is testing adding video assets to videoless PMax experiment.",
            "The experiment is testing comparing two different sets of assets in a PMax experiment."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ADD_ASSETS_TO_ASSETLESS_RETAIL",
            "ADD_VIDEO_ASSETS_TO_VIDEOLESS",
            "COMPARE_ASSETS"
          ]
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__VideoExperimentInfo": {
      "type": "object",
      "properties": {
        "videoExperimentSubtype": {
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "The experiment is testing a Demand Gen asset experiment. User can add or delete assets from the control campaigns.",
            "The experiment is testing ads with different video assets in the experimental campaign versus the control campaign. It applies to Video Campaigns where users can add or delete assets from control campaigns.",
            "The experiment is testing video asset uplift (the performance impact of different video assets in a campaign). It applies to Video Campaigns where users can only add assets to control campaigns."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "DEMAND_GEN_ASSET",
            "ASSET",
            "ASSET_UPLIFT"
          ],
          "description": "The subtype of the Video experiment.",
          "type": "string"
        }
      },
      "description": "Configuration for a Video experiment."
    },
    "GoogleAdsGoogleadsV25Resources__Experiment": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "description": "The Advertiser-chosen status of this experiment.",
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "The experiment is enabled.",
            "The experiment has been removed.",
            "The experiment has been halted. This status can be set from ENABLED status through API.",
            "The experiment will be promoted out of experimental status.",
            "Initial status of the experiment.",
            "The experiment's campaigns are pending materialization. This status can be set from SETUP status through API.",
            "The experiment has been graduated."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ENABLED",
            "REMOVED",
            "HALTED",
            "PROMOTED",
            "SETUP",
            "INITIATED",
            "GRADUATED"
          ]
        },
        "endDate": {
          "type": "string",
          "description": "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"
        },
        "promoteStatus": {
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "NOT_STARTED",
            "IN_PROGRESS",
            "COMPLETED",
            "FAILED",
            "COMPLETED_WITH_WARNING"
          ],
          "type": "string",
          "description": "Output only. The status of the experiment promotion process.",
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "Action has not started.",
            "Action is in progress.",
            "Action has completed successfully.",
            "Action has failed.",
            "Action has completed successfully with warnings."
          ]
        },
        "optimizeAssetsExperiment": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__OptimizeAssetsExperimentInfo",
          "description": "Immutable. Details of the optimize assets experiment. Applies for experiment types: OPTIMIZE_ASSETS."
        },
        "experimentId": {
          "format": "int64",
          "description": "Output only. The ID of the experiment. Read only.",
          "type": "string"
        },
        "syncEnabled": {
          "description": "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.",
          "type": "boolean"
        },
        "description": {
          "description": "The description of the experiment. It must have a minimum length of 1 and maximum length of 2048.",
          "type": "string"
        },
        "startDate": {
          "type": "string",
          "description": "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"
        },
        "videoExperiment": {
          "description": "Immutable. Details of the video experiment. Applies for experiment types: YOUTUBE_CUSTOM.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__VideoExperimentInfo"
        },
        "resourceName": {
          "description": "Immutable. The resource name of the experiment. Experiment resource names have the form: `customers/{customer_id}/experiments/{experiment_id}`",
          "type": "string"
        },
        "suffix": {
          "type": "string",
          "description": "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": {
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "This is a DISPLAY_AND_VIDEO_360 experiment.",
            "This is an ad variation experiment.",
            "A custom experiment consisting of Video campaigns.",
            "A custom experiment consisting of display campaigns.",
            "A custom experiment consisting of search campaigns.",
            "An experiment that compares bidding strategies for display campaigns.",
            "An experiment that compares bidding strategies for search campaigns.\"",
            "An experiment that compares bidding strategies for shopping campaigns.",
            "DEPRECATED. A smart matching experiment with search campaigns.",
            "A custom experiment consisting of hotel campaigns.",
            "A custom experiment for optimizing assets.",
            "An experiment that tests how AI Max can help you engage more customers with Google AI and broad match keywords.",
            "An experiment that tests how broad match keywords can impact the number of searches your ads appear in.",
            "An experiment that tests how your Shopping campaigns perform compared to Performance Max.",
            "An experiment that compares multiple variables across one or more campaigns, tests a mix of campaign types, and more.",
            "An experiment that tests automatically created assets and lets Google AI send traffic to relevant landing pages and generate text assets to better match search queries."
          ],
          "enum": [
            "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",
            "OPTIMIZE_ASSETS",
            "ADOPT_AI_MAX",
            "ADOPT_BROAD_MATCH_KEYWORDS",
            "PMAX_REPLACEMENT_SHOPPING",
            "COMPARE_CAMPAIGNS",
            "PMAX_TEXT_CUSTOMIZATION_FINAL_URL_EXPANSION"
          ],
          "type": "string",
          "description": "Required. The product/feature that uses this experiment."
        },
        "name": {
          "description": "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.",
          "type": "string"
        },
        "longRunningOperation": {
          "description": "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.",
          "type": "string"
        },
        "goals": {
          "description": "The goals of this experiment.",
          "items": {
            "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__MetricGoal"
          },
          "type": "array"
        }
      },
      "description": "A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes."
    },
    "GoogleAdsGoogleadsV25Services__ExperimentOperation": {
      "type": "object",
      "properties": {
        "remove": {
          "description": "Remove operation: The experiment is expected to have a valid resource name, in this format: `customers/{customer_id}/experiments/{campaign_experiment_id}`",
          "type": "string"
        },
        "update": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__Experiment",
          "description": "Update operation: The experiment is expected to have a valid resource name."
        },
        "updateMask": {
          "format": "google-fieldmask",
          "type": "string",
          "description": "FieldMask that determines which resource fields are modified in an update."
        },
        "create": {
          "description": "Create operation",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__Experiment"
        }
      },
      "description": "A single operation on an experiment."
    }
  }
}