GoogleAdsGoogleadsV25Services__MutateCustomInterestsRequest

{
  "$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-custom-interests-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateCustomInterestsRequest",
  "description": "Request message for CustomInterestService.MutateCustomInterests.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-custominterests-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateCustomInterestsRequest",
  "type": "object",
  "properties": {
    "operations": {
      "description": "Required. The list of operations to perform on individual custom interests.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__CustomInterestOperation"
      },
      "type": "array"
    },
    "validateOnly": {
      "description": "If true, the request is validated but not executed. Only errors are returned, not results.",
      "type": "boolean"
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Resources__CustomInterest": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT. By default the type is set to CUSTOM_AFFINITY.",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Allows brand advertisers to define custom affinity audience lists.",
            "Allows advertisers to define custom intent audience lists."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "CUSTOM_AFFINITY",
            "CUSTOM_INTENT"
          ]
        },
        "id": {
          "format": "int64",
          "type": "string",
          "description": "Output only. Id of the custom interest."
        },
        "status": {
          "description": "Status of this custom interest. Indicates whether the custom interest is enabled or removed.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Enabled status - custom interest is enabled and can be targeted to.",
            "Removed status - custom interest is removed and cannot be used for targeting."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ENABLED",
            "REMOVED"
          ]
        },
        "description": {
          "type": "string",
          "description": "Description of this custom interest audience."
        },
        "resourceName": {
          "type": "string",
          "description": "Immutable. The resource name of the custom interest. Custom interest resource names have the form: `customers/{customer_id}/customInterests/{custom_interest_id}`"
        },
        "members": {
          "type": "array",
          "description": "List of custom interest members that this custom interest is composed of. Members can be added during CustomInterest creation. If members are presented in UPDATE operation, existing members will be overridden.",
          "items": {
            "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__CustomInterestMember"
          }
        },
        "name": {
          "type": "string",
          "description": "Name of the custom interest. It should be unique across the same custom affinity audience. This field is required for create operations."
        }
      },
      "description": "A custom interest. This is a list of users by interest."
    },
    "GoogleAdsGoogleadsV25Resources__CustomInterestMember": {
      "description": "A member of custom interest audience. A member can be a keyword or url. It is immutable, that is, it can only be created or removed but not changed.",
      "type": "object",
      "properties": {
        "parameter": {
          "type": "string",
          "description": "Keyword text when member_type is KEYWORD or URL string when member_type is URL."
        },
        "memberType": {
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Custom interest member type KEYWORD.",
            "Custom interest member type URL."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "KEYWORD",
            "URL"
          ],
          "description": "The type of custom interest member, KEYWORD or URL.",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Services__CustomInterestOperation": {
      "type": "object",
      "properties": {
        "updateMask": {
          "format": "google-fieldmask",
          "description": "FieldMask that determines which resource fields are modified in an update.",
          "type": "string"
        },
        "create": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__CustomInterest",
          "description": "Create operation: No resource name is expected for the new custom interest."
        },
        "update": {
          "description": "Update operation: The custom interest is expected to have a valid resource name.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__CustomInterest"
        }
      },
      "description": "A single operation (create, update) on a custom interest."
    }
  }
}