Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.userInterests

Resource: UserInterest

A user interest: a particular interest-based vertical to be targeted.

JSON representation
{
  "resourceName": string,
  "taxonomyType": enum (UserInterestTaxonomyType),
  "availabilities": [
    {
      object (CriterionCategoryAvailability)
    }
  ],
  "userInterestId": string,
  "name": string,
  "userInterestParent": string,
  "launchedToAll": boolean
}
Fields
resourceName

string

Output only. The resource name of the user interest. User interest resource names have the form:

customers/{customerId}/userInterests/{userInterestId}

taxonomyType

enum (UserInterestTaxonomyType)

Output only. Taxonomy type of the user interest.

availabilities[]

object (CriterionCategoryAvailability)

Output only. Availability information of the user interest.

userInterestId

string (int64 format)

Output only. The ID of the user interest.

name

string

Output only. The name of the user interest.

userInterestParent

string

Output only. The parent of the user interest.

launchedToAll

boolean

Output only. True if the user interest is launched to all channels and locales.

UserInterestTaxonomyType

Enum containing the possible UserInterestTaxonomyTypes.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AFFINITY The affinity for this user interest.
IN_MARKET The market for this user interest.
MOBILE_APP_INSTALL_USER Users known to have installed applications in the specified categories.
VERTICAL_GEO The geographical location of the interest-based vertical.
NEW_SMART_PHONE_USER User interest criteria for new smart phone users.

Methods

get

Returns the requested user interest in full detail

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError