Рекламные объявления по ключевой фразе V4 (SerpstatKeywordProcedure.getAdKeywords)

SerpstatKeywordProcedure.getAdKeywords — метод выполняет поиск рекламных объявлений по ключевой фразе.

Параметры запроса:

Название	Описание	Тип	Опциональный	Значение по умолчанию	Варианты значений
keyword	Фраза, для которой будет происходить поиск	string	нет		купить iphone
se	Идентификатор поисковой базы, по которой будет проходить поиск	string	нет		g_ua
domains	Список доменов, массив	array	да	[]	["allo.ua", "citrus.ua"]
minusKeywords	Список минус-слов при поиске, массив	array	да	[]	["алло", "ало"]
filters	Условия фильтрации	json object	да		{"queries_from": 10} {"queries_to": 10}
sort	Порядок сортировки результатов в формате: {{{field}}: {{order}}} field - поле, по которому нужно выполнить сортировку order - направление сортировки (asc — по возрастанию, desc — по убыванию)	json object	да	{"position": "asc", "region_queries_count":"desc"}	{"cost": "asc"}
page	Номер страницы в ответе	int	да	1	5
size	Количество результатов на страницу в ответе	int	да	100	50-1000

Сортировка результатов возможна по следующим поля:

Параметр

keyword_length

position

type

cost

concurrency

found_results

region_queries_count

region_queries_count_wide

region_queries_count_last

Для фильтрации результатов используйте следующие параметры:

Параметр	Описание	Возможные значения
queries_from	Минимальная частотность в месяц	0-100000000
queries_to	Максимальная частотность в месяц	0-100000000
position_from	Минимальная позиция	1-100
position_to	Максимальная позиция	1-100
cost_from	Минимальная стоимость за клик	0-200
cost_to	Максимальная стоимость за клик	0-200
concurrency_from	Минимальное значение конкуренции ключевой фразы в PPC	1-100
concurrency_to	Максимальное значение конкуренции ключевой фразы в PPC	1-100
results_from	Минимальное значение результатов	0-100000000
results_to	Максимальное значение результатов	0-100000000
length_from	Минимальное значение длины фразы	0-100000000
length_to	Максимальное значение длины фразы	0-100000000

Метрики ответа:

Метрики	Описание
result	Инкапсулирует в себе ответ
total	Количество найденных объявлений, которые отображаются по запросам, содержащие искомую фразу
region_queries_count	Частотность ключевой фразы в выбранном регионе
region_queries_count_wide	Частотность ключевой фразы в широком соответствии
region_queries_count_last	Частотность ключевой фразы за последний месяц
domain	Домен
keyword_length	Количество слов, разделенных пробелом в ключевой фразе
keyword	Ключевая фраза по которой отображается объявление
title	Заголовок объявления
url	Url объявления
text	Текст объявления
found_results	Количество найденных результатов по ключевой фразе ""keyword"
cost	Цена за клик, $
concurrency	Конкурентность в контекстной рекламе (0-100)
position	Позиции объявлений в контекстной рекламе
date	Дата актуализации объявления
subdomain	Поддомен
type	Место размещения объявления в SERP (1. Над; 2. Под; 3. Справа)
types	Список дополнительных элементов которые отображаются в SERP (например, видео, карусель изображений, карта и другое )
geo_names	Список топонимов в масиве, если топоним присутствует в ключевой фразе. Если нет — масив пустой.
left_lines	Количество оставшихся API строк

Лимиты: количество списанных лимитов соответствует количеству полученных результатов по запросу. Часть ответа API, за которую снимается 1 лимит:

{
"keyword": "купить ноутбуки",
"keyword_length": 2,
"domain": "foxtrot.com.ua",
"subdomain": "www.foxtrot.com.ua",
"url": "https://www.foxtrot.com.ua/ru/shop/noutbuki.html",
"title": "Купить Ноутбуки в Фокстроте | В наличии. Выгодные цены",
"text": "Заказывайте в интернете - забирайте в удобное время в магазине Фокстрот! Кредит до 24 месяцев. Цена проверена. Официальная гарантия. Акции каждый день. Места: Киев, Харьков.",
"position": 1,
"type": 1,
"cost": 0.120833,
"concurrency": 100,
"found_results": 52700000,
"region_queries_count": 27100,
"region_queries_count_wide": 74000,
"types": [
  "ads_top",
  "related_search"
],
"geo_names": [
  
],
}

Example

Request data:

{
    "id": {{any_num_or_string}},
    "method": "SerpstatKeywordProcedure.getAdKeywords",
    "params": {
        "se": {{search_engine}},
        "keyword": {{keyword}},
        (optional) "domains": [{{domian1}}],
        (optional) "minusKeywords": [{{keyword1}}],
        (optional) "filters": [{{field_from}}: {{value}}, {{field_to}}: {{value}}],
        (optional) "sort" : [{{filed}}:{{"asc"|"desc"}}],
        (optional) "page": {{page}},
        (optional) "size": {{size}}
    }
}

Response data:

{
  "id": {{any_num_or_string}},
  "result": {
    "data": [
      {
        "keyword": "купить ноутбуки",
        "keyword_length": 2,
        "domain": "foxtrot.com.ua",
        "subdomain": "www.foxtrot.com.ua",
        "url": "https://www.foxtrot.com.ua/ru/shop/noutbuki.html",
        "title": "Купить Ноутбуки в Фокстроте | В наличии. Выгодные цены",
        "text": "Заказывайте в интернете - забирайте в удобное время в магазине Фокстрот! Кредит до 24 месяцев. Цена проверена. Официальная гарантия. Акции каждый день. Места: Киев, Харьков.",
        "position": 1,
        "type": 1,
        "cost": 0.120833,
        "concurrency": 100,
        "found_results": 52700000,
        "region_queries_count": 27100,
        "region_queries_count_wide": 74000,
        "types": [
          "ads_top",
          "related_search"
        ],
        "geo_names": [
          
        ],
      },
      
    ],
    "summary_info": {
      "page": 1,
      "total": 1052843,
      "left_lines": 9999900
    }
  }
}