GoogleAdsGoogleadsV25Services__MutateUserListCustomerTypesRequest

{
  "$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-user-list-customer-types-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateUserListCustomerTypesRequest",
  "description": "Request message for UserListCustomerTypeService.MutateUserListCustomerTypes.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-userlistcustomertypes-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateUserListCustomerTypesRequest",
  "type": "object",
  "properties": {
    "validateOnly": {
      "description": "Optional. If true, the request is validated but not executed. Only errors are returned, not results.",
      "type": "boolean"
    },
    "operations": {
      "type": "array",
      "description": "Required. The list of operations to perform on the user list customer types.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__UserListCustomerTypeOperation"
      }
    },
    "partialFailure": {
      "description": "Optional. 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__UserListCustomerType": {
      "description": "A user list customer type",
      "type": "object",
      "properties": {
        "resourceName": {
          "description": "Immutable. The resource name of the user list customer type User list customer type resource names have the form: `customers/{customer_id}/userListCustomerTypes/{user_list_id}~{customer_type_category}`",
          "type": "string"
        },
        "customerTypeCategory": {
          "description": "Immutable. The user list customer type category",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "Unknown type.",
            "Customer type category for all customers.",
            "Customer type category for all purchasers.",
            "Customer type category for high value purchasers.",
            "Customer type category for disengaged purchasers.",
            "Customer type category for qualified leads.",
            "Customer type category for converted leads.",
            "Customer type category for paid subscribers.",
            "Customer type category for cart abandoners.",
            "Customer type category for loyalty tier 1 members.",
            "Customer type category for loyalty tier 2 members.",
            "Customer type category for loyalty tier 3 members.",
            "Customer type category for loyalty tier 4 members.",
            "Customer type category for loyalty tier 5 members.",
            "Customer type category for loyalty tier 6 members.",
            "Customer type category for loyalty tier 7 members."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ALL_CUSTOMERS",
            "PURCHASERS",
            "HIGH_VALUE_CUSTOMERS",
            "DISENGAGED_CUSTOMERS",
            "QUALIFIED_LEADS",
            "CONVERTED_LEADS",
            "PAID_SUBSCRIBERS",
            "CART_ABANDONERS",
            "LOYALTY_TIER_1_MEMBERS",
            "LOYALTY_TIER_2_MEMBERS",
            "LOYALTY_TIER_3_MEMBERS",
            "LOYALTY_TIER_4_MEMBERS",
            "LOYALTY_TIER_5_MEMBERS",
            "LOYALTY_TIER_6_MEMBERS",
            "LOYALTY_TIER_7_MEMBERS"
          ]
        },
        "userList": {
          "description": "Immutable. The resource name for the user list this user list customer type is associated with",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Services__UserListCustomerTypeOperation": {
      "type": "object",
      "properties": {
        "create": {
          "description": "Attach a user list customer type to a user list. No resource name is expected for the new user list customer type.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__UserListCustomerType"
        },
        "remove": {
          "description": "Remove an existing user list customer type. A resource name for the removed user list customer type is expected, in this format: `customers/{customer_id}/userListCustomerTypes/{user_list_id}~{customer_type_category}`",
          "type": "string"
        }
      },
      "description": "A single mutate operation on the user list customer type."
    }
  }
}