Отчет по рекламе с указанным именем домена (ad_keywords)

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

Пагинация

Для пагинации используйте параметры:

page_size : количество результатов на страницу (по умолчанию — 100, максимум — 1000).
page : номер страницы (по умолчанию 1-я страница).

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

Параметр	Описание	Возможные значения
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	Минимальное значение конкуренции	1-100
concurrency_to	Максимальное значение конкуренции	1-100

Для сортировки результата используйте параметры:

sort : поле, по которому нужно выполнить сортировку.
order : направление сортировки (asc — по возрастанию, desc — по убыванию).

Метрики	Описание
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	Список топонимов в масиве, если топоним присутствует в ключевой фразе. Если нет — масив пустой.
status_msg	Ответ: "OK" или "Error" сообщает об удачном или неудачном запросе
status_code	Код ответа "200" — успешный запрос. В других случаях — превышение лимитов (количество одновременных запросов или ограничение по лимитам аккаунта)
left_lines	Количество оставшихся API строк

Example PHP Python

Request data:

api.serpstat.com/v3/ad_keywords?query=XXX.com&token=XXX&se=XXX

Response data:

{  
   "result":{  
      "total":3109,
      "hits":[  
         {  
            "region_queries_count":49500,
            "domain":"example.com",
            "region_queries_count_wide":null,
            "keyword_length":2,
            "keyword":"iphone 6s",
            "title":"example",
            "url":"http:\/\/example",
            "text":"\example",
            "found_results":"51100000",
            "url_crc":-1839016631,
            "CRC ":458484575,
            "cost":0.23,
            "concurrency":64,
            "position":1,
            "date":"2017-04-13",
            "keyword_id":10453084,
            "subdomain":null,
            "type":3,
            "region_queries_count_last":27100,
            "types":[  

            ],
            "geo_names":[  

            ]
   }
   },
   "status_msg":"OK",
   "status_code":200,
   "left_lines":998590
}

<?php
// This example works on serpstat-sdk only
// https://github.com/SerpstatGlobal/serpstat-sdk

require_once __DIR__ . '/../vendor/autoload.php';
// configure your application
$config = [
    'token' => '19666fc1ae1724da1d5ea2f3a99d5f5a',
];
$keywords = 'keywords';
// init client with your serpstat api token
$apiClient = new \Serpstat\Sdk\Core\ApiGuzzleHttpClient($config['token']);
// create instance of any api method class
// list of methods classes in folder src\Methods
$apiMethod = new \Serpstat\Sdk\Methods\AdKeywordsMethod(
    $keywords,
    \Serpstat\Sdk\Interfaces\IApiClient::SE_GOOGLE_RU
);
try {
    // try call api method
    $response = $apiClient->call($apiMethod);
} catch (\Exception $e) {
    // catch api error
    $response = $e->getMessage();
}

"import codecs
import json
import pprint
import urllib.request as urlrequest
from urllib.parse import urlencode

host = 'http://api.serpstat.com/v3'

method = 'ad_keywords'
params = {
    'query': 'example.com',  # string for get info
    'se': 'g_us',  # string search engine
    'token': 'ijmiom4f5m34905g03um8342dm04923lre3w',  # string personal token
}

api_url = ""{host}/{method}?{params}"".format(
    host=host,
    method=method,
    params=urlencode(params)
)

try:
    json_data = urlrequest.urlopen(api_url).read()
except Exception as e0:
    print(""API request error: {error}"".format(error=e0))

data = json.loads(json_data)
pprint.pprint(data)"