GoogleAdsGoogleadsV25Services__ListAudienceInsightsAttributesRequest

{
  "$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-audience-insights-attributes-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__ListAudienceInsightsAttributesRequest",
  "description": "Request message for AudienceInsightsService.ListAudienceInsightsAttributes.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__ListAudienceInsightsAttributesRequest",
  "type": "object",
  "properties": {
    "customerInsightsGroup": {
      "description": "The name of the customer being planned for. This is a user-defined value.",
      "type": "string"
    },
    "insightsApplicationInfo": {
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__AdditionalApplicationInfo",
      "description": "Optional. Additional information on the application issuing the request."
    },
    "queryText": {
      "description": "Required. A free text query. If the requested dimensions include Attributes CATEGORY or KNOWLEDGE_GRAPH, then the attributes returned for those dimensions will match or be related to this string. For other dimensions, this field is ignored and all available attributes are returned. Example: \"Millennials interested in the World Cup and soccer.\"",
      "type": "string"
    },
    "dimensions": {
      "type": "array",
      "description": "Required. The types of attributes to be returned. Supported dimensions are CATEGORY, KNOWLEDGE_GRAPH, DEVICE, GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_LINEUP, AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST, PARENTAL_STATUS, INCOME_RANGE, AGE_RANGE, GENDER, and USER_LIST.",
      "items": {
        "type": "string",
        "x-enumDescriptions": [
          "Not specified.",
          "The value is unknown in this version.",
          "A Product & Service category.",
          "A Knowledge Graph entity.",
          "A country, represented by a geo target.",
          "A geographic location within a country.",
          "A YouTube channel.",
          "An Affinity UserInterest.",
          "An In-Market UserInterest.",
          "A Parental Status value (parent, or not a parent).",
          "A household income percentile range.",
          "An age range.",
          "A gender.",
          "A YouTube video.",
          "A device type, such as Mobile, Desktop, Tablet, and Connected TV.",
          "A YouTube Lineup.",
          "A User List.",
          "A Life Event UserInterest."
        ],
        "enum": [
          "UNSPECIFIED",
          "UNKNOWN",
          "CATEGORY",
          "KNOWLEDGE_GRAPH",
          "GEO_TARGET_COUNTRY",
          "SUB_COUNTRY_LOCATION",
          "YOUTUBE_CHANNEL",
          "AFFINITY_USER_INTEREST",
          "IN_MARKET_USER_INTEREST",
          "PARENTAL_STATUS",
          "INCOME_RANGE",
          "AGE_RANGE",
          "GENDER",
          "YOUTUBE_VIDEO",
          "DEVICE",
          "YOUTUBE_LINEUP",
          "USER_LIST",
          "LIFE_EVENT_USER_INTEREST"
        ]
      }
    },
    "youtubeReachLocation": {
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__LocationInfo",
      "description": "If present, potential YouTube reach estimates within the specified market will be returned for attributes for which they are available. Reach is only available for the AGE_RANGE, GENDER, AFFINITY_USER_INTEREST and IN_MARKET_USER_INTEREST dimensions, and may not be available for every attribute of those dimensions in every market."
    },
    "knowledgeGraphEntitySearchOptions": {
      "description": "Optional. Additional search options for Knowledge Graph Entities.",
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__KnowledgeGraphEntitySearchOptions"
    },
    "locationCountryFilters": {
      "description": "If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and this field is present, then the SUB_COUNTRY_LOCATION attributes returned will be located in these countries. If this field is absent, then location attributes are not filtered by country. Setting this field when SUB_COUNTRY_LOCATION attributes are not requested will return an error.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__LocationInfo"
      },
      "type": "array"
    }
  },
  "$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"
          ]
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__LocationInfo": {
      "type": "object",
      "properties": {
        "geoTargetConstant": {
          "type": "string",
          "description": "The geo target constant resource name."
        }
      },
      "description": "A location criterion."
    },
    "GoogleAdsGoogleadsV25Services_KnowledgeGraphEntitySearchOptions_SearchFilter": {
      "type": "object",
      "properties": {
        "entityCapabilityFilters": {
          "description": "Optional. A list of entity capability filters supported for ContentCreatorInsightsService. If set, returns entities relevant to the `query_text` and supported for any of the specified capabilities. For example, entity_capability_filters[0] and entity_capability_filters[1] are combined with OR so that entities supported for either capability are returned.",
          "items": {
            "x-enumDescriptions": [
              "Not specified.",
              "The value is unknown in this version.",
              "An entity that is supported to use as a trending topic in ContentCreatorInsightsService.GenerateTrendingInsights.",
              "An entity that is supported to use as a creator attribute in ContentCreatorInsightsService.GenerateCreatorInsights in field GenerateCreatorInsightsRequest.search_attributes.creator_attributes.",
              "An entity that is supported to use as a topic in ContentCreatorInsightsService.GenerateCreatorInsights in field GenerateCreatorInsightsRequest.search_topics."
            ],
            "enum": [
              "UNSPECIFIED",
              "UNKNOWN",
              "CONTENT_TRENDING_INSIGHTS",
              "CREATOR_ATTRIBUTE",
              "CREATOR_TOPIC_INSIGHTS"
            ],
            "type": "string"
          },
          "type": "array"
        }
      },
      "description": "Filter options for Knowledge Graph Entities."
    },
    "GoogleAdsGoogleadsV25Services__KnowledgeGraphEntitySearchOptions": {
      "description": "Search options for Knowledge Graph Entities.",
      "type": "object",
      "properties": {
        "searchFilter": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Services_KnowledgeGraphEntitySearchOptions_SearchFilter",
          "description": "Optional. Filter options for narrowing down the scope of Knowledge Graph Entities to retrieve."
        },
        "getAllCreatorAttributes": {
          "type": "boolean",
          "description": "Optional. When true, retrieves all available Knowledge Graph Entities tagged with CREATOR_ATTRIBUTE. KNOWLEDGE_GRAPH must be included in `ListAudienceInsightsAttributesRequest.dimensions` and the `query_text` must be empty. This option cannot be used with search_filter. `search_filter` respects the `query_text` when retrieving relevant entities while this option returns all creator attributes available to use as an input."
        }
      }
    }
  }
}