GoogleAdsGoogleadsV25Services__MutateKeywordPlanAdGroupsRequest

{
  "$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-keyword-plan-ad-groups-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateKeywordPlanAdGroupsRequest",
  "description": "Request message for KeywordPlanAdGroupService.MutateKeywordPlanAdGroups.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-keywordplanadgroups-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateKeywordPlanAdGroupsRequest",
  "type": "object",
  "properties": {
    "operations": {
      "type": "array",
      "description": "Required. The list of operations to perform on individual Keyword Plan ad groups.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__KeywordPlanAdGroupOperation"
      }
    },
    "validateOnly": {
      "description": "If true, the request is validated but not executed. Only errors are returned, not results.",
      "type": "boolean"
    },
    "partialFailure": {
      "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.",
      "type": "boolean"
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Resources__KeywordPlanAdGroup": {
      "description": "A Keyword Planner ad group. Max number of keyword plan ad groups per plan: 200.",
      "type": "object",
      "properties": {
        "name": {
          "description": "The name of the keyword plan ad group. This field is required and should not be empty when creating keyword plan ad group.",
          "type": "string"
        },
        "cpcBidMicros": {
          "description": "A default ad group max cpc bid in micros in account currency for all biddable keywords under the keyword plan ad group. If not set, will inherit from parent campaign.",
          "type": "string",
          "format": "int64"
        },
        "resourceName": {
          "type": "string",
          "description": "Immutable. The resource name of the Keyword Planner ad group. KeywordPlanAdGroup resource names have the form: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`"
        },
        "id": {
          "format": "int64",
          "type": "string",
          "description": "Output only. The ID of the keyword plan ad group."
        },
        "keywordPlanCampaign": {
          "description": "The keyword plan campaign to which this ad group belongs.",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Services__KeywordPlanAdGroupOperation": {
      "type": "object",
      "properties": {
        "remove": {
          "type": "string",
          "description": "Remove operation: A resource name for the removed Keyword Plan ad group is expected, in this format: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`"
        },
        "updateMask": {
          "description": "The FieldMask that determines which resource fields are modified in an update.",
          "type": "string",
          "format": "google-fieldmask"
        },
        "create": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__KeywordPlanAdGroup",
          "description": "Create operation: No resource name is expected for the new Keyword Plan ad group."
        },
        "update": {
          "description": "Update operation: The Keyword Plan ad group is expected to have a valid resource name.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__KeywordPlanAdGroup"
        }
      },
      "description": "A single operation (create, update, remove) on a Keyword Plan ad group."
    }
  }
}