- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- AudienceInsightsDimension
- AudienceInsightsAttributeMetadata
- AudienceInsightsAttribute
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 |
Required. The ID of the customer. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"dimensions": [
enum ( |
Fields | |
---|---|
dimensions[] |
Required. The types of attributes to be returned. |
queryText |
Required. A free text query. Attributes matching or related to this string will be returned. |
customerInsightsGroup |
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 ( |
Fields | |
---|---|
attributes[] |
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 ( |
Fields | |
---|---|
dimension |
The type of the attribute. |
attribute |
The attribute itself. |
displayName |
The human-readable name of the attribute. |
score |
A relevance score for this attribute, between 0 and 1. |
displayInfo |
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 |
Fields | |
---|---|
Union field attribute . An audience attribute. attribute can be only one of the following: |
|
ageRange |
An audience attribute defined by an age range. |
gender |
An audience attribute defined by a gender. |
location |
An audience attribute defiend by a geographic location. |
userInterest |
An Affinity or In-Market audience. |
entity |
An audience attribute defined by interest in a topic represented by a Knowledge Graph entity. |
category |
An audience attribute defined by interest in a Product & Service category. |