GoogleAdsGoogleadsV25Services__ListPlannableUserInterestsRequest

{
  "$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-list-plannable-user-interests-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__ListPlannableUserInterestsRequest",
  "description": "Request message for ReachPlanService.ListPlannableUserInterests.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-v25-listplannableuserinterests-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__ListPlannableUserInterestsRequest",
  "type": "object",
  "properties": {
    "nameQuery": {
      "type": "string",
      "description": "A filter by user interest name. If set, only user interests with a name containing the literal string (case insensitive) in the filter will be returned. Maximum length is 200 characters."
    },
    "pathQuery": {
      "description": "A filter by user interest path. If set, only user interests with a path containing the literal string (case insensitive) in the filter will be returned. Maximum length is 200 characters.",
      "type": "string"
    },
    "userInterestTaxonomyTypes": {
      "description": "Optional. A filter by user interest type. If set, only user interests with a type listed in the filter will be returned. If not set, user interests of all supported types will be returned. Supported user interest types are AFFINITY and IN_MARKET. Each type must be specified at most once.",
      "items": {
        "x-enumDescriptions": [
          "Not specified.",
          "Used for return value only. Represents value unknown in this version.",
          "The affinity for this user interest.",
          "The market for this user interest.",
          "Users known to have installed applications in the specified categories.",
          "The geographical location of the interest-based vertical.",
          "User interest criteria for new smart phone users."
        ],
        "enum": [
          "UNSPECIFIED",
          "UNKNOWN",
          "AFFINITY",
          "IN_MARKET",
          "MOBILE_APP_INSTALL_USER",
          "VERTICAL_GEO",
          "NEW_SMART_PHONE_USER"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "customerId": {
      "description": "Required. The ID of the customer.",
      "type": "string"
    },
    "reachApplicationInfo": {
      "description": "Optional. Additional information on the application issuing the request.",
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AdditionalApplicationInfo"
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Common__AdditionalApplicationInfo": {
      "description": "Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs.",
      "type": "object",
      "properties": {
        "applicationId": {
          "description": "The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.",
          "type": "string"
        },
        "applicationInstance": {
          "description": "The instance type of the application sending the request.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "The instance is for development and testing purposes.",
            "The instance is for production purposes."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "DEVELOPMENT_AND_TESTING",
            "PRODUCTION"
          ]
        }
      }
    }
  }
}