Method: listPlannableUserInterests

Returns the list of plannable user interests. A plannable user interest is one that can be targeted in a reach forecast using ReachPlanService.GenerateReachForecast.

List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError ListOperationError QuotaError RequestError StringLengthError

HTTP request

POST https://googleads.googleapis.com/v21:listPlannableUserInterests

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "customerId": string,
  "userInterestTaxonomyTypes": [
    enum (UserInterestTaxonomyType)
  ],
  "reachApplicationInfo": {
    object (AdditionalApplicationInfo)
  },
  "nameQuery": string,
  "pathQuery": string
}
Fields
customerId

string

Required. The ID of the customer.
userInterestTaxonomyTypes[]

enum (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.
reachApplicationInfo

object (AdditionalApplicationInfo)

Optional. Additional information on the application issuing the request.
nameQuery

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.
pathQuery

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.

Response body

Response message for ReachPlanService.ListPlannableUserInterests.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "plannableUserInterests": [
    {
      object (PlannableUserInterest)
    }
  ]
}
Fields
plannableUserInterests[]

object (PlannableUserInterest)

The list of plannable user interests.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

PlannableUserInterest

A plannable user interest that can be targeted in a reach forecast using ReachPlanService.GenerateReachForecast.

JSON representation 
{
  "userInterest": {
    object (UserInterestInfo)
  },
  "userInterestType": enum (UserInterestTaxonomyType),
  "userInterestDisplayName": string,
  "userInterestPath": string
}
Fields
userInterest

object (UserInterestInfo)

The user interest id.
userInterestType

enum (UserInterestTaxonomyType)

The user interest type.
userInterestDisplayName

string

The user interest display name. For example, "Autos & Vehicles"
userInterestPath

string

The user interest path. For example, "/Autos & Vehicles/Motor Vehicles/Motor Vehicles by Type/Off-Road Vehicles"