ListAudienceInsightsAttributesRequest

  • The request message for AudienceInsightsService.ListAudienceInsightsAttributes requires customer_id, dimensions[], and query_text as mandatory fields.

  • The dimensions[] field specifies the types of attributes to be returned, with supported dimensions including CATEGORY, KNOWLEDGE_GRAPH, GEO_TARGET_COUNTRY, and others.

  • The query_text field is used to filter attributes for CATEGORY or KNOWLEDGE_GRAPH dimensions, and is ignored for other dimensions.

  • The location_country_filters[] field can be used to filter SUB_COUNTRY_LOCATION attributes by country.

  • The youtube_reach_location field can be used to request potential YouTube reach estimates for specific attribute dimensions within a specified market.

Request message for AudienceInsightsService.ListAudienceInsightsAttributes.

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.