Рекламные объявления

Метод SerpstatKeywordProcedure.getAdKeywords выполняет поиск ключевых слов в платной выдаче и рекламных объявлений по ключевой фразе. Аналогичен отчету Анализ ключевых фраз - РРC-анализ - Рекламные объявления.

Общие параметры запроса и инструкция по использованию Serpstat API

Перечень доступных баз и стран

Параметры запроса
Название	Описание	Тип	Опциональный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения.	int/string	нет		1, test
method	Название метода API	string	нет		SerpstatKeywordProcedure.getAdKeywords
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]	array	нет
keyword	Фраза, для которой будет происходить поиск	string	нет		iphone
se	Идентификатор поисковой базы, по которой будет проходить поиск.	string	нет		g_us
domains	Список доменов	array	да	[]	["apple.com","verizon.com"]
MinusKeywords	Список минус-слов при поиске	array	да	[]	["app", "apple"]
filters	Условия фильтрации	json object	да		{"queries_from": 10} {"queries_to": 10}
sort	Порядок сортировки результатов в формате: {{{field}}: {{order}}} field — поле, по которому нужно выполнить сортировку: * keyword_length * position * type * cost * concurrency * found_results * region_queries_count * region_queries_count_wide order — направление сортировки (asc — по возрастанию, desc — по убыванию)	json object	да	{"position": "asc", "region_queries_count":"desc"}	{"cost": "asc"}
page	Номер страницы в ответе	int	да	1	"page": "5"
size	Количество результатов на страницу в ответе	int	да	100	"size": "10" min: 1, max: 1000
filters	Условия фильтрации	array	да		"right_spelling": true; "right_spelling": false minus_domain : www.domain.com subdomain : blog.domain.com url (exact_url) : https://www.apple.com/airpods/ types : "carousel", "also_asks" keyword_length : num keyword_length_from : num keyword_length_to : num "region_queries_count": "1000"; "region_queries_count_to": "2000"; "region_queries_count_from": 300 "region_queries_count_wide": "1000"; "region_queries_count_wide_to": "1500"; "region_queries_count_wide_from": 100 "position": 1 "position_from": 2 "position_to": 10 "cost": "10"; "cost_to": "10"; "cost_from": 1 "concurrency": "7"; "concurrency_to": "7"; "concurrency_from": 1 "difficulty": 3; "difficulty_from": 5; "difficulty_to": 10

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

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

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

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

{
    "keyword": "upgrade iphone x to xs",
    "keyword_length": 5,
    "domain": "apple.com",
    "subdomain": "www.apple.com",
    "url": "https://www.apple.com/iphone/",
    "title": "Trade in for iPhone 12 - Apple Official Site",
    "text": "Get $90 - $515 off iPhone 12 when you trade in an iPhone 7 or newer. Terms apply. A14 Bionic Chip. 5G speed. Ceramic Shield. Super Retina XDR display. Services: Free no-contact delivery, Finance with Apple Card, 3% cash back w/Apple Card, Prepaid mail-in kit.",
    "position": 2,
    "type": "1",
    "cost": 0,
    "concurrency": 50,
    "found_results": 325000000,
    "region_queries_count": 10,
    "region_queries_count_wide": 0,
    "types": [
        "carousel",
        "also_asks",
        "video",
        "ads_top"
        ],
    "geo_names": [],
    "difficulty": null
},

Example

Request data:

{
 "id": "1",
 "method": "SerpstatKeywordProcedure.getAdKeywords",
 "params": {
   "keyword": "iphone",
   "se": "g_us",
   "domains": ["apple.com","verizon.com"],
   "filters": {"position_from": "2", "position_to":"3"},
   "sort" : {"region_queries_count":"asc"},
   "page": "1",
   "size": "10"
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "keyword": "upgrade iphone x to xs",
                "keyword_length": 5,
                "domain": "apple.com",
                "subdomain": "www.apple.com",
                "url": "https://www.apple.com/iphone/",
                "title": "Trade in for iPhone 12 - Apple Official Site",
                "text": "Get $90 - $515 off iPhone 12 when you trade in an iPhone 7 or newer. Terms apply. A14 Bionic Chip. 5G speed. Ceramic Shield. Super Retina XDR display. Services: Free no-contact delivery, Finance with Apple Card, 3% cash back w/Apple Card, Prepaid mail-in kit.",
                "position": 2,
                "type": "1",
                "cost": 0,
                "concurrency": 50,
                "found_results": 325000000,
                "region_queries_count": 10,
                "region_queries_count_wide": 0,
                "types": [
                    "carousel",
                    "also_asks",
                    "video",
                    "ads_top"
                ],
                "geo_names": [],
                "difficulty": null
            },
            {
                "keyword": "iphone 7128gb price",
                "keyword_length": 3,
                "domain": "apple.com",
                "subdomain": "www.apple.com",
                "url": "https://www.apple.com/iphone/",
                "title": "iPhone - Apple Official Site",
                "text": "Blast past fast. iPhone 12 now in purple. Pre-order on 4.23. Save up to $320 on iPhone 12 after trade-in with T-Mobile. Terms apply. Water resistant. Retina display. Wide camera. Privacy built in. Services: Online personal session, Chat for shopping help.",
                "position": 2,
                "type": "3",
                "cost": 0,
                "concurrency": 0,
                "found_results": 1170000,
                "region_queries_count": 10,
                "region_queries_count_wide": 0,
                "types": [
                    "a_box_fsnippet",
                    "kn_graph_brand",
                    "also_asks",
                    "shopping_top",
                    "ads_bot"
                ],
                "geo_names": [],
                "difficulty": null
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 178,
            "left_lines": 998625
        }
    }
}