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/v17/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,
  "locationCountryFilters": [
    {
      object (LocationInfo)
    }
  ],
  "youtubeReachLocation": {
    object (LocationInfo)
  }
}
Fields
dimensions[]

enum (AudienceInsightsDimension)

Required. The types of attributes to be returned.
queryText

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

string

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

object (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.
youtubeReachLocation

object (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.

Response body

Response message for AudienceInsightsService.ListAudienceInsightsAttributes.

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

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.