Interested in sharing your feedback about the Google Ads API?
Sign up to be invited to participate in user research!
ListAudienceInsightsAttributesRequest
Stay organized with collections
Save and categorize content based on your preferences.
Fields |
customer_id
|
string
Required. The ID of the customer.
|
dimensions[]
|
AudienceInsightsDimension
Required. The types of attributes to be returned. Supported dimensions are CATEGORY, KNOWLEDGE_GRAPH, GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_DYNAMIC_LINEUP, AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS, INCOME_RANGE, AGE_RANGE, and GENDER.
|
query_text
|
string
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.
|
customer_insights_group
|
string
The name of the customer being planned for. This is a user-defined value.
|
location_country_filters[]
|
LocationInfo
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.
|
youtube_reach_location
|
LocationInfo
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-10 UTC."],[[["The `ListAudienceInsightsAttributes` request retrieves available attributes for audience insights, such as age range, gender, or interests, based on specified criteria."],["This request requires a customer ID, the desired attribute dimensions, and a query text for relevant attribute filtering."],["You can optionally specify the customer insights group, location country filters, and YouTube reach location for further refinement."],["If requesting SUB_COUNTRY_LOCATION attributes, you must specify `location_country_filters`, and for YouTube reach estimates, use `youtube_reach_location`."]]],["The core function of `AudienceInsightsService.ListAudienceInsightsAttributes` involves retrieving audience attributes based on specified parameters. Key actions include providing a `customer_id`, defining the `dimensions` of interest (e.g., CATEGORY, AGE_RANGE), and supplying a `query_text` for filtering attributes. Optionally, a `customer_insights_group` can be defined. Location can be refined using `location_country_filters`, and estimated YouTube reach data is retrievable with `youtube_reach_location`, given the supported dimensions.\n"]]