ListAudienceInsightsAttributesRequest

  • The content describes the request message for the ListAudienceInsightsAttributes service.

  • The request requires a customer_id, the types of dimensions to return, and a query_text.

  • Optional fields include customer_insights_group, insights_application_info, location_country_filters, and youtube_reach_location.

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, DEVICE, GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_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.

insights_application_info

AdditionalApplicationInfo

Optional. Additional information on the application issuing the request.

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.