Рекламные объявления по домену V4 (SerpstatDomainProcedure.getAdKeywords)

SerpstatDomainProcedure.getAdKeywords — метод выполняет поиск рекламных объявлений по домену.

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

Описание	Тип	Опциональный	Значение по умолчанию	Варианты значений
domain	Имя домена	нет		allo.ua
se	Идентификатор поисковой базы, по которой будет проходить поиск	нет		g_ua, g_ru, ...
url	Ссылка уточнения поиска	да	null	https://allo.ua
keywords	Массив ключевых фраз, для которого будет происходить поиск	да	[]	["купить"]
minusKeywords	Массив минус-слов при поиске	да	[]	["алло", "ало"]
filters	Условия фильтрации	да		{ "concurrency_from": "0", "concurrency_to": "1" }
sort	Порядок сортировки результатов в формате: {{{field}}: {{order}}} field - поле, по которому нужно выполнить сортировку order - направление сортировки (asc — по возрастанию, desc — по убыванию)	да	{"position": "asc", "region_queries_count":"desc"}	{"cost": "asc"}
page	Номер страницы в ответе	да	1	5
size	Количество результатов на страницу в ответе	да	100	"size": {{page_size}} min: 1, max: 1000

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

Параметр

keyword_length

position

type

cost

concurrency

found_results

region_queries_count

region_queries_count_wide

types

difficulty

geo_names

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

Параметр	Описание	Возможные значения
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

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

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

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

{
"keyword": "gmail.coṃ",
"keyword_length": 1,
"domain": "google.com",
"subdomain": "gsuite.google.com",
"url": "https://gsuite.google.com/intl/ru/products/gmail/",
"title": "Рабочая почта Gmail от Google | Работайте там, где вам удобно",
"text": "Надежная почта, онлайн хранение, календарь, видеочат.",
"position": 1,
"type": 1,
"cost": 0.05,
"concurrency": 7,
"found_results": 13,
"region_queries_count": 74000,
"region_queries_count_wide": 0,
"types": [
  "pic",
  "ads_top"
],
"geo_names": [
 
]
}

Example

Request data:


{
 "id": {{any_num_or_string}},
 "method": "SerpstatDomainProcedure.getAdKeywords",
 "params": {
   "domain": {{domain}},
   "se": {{search_engine}},
   (optional) "sort": { {{field}}: {{"asc"|"desc"}}},
   (optional) "url": {{url}},
   (optional) "keywords": [{{keyword}}, {{keyword}}, ...],
   (optional) "minusKeywords": [{{keyword}}, {{keyword}}, ...],
   (optional) "filters": { {{field_from}}: {{value}}, {{field_to}}: {{value}}},
   (optional) "page": {{page}},
   (optional) "size": {{page_size}}
 }
}

Response data:


{
  "id": {{your_num_or_string}},
  "result": {
    "data": [
      {
        "keyword": "gmail.coṃ",
        "keyword_length": 1,
        "domain": "google.com",
        "subdomain": "gsuite.google.com",
        "url": "https://gsuite.google.com/intl/ru/products/gmail/",
        "title": "Рабочая почта Gmail от Google | Работайте там, где вам удобно",
        "text": "Надежная почта, онлайн хранение, календарь, видеочат.",
        "position": 1,
        "type": 1,
        "cost": 0.05,
        "concurrency": 7,
        "found_results": 13,
        "region_queries_count": 74000,
        "region_queries_count_wide": 0,
        "types": [
          "pic",
          "ads_top"
        ],
        "geo_names": [
         
        ]
      },
      ................................................
    ],
    "summary_info": {
      "page": 1,
      "left_lines": 99268,
      "total": 3809
    }
  }
}