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.

Method: customers.searchAudienceInsightsAttributes

Searches for audience attributes that can be used to generate insights.

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

HTTP request

POST https://googleads.googleapis.com/v11/customers/{customerId}:searchAudienceInsightsAttributes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer.

Request body

The request body contains data with the following structure:

JSON representation
{
  "dimensions": [
    enum (AudienceInsightsDimension)
  ],
  "queryText": string,
  "customerInsightsGroup": string
}
Fields
dimensions[]

enum (AudienceInsightsDimension)

Required. The types of attributes to be returned.

queryText

string

Required. A free text query. Attributes matching or related to this string will be returned.

customerInsightsGroup

string

The name of the customer being planned for. This is a user-defined value.

Response body

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

Response message for AudienceInsightsService.ListAudienceInsightsAttributes.

JSON representation
{
  "attributes": [
    {
      object (AudienceInsightsAttributeMetadata)
    }
  ]
}
Fields
attributes[]

object (AudienceInsightsAttributeMetadata)

The attributes matching the search query.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

AudienceInsightsDimension

Possible audience dimensions for use in generating insights.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
CATEGORY A Product & Service category.
KNOWLEDGE_GRAPH A Knowledge Graph entity.

AudienceInsightsAttributeMetadata

An audience attribute, with metadata about it, returned in response to a search.

JSON representation
{
  "dimension": enum (AudienceInsightsDimension),
  "attribute": {
    object (AudienceInsightsAttribute)
  },
  "displayName": string,
  "score": number,
  "displayInfo": string
}
Fields
dimension

enum (AudienceInsightsDimension)

The type of the attribute.

attribute

object (AudienceInsightsAttribute)

The attribute itself.

displayName

string

The human-readable name of the attribute.

score

number

A relevance score for this attribute, between 0 and 1.

displayInfo

string

A string that supplements the displayName to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".

AudienceInsightsAttribute

An audience attribute that can be used to request insights about the audience.

JSON representation
{

  // Union field attribute can be only one of the following:
  "ageRange": {
    object (AgeRangeInfo)
  },
  "gender": {
    object (GenderInfo)
  },
  "location": {
    object (LocationInfo)
  },
  "userInterest": {
    object (UserInterestInfo)
  },
  "entity": {
    object (AudienceInsightsEntity)
  },
  "category": {
    object (AudienceInsightsCategory)
  }
  // End of list of possible types for union field attribute.
}
Fields
Union field attribute. An audience attribute. attribute can be only one of the following:
ageRange

object (AgeRangeInfo)

An audience attribute defined by an age range.

gender

object (GenderInfo)

An audience attribute defined by a gender.

location

object (LocationInfo)

An audience attribute defiend by a geographic location.

userInterest

object (UserInterestInfo)

An Affinity or In-Market audience.

entity

object (AudienceInsightsEntity)

An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.

category

object (AudienceInsightsCategory)

An audience attribute defined by interest in a Product & Service category.