Method: customers.generateKeywordIdeas

Возвращает список вариантов ключевых слов.

Список выброшенных ошибок: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError KeywordPlanIdeaError QuotaError RequestError

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
customerId

string

Идентификатор клиента с рекомендацией.

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "geoTargetConstants": [
    string
  ],
  "includeAdultKeywords": boolean,
  "pageToken": string,
  "pageSize": integer,
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "keywordAnnotation": [
    enum (KeywordPlanKeywordAnnotation)
  ],
  "aggregateMetrics": {
    object (KeywordPlanAggregateMetrics)
  },
  "historicalMetricsOptions": {
    object (HistoricalMetricsOptions)
  },
  "language": string,

  // Union field seed can be only one of the following:
  "keywordAndUrlSeed": {
    object (KeywordAndUrlSeed)
  },
  "keywordSeed": {
    object (KeywordSeed)
  },
  "urlSeed": {
    object (UrlSeed)
  },
  "siteSeed": {
    object (SiteSeed)
  }
  // End of list of possible types for union field seed.
}
Поля
geoTargetConstants[]

string

Имена ресурсов целевого местоположения. Максимум — 10. Пустой список МОЖЕТ использоваться для указания всех географических регионов таргетинга.

includeAdultKeywords

boolean

Если это правда, в ответ будут включены ключевые слова для взрослых. Значение по умолчанию — ложь.

pageToken

string

Токен страницы, которую нужно получить. Если не указано, будет возвращена первая страница результатов. Чтобы запросить следующую страницу результатов, используйте значение, полученное из nextPageToken в предыдущем ответе. Поля запроса должны совпадать на всех страницах.

pageSize

integer

Количество результатов для получения на одной странице. Может быть возвращено максимум 10 000 результатов. Если pageSize превышает это значение, он игнорируется. Если не указано, будет возвращено не более 10 000 результатов. Сервер может принять решение дополнительно ограничить количество возвращаемых ресурсов. Если ответ содержит менее 10 000 результатов, его нельзя считать последней страницей результатов.

keywordPlanNetwork

enum ( KeywordPlanNetwork )

Таргетинговая сеть. Если этот параметр не установлен, будет использоваться сеть поиска Google и партнеров.

keywordAnnotation[]

enum ( KeywordPlanKeywordAnnotation )

Аннотации к ключевым словам, которые нужно включить в ответ.

aggregateMetrics

object ( KeywordPlanAggregateMetrics )

Агрегатные поля, которые необходимо включить в ответ.

historicalMetricsOptions

object ( HistoricalMetricsOptions )

Параметры исторических данных метрик.

language

string

Имя ресурса целевого языка. Каждое ключевое слово принадлежит некоторому набору языков; ключевое слово включается, если язык является одним из его языков. Если не установлено, будут включены все ключевые слова.

Полевые seed Союза. Тип начального значения для генерации вариантов ключевых слов. seed может быть только одним из следующих:
keywordAndUrlSeed

object ( KeywordAndUrlSeed )

Ключевое слово и конкретный URL-адрес для генерации идей, например, автомобили, www.example.com/cars.

keywordSeed

object ( KeywordSeed )

Ключевое слово или фраза для генерации идей, например, об автомобилях.

urlSeed

object ( UrlSeed )

Конкретный URL-адрес для генерации идей, например www.example.com/cars.

siteSeed

object ( SiteSeed )

Сайт для генерации идей, например www.example.com.

Тело ответа

Ответное сообщение для KeywordPlanIdeaService.GenerateKeywordIdeas .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "results": [
    {
      object (GenerateKeywordIdeaResult)
    }
  ],
  "aggregateMetricResults": {
    object (KeywordPlanAggregateMetricResults)
  },
  "nextPageToken": string,
  "totalSize": string
}
Поля
results[]

object ( GenerateKeywordIdeaResult )

Результаты генерации идей ключевых слов.

aggregateMetricResults

object ( KeywordPlanAggregateMetricResults )

Совокупные показатели для всех вариантов ключевых слов.

nextPageToken

string

Токен нумерации страниц, используемый для получения следующей страницы результатов. Передайте содержимое этой строки в качестве атрибута pageToken следующего запроса. nextPageToken не возвращается для последней страницы.

totalSize

string ( int64 format)

Общее количество доступных результатов.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Ключевое словоПланКлючевое словоАннотация

Перечисляет аннотации плана ключевых слов, которые можно запросить.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN В этой версии значение неизвестно.
KEYWORD_CONCEPT Возвращает концепцию ключевого слова и данные группы концепций.

Ключевое словоAndUrlSeed

Ключевое слово и URL-адрес

JSON-представление 
{
  "keywords": [
    string
  ],
  "url": string
}
Поля
keywords[]

string

Требуется хотя бы одно ключевое слово и не более 20 ключевых слов.

url

string

URL-адрес для сканирования, чтобы генерировать варианты ключевых слов.

Ключевое словоСемя

Начальное ключевое слово

JSON-представление 
{
  "keywords": [
    string
  ]
}
Поля
keywords[]

string

Требуется хотя бы одно ключевое слово и не более 20 ключевых слов.

URLSeed

Начальное URL-адрес

JSON-представление 
{
  "url": string
}
Поля
url

string

URL-адрес для сканирования, чтобы генерировать варианты ключевых слов.

SiteSeed

Начальное значение сайта

JSON-представление 
{
  "site": string
}
Поля
site

string

Доменное имя сайта. Если клиент, запрашивающий идеи, не является владельцем сайта, возвращается только общедоступная информация.

Генерировать ключевое словоидеярезультат

Результат генерации вариантов ключевых слов.

JSON-представление 
{
  "keywordIdeaMetrics": {
    object (KeywordPlanHistoricalMetrics)
  },
  "keywordAnnotations": {
    object (KeywordAnnotations)
  },
  "closeVariants": [
    string
  ],
  "text": string
}
Поля
keywordIdeaMetrics

object ( KeywordPlanHistoricalMetrics )

Исторические показатели для ключевого слова.

keywordAnnotations

object ( KeywordAnnotations )

Аннотации к ключевому слову. Данные аннотации предоставляются только по запросу.

closeVariants[]

string

Список близких вариантов запрошенных ключевых слов, которые объединяются в этот GenerateKeywordIdeaResult. См . https://support.google.com/google-ads/answer/9342105 для определения «близких вариантов».

text

string

Текст идеи ключевого слова. Как и в исторических показателях Плана ключевых слов, этот текст может быть не реальным ключевым словом, а канонической формой нескольких ключевых слов. См. сообщение KeywordPlanKeywordHistoricalMetrics в KeywordPlanService.

Ключевые словаАннотации

Аннотации к ключевым словам плана ключевых слов.

JSON-представление 
{
  "concepts": [
    {
      object (KeywordConcept)
    }
  ]
}
Поля
concepts[]

object ( KeywordConcept )

Список понятий по ключевому слову.

Ключевое словоКонцепция

Концепция ключевого слова.

JSON-представление 
{
  "name": string,
  "conceptGroup": {
    object (ConceptGroup)
  }
}
Поля
name

string

Имя концепции для ключевого слова в ConceptGroup.

conceptGroup

object ( ConceptGroup )

Концептуальная группа деталей концепции.

Концептуальная группа

Группа понятий для концепции ключевого слова.

JSON-представление 
{
  "name": string,
  "type": enum (KeywordPlanConceptGroupType)
}
Поля
name

string

Имя концептуальной группы.

type

enum ( KeywordPlanConceptGroupType )

Тип группы понятий.

Ключевое словоПланКонцепцияГруппаТип

Перечисляет типы групп концепций плана ключевых слов.

Перечисления
UNSPECIFIED Классификация концептуальных групп отличается от брендовых/небрендовых. Это совокупность всех классификаций, которые не входят ни в одну из перечисленных ниже.
UNKNOWN В этой версии значение неизвестно.
BRAND Классификация концепт-групп основана на БРЕНДЕ.
OTHER_BRANDS Классификация концептуальных групп, основанная на БРЕНДЕ, не очень хорошо сочеталась с классификациями БРЕНДОВ. Как правило, это выбросы, и в этом типе классификации может быть очень мало ключевых слов.
NON_BRAND Классификация этих концептуальных групп не основана на БРЕНДЕ. Возвращается для общих ключевых слов, не имеющих ассоциации с брендом.