GoogleAdsGoogleadsV25Services__MutateAdGroupCustomizersRequest

{
  "$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-ad-group-customizers-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateAdGroupCustomizersRequest",
  "description": "Request message for AdGroupCustomizerService.MutateAdGroupCustomizers.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-adgroupcustomizers-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateAdGroupCustomizersRequest",
  "type": "object",
  "properties": {
    "validateOnly": {
      "type": "boolean",
      "description": "If true, the request is validated but not executed. Only errors are returned, not results."
    },
    "responseContentType": {
      "description": "The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.",
      "type": "string",
      "x-enumDescriptions": [
        "Not specified. Will return the resource name only in the response.",
        "The mutate response will be the resource name.",
        "The mutate response will contain the resource name and the resource with mutable fields if possible. Otherwise, only the resource name will be returned."
      ],
      "enum": [
        "UNSPECIFIED",
        "RESOURCE_NAME_ONLY",
        "MUTABLE_RESOURCE"
      ]
    },
    "operations": {
      "description": "Required. The list of operations to perform on individual ad group customizers.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__AdGroupCustomizerOperation"
      },
      "type": "array"
    },
    "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": {
    "GoogleAdsGoogleadsV25Common__CustomizerValue": {
      "description": "A customizer value that is referenced in customizer linkage entities like CustomerCustomizer, CampaignCustomizer, etc.",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Required. The data type for the customizer value. It must match the attribute type. The string_value content must match the constraints associated with the type.",
          "x-enumDescriptions": [
            "The status has not been specified.",
            "The received value is not known in this version.",
            "Text customizer.",
            "Number customizer.",
            "Price customizer consisting of a number and a currency.",
            "Percentage customizer consisting of a number and a '%'."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "TEXT",
            "NUMBER",
            "PRICE",
            "PERCENT"
          ]
        },
        "stringValue": {
          "description": "Required. Value to insert in creative text. Customizer values of all types are stored as string to make formatting unambiguous.",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Resources__AdGroupCustomizer": {
      "type": "object",
      "properties": {
        "resourceName": {
          "type": "string",
          "description": "Immutable. The resource name of the ad group customizer. Ad group customizer resource names have the form: `customers/{customer_id}/adGroupCustomizers/{ad_group_id}~{customizer_attribute_id}`"
        },
        "value": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__CustomizerValue",
          "description": "Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute."
        },
        "customizerAttribute": {
          "description": "Required. Immutable. The customizer attribute which is linked to the ad group.",
          "type": "string"
        },
        "adGroup": {
          "description": "Immutable. The ad group to which the customizer attribute is linked.",
          "type": "string"
        },
        "status": {
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ENABLED",
            "REMOVED"
          ],
          "description": "Output only. The status of the ad group customizer.",
          "type": "string",
          "x-enumDescriptions": [
            "The status has not been specified.",
            "The received value is not known in this version.",
            "The customizer value is enabled.",
            "The customizer value is removed."
          ]
        }
      },
      "description": "A customizer value for the associated CustomizerAttribute at the AdGroup level."
    },
    "GoogleAdsGoogleadsV25Services__AdGroupCustomizerOperation": {
      "type": "object",
      "properties": {
        "create": {
          "description": "Create operation: No resource name is expected for the new ad group customizer",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__AdGroupCustomizer"
        },
        "remove": {
          "description": "Remove operation: A resource name for the removed ad group customizer is expected, in this format: `customers/{customer_id}/adGroupCustomizers/{ad_group_id}~{customizer_attribute_id}`",
          "type": "string"
        }
      },
      "description": "A single operation (create, remove) on a customizer attribute."
    }
  }
}