MutateAdGroupsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-mutate-ad-groups-request-schema.json",
  "title": "MutateAdGroupsRequest",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-ad-groups-api-openapi.yml#/components/schemas/MutateAdGroupsRequest",
  "type": "object",
  "required": [
    "operations"
  ],
  "properties": {
    "operations": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AdGroupOperation"
      }
    },
    "partialFailure": {
      "type": "boolean"
    },
    "validateOnly": {
      "type": "boolean"
    }
  },
  "$defs": {
    "AdGroup": {
      "type": "object",
      "description": "An ad group containing a set of ads and targeting criteria within a campaign.",
      "properties": {
        "resourceName": {
          "type": "string",
          "description": "Resource name of the ad group, e.g. customers/{customerId}/adGroups/{adGroupId}."
        },
        "id": {
          "type": "integer",
          "format": "int64",
          "description": "The unique ID of the ad group."
        },
        "name": {
          "type": "string",
          "description": "The name of the ad group."
        },
        "status": {
          "type": "string",
          "enum": [
            "ENABLED",
            "PAUSED",
            "REMOVED",
            "UNKNOWN",
            "UNSPECIFIED"
          ],
          "description": "The status of the ad group."
        },
        "campaign": {
          "type": "string",
          "description": "Resource name of the campaign this ad group belongs to."
        },
        "type": {
          "type": "string",
          "enum": [
            "SEARCH_STANDARD",
            "DISPLAY_STANDARD",
            "SHOPPING_PRODUCT_ADS",
            "VIDEO_TRUE_VIEW_IN_STREAM",
            "VIDEO_BUMPER",
            "HOTEL_ADS",
            "SHOPPING_SMART_ADS",
            "SMART_CAMPAIGN_ADS",
            "UNKNOWN",
            "UNSPECIFIED"
          ],
          "description": "The type of the ad group."
        },
        "cpcBidMicros": {
          "type": "integer",
          "format": "int64",
          "description": "Maximum CPC bid in micros at the ad group level."
        },
        "cpmBidMicros": {
          "type": "integer",
          "format": "int64",
          "description": "Maximum CPM bid in micros at the ad group level."
        },
        "targetCpaMicros": {
          "type": "integer",
          "format": "int64",
          "description": "Target CPA in micros at the ad group level."
        },
        "effectiveTargetCpaMicros": {
          "type": "integer",
          "format": "int64",
          "description": "Effective target CPA considering campaign-level settings."
        },
        "effectiveTargetRoas": {
          "type": "number",
          "description": "Effective target ROAS considering campaign-level settings."
        },
        "adRotationMode": {
          "type": "string",
          "enum": [
            "OPTIMIZE",
            "ROTATE_FOREVER",
            "UNKNOWN",
            "UNSPECIFIED"
          ],
          "description": "Ad rotation mode for ads within this ad group."
        }
      }
    },
    "AdGroupOperation": {
      "type": "object",
      "properties": {
        "create": {
          "$ref": "#/$defs/AdGroup"
        },
        "update": {
          "$ref": "#/$defs/AdGroup"
        },
        "remove": {
          "type": "string"
        },
        "updateMask": {
          "type": "string"
        }
      }
    }
  }
}