Звіт за рекламою із зазначеним іменем домену V4 (SerpstatDomainProcedure.getAdKeywords)

Метод SerpstatDomainProcedure.getAdKeywords — метод виконує пошук ключових слів в платній видачі та рекламних оголошень по домену. Аналогічний до звіту Аналіз домену — РРС-аналіз — Ключові слова.

Загальні параметри запиту та інструкція щодо використання Serpstat API

Доступні пошукові бази

Параметри запиту
Параметр	Опис	Опціональність	Значення за замовчуванням	Варіанти значень
id	Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. Допускається введення будь-якого числового (number) або текстового (string) значення.	ні
method	Назва методу API	ні		SerpstatDomainProcedure.getAdKeywords
params	Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...]	ні
domain	Iм'я домену	ні		nike.com
se	Ідентифікатор пошукової бази, по якій буде проходити пошук (доступні бази Google і Yandex на вибір, наприклад: g_us, y_157).	ні		g_us
url	Посилання для уточнення пошуку	так		https://www.nike.com/nike-by-you
keywords	Масив ключових фраз, для якого буде відбуватися пошук	так	[]	["nike", "id"]
minusKeywords	Масив мінус-слів при пошуку	так	[]	["nikeid"]
filters	Умови фільтрації	так		{ "concurrency_from": "0", "concurrency_to": "1" }
sort	Порядок сортування результатів в форматі: {{{Field}}: {{order}}} field - поле, по якому потрібно виконати сортування: * keyword_length * position * type * cost * concurrency * found_results * region_queries_count * region_queries_count_wide * types * difficulty * geo_names order - напрямок сортування (asc - по зростанню, desc - по спадаючій)	так	{"position": "asc", "region_queries_count":"desc"}	{"cost": "asc"}
page	Номер сторінки у відповіді	так	1	"page": "1"
size	Кількість результатів на сторінку у відповіді	так	100	"size": "50" min: 1, max: 1000

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

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

Дата актуалізації оголошення

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
    }
  }
}