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/v12/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)
    }
  ]
}
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.

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.

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.