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/v16/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 
{
  "audience": {
    object (InsightsAudience)
  },
  "baselineAudience": {
    object (InsightsAudience)
  },
  "dataMonth": string,
  "customerInsightsGroup": 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.
customerInsightsGroup

string

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

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.

TargetingSuggestionMetrics

A suggested targetable audience relevant to the requested audience.

JSON representation 
{
  "locations": [
    {
      object (AudienceInsightsAttributeMetadata)
    }
  ],
  "ageRanges": [
    {
      object (AgeRangeInfo)
    }
  ],
  "gender": {
    object (GenderInfo)
  },
  "userInterests": [
    {
      object (AudienceInsightsAttributeMetadata)
    }
  ],
  "coverage": number,
  "index": number,
  "potentialYoutubeReach": string
}
Fields
locations[]

object (AudienceInsightsAttributeMetadata)

Suggested location targeting. These attributes all have dimension GEO_TARGET_COUNTRY or SUB_COUNTRY_LOCATION
ageRanges[]

object (AgeRangeInfo)

Suggested age targeting; may be empty indicating no age targeting.
gender

object (GenderInfo)

Suggested gender targeting. If present, this attribute has dimension GENDER.
userInterests[]

object (AudienceInsightsAttributeMetadata)

Suggested audience segments to target. These attributes all have dimension AFFINITY_USER_INTEREST or IN_MARKET_USER_INTEREST
coverage

number

The fraction (from 0 to 1 inclusive) of the requested audience that can be reached using the suggested targeting.
index

number

The ratio of coverage to the coverage of the baseline audience or zero if this ratio is undefined or is not meaningful.
potentialYoutubeReach

string (int64 format)

The approximate estimated number of people that can be reached on YouTube using this targeting.