ListPlannableUserInterestsRequest

  • The ListPlannableUserInterests request message is used to retrieve plannable user interests for a customer.

  • The request requires a customer_id and can optionally filter results by user_interest_taxonomy_types, reach_application_info, name_query, or path_query.

  • Supported user interest types for filtering are AFFINITY and IN_MARKET.

Request message for ReachPlanService.ListPlannableUserInterests.

Fields

customer_id

string

Required. The ID of the customer.

user_interest_taxonomy_types[]

UserInterestTaxonomyType

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.

reach_application_info

AdditionalApplicationInfo

Optional. Additional information on the application issuing the request.

name_query

string

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.

path_query

string

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.