Рекламні оголошення за ключовою фразою V4 (SerpstatKeywordProcedure.getAdKeywords)

SerpstatKeywordProcedure.getAdKeywords - метод виконує пошук рекламних оголошень за ключовою фразою.

Параметри запиту:

Опис	Тип	Тип	Опціональність	Значення за замовчуванням	Варіанти значень
keyword	Фраза, для якої буде відбуватися пошук	string	ні		allo.ua
se	Ідентифікатор пошукової бази, по якій буде проходити пошук	string	ні		g_ua, g_ru, ...
domains	Список доменів, масив	array	так	[]	https://allo.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

Для фільтрації результатів використовуйте наступні параметри:

Параметр	Опис	Можливі значення
position_from	Мінімальна позиція ключового слова	1-100
position_to	Максимальна позиція ключового слова	1-100
queries_from	Мінімальна кількість запитів на місяць	0-100000000
queries_to	Максимальна кількість запитів на місяць	0-100000000
cost_from	Мінімальна вартість за клік	0-200
cost_to	Максимальна вартість за клік	0-200
concurrency_from	Мінімальне значення конкуренції	0-100
concurrency_to	Максимальне значення конкуренції	0-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"
CRC	Контрольна сума для швидкого пошуку
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
    }
  }
}