Method: customers.generateSuggestedTargetingInsights

Returns a collection of targeting insights (e.g. targetable audiences) that are relevant to the requested audience.

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

HTTP request

POST https://googleads.googleapis.com/v18/customers/{customerId}:generateSuggestedTargetingInsights

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 
{
  "customerInsightsGroup": string,

  // Union field audience_input can be only one of the following:
  "audienceDefinition": {
    object (InsightsAudienceDefinition)
  },
  "audienceDescription": {
    object (InsightsAudienceDescription)
  }
  // End of list of possible types for union field audience_input.
}
Fields
customerInsightsGroup

string

Optional. The name of the customer being planned for. This is a user-defined value.
Union field audience_input. Required. The audience to get suggestions for. audience_input can be only one of the following:
audienceDefinition

object (InsightsAudienceDefinition)

Provide a seed audience to get suggestions for.
audienceDescription

object (InsightsAudienceDescription)

Provide a text description of an audience to get AI-generated targeting suggestions. This can take around 5 or more seconds to complete.

Response body

Response message for AudienceInsightsService.GenerateSuggestedTargetingInsights.

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

JSON representation 
{
  "suggestions": [
    {
      object (TargetingSuggestionMetrics)
    }
  ]
}
Fields
suggestions[]

object (TargetingSuggestionMetrics)

Suggested insights for targetable audiences.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

InsightsAudienceDefinition

A structured definition of the audience of interest for which insights are being requested in AudienceInsightsService.

JSON representation 
{
  "audience": {
    object (InsightsAudience)
  },
  "baselineAudience": {
    object (InsightsAudience)
  },
  "dataMonth": string
}
Fields
audience

object (InsightsAudience)

Required. The audience of interest for which insights are being requested.
baselineAudience

object (InsightsAudience)

Optional. The baseline audience. The default, if unspecified, is all people in the same country as the audience of interest.
dataMonth

string

Optional. The one-month range of historical data to use for insights, in the format "yyyy-mm". If unset, insights will be returned for the last thirty days of data.

InsightsAudienceDescription

A text description of the audience of interest for which insights are being requested in AudienceInsightsService.

JSON representation 
{
  "countryLocations": [
    {
      object (LocationInfo)
    }
  ],
  "audienceDescription": string,
  "marketingObjective": enum (AudienceInsightsMarketingObjective)
}
Fields
countryLocations[]

object (LocationInfo)

Required. The countries for the audience.
audienceDescription

string

Required. An English language text description of an audience to get suggestions for. Maximum length is 2000 characters. For example, "Women in their 30s who love to travel".
marketingObjective

enum (AudienceInsightsMarketingObjective)

Optional. An optional marketing objective which will influence the type of suggestions produced. AWARENESS will provide affinity audience segments, while CONSIDERATION will provide in-market audience segments. Leaving it unset will provide both.

AudienceInsightsMarketingObjective

Describes the overall objective for defining an audience for insights.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
AWARENESS The objective is to increase awareness of a brand or product among relevant audiences.
CONSIDERATION The objective is to encourage potential customers to consider your brand or products when they're researching or shopping for product.