Method: customers.generateAdGroupThemes

Returns a list of suggested AdGroups and suggested modifications (text, match type) for the given keywords.

List of thrown errors: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError QuotaError RequestError

HTTP request

POST https://googleads.googleapis.com/v16/customers/{customerId}:generateAdGroupThemes

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 
{
  "keywords": [
    string
  ],
  "adGroups": [
    string
  ]
}
Fields
keywords[]

string

Required. A list of keywords to group into the provided AdGroups.
adGroups[]

string

Required. A list of resource names of AdGroups to group keywords into. Resource name format: customers/{customerId}/adGroups/{adGroupId}

Response body

Response message for KeywordPlanIdeaService.GenerateAdGroupThemes.

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

JSON representation 
{
  "adGroupKeywordSuggestions": [
    {
      object (AdGroupKeywordSuggestion)
    }
  ],
  "unusableAdGroups": [
    {
      object (UnusableAdGroup)
    }
  ]
}
Fields
adGroupKeywordSuggestions[]

object (AdGroupKeywordSuggestion)

A list of suggested AdGroup/keyword pairings.
unusableAdGroups[]

object (UnusableAdGroup)

A list of provided AdGroups that could not be used as suggestions.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

AdGroupKeywordSuggestion

The suggested text and AdGroup/Campaign pairing for a given keyword.

JSON representation 
{
  "keywordText": string,
  "suggestedKeywordText": string,
  "suggestedMatchType": enum (KeywordMatchType),
  "suggestedAdGroup": string,
  "suggestedCampaign": string
}
Fields
keywordText

string

The original keyword text.
suggestedKeywordText

string

The normalized version of keywordText for BROAD/EXACT/PHRASE suggestions.
suggestedMatchType

enum (KeywordMatchType)

The suggested keyword match type.
suggestedAdGroup

string

The suggested AdGroup for the keyword. Resource name format: customers/{customerId}/adGroups/{adGroupId}
suggestedCampaign

string

The suggested Campaign for the keyword. Resource name format: customers/{customerId}/campaigns/{campaignId}

UnusableAdGroup

An AdGroup/Campaign pair that could not be used as a suggestion for keywords.

AdGroups may not be usable if the AdGroup

  • belongs to a Campaign that is not ENABLED or PAUSED
  • is itself not ENABLED
JSON representation 
{
  "adGroup": string,
  "campaign": string
}
Fields
adGroup

string

The AdGroup resource name. Resource name format: customers/{customerId}/adGroups/{adGroupId}
campaign

string

The Campaign resource name. Resource name format: customers/{customerId}/campaigns/{campaignId}