Отримати результат парсингу
Метод SerpstatTaskProcedure.getTaskResult дозволяє отримати результати парсинга частотності за ідентифікатором запиту "task_id", який був отриманий у відповіді методу SerpstatTaskProcedure.addKeywordListFreq.
Загальні параметри запиту та інструкція щодо використання Serpstat API
| Параметри запиту | |||||
| Параметр | Опис | Тип даних | Обов'язковість | Значення за замовчуванням | Варіанти значень |
| id | Ідентифікатор поточного запиту | string | так | 1, test | |
| method | Ім'я методу | string | так | SerpstatTaskProcedure.getTaskResult | |
| params | Об'єкт з параметрами | object | так | ||
| taskId | Ідентифікатор запиту з відповіді методу SerpstatTaskProcedure.addKeywordListFreq | string | так | bc0a46cc-357e-4706-a674-1e8166f81fb2 | |
| page | Номер сторінки | int | ні | 5 | |
| pageSize | Кількість результатів на сторінку | int | ні | 10 | |
| Параметри відповіді | ||
|---|---|---|
| Назва | Опис | Тип даних |
| id | Ідентифікатор відповіді: відповідає id в запиті | int |
| result | Об'єкт з результатами. | json object |
| total | Сумарна кількість ключових фраз в задачі без урахування blocked і дублів. | int |
| page | Порядковий номер сторінки результатів. | int |
| pageSize | Кількість результатів на сторінці. | int |
| taskMeta | Об'єкт з налаштуванням парсинга, передані в методі SerpstatTaskProcedure.addKeywordListFreq | json object |
| typeId | Ідентифікатор типу пристрою: typeId = 1 - Desktop | int |
| seId | Ідентифікатор пошукової системи: seId = 1 - Google | int |
| regionId | Ідентифікатор регіону або міста для Google. Відповідність регіону зазначено в документі (обережно, документ важкий - може тимчасово покласти браузер). | int |
| keywords | Масив ключових фраз з інформацією по кожному ключовому слову. | json array of objects |
| keyword | Ключова фраза, по якій були отримані параметри частотності і вартості за клік з урахуванням всіх фільтрів. | string |
| keyword.raw | Ключова фраза, яка прийшла на пробивання частотності від користувача. Частотність пробивається для ключових фраз без спецсимволів (*, +, -, @, ~, !, &, |, (, ), :, ,, ., ;). | string |
| status | Статус пробивки ключової фрази. Статуси можуть бути наступні: 2 - пробивання частотності успішно завершено. Дані в keyword_data присутні. 4 - помилка отримання даних від Google. Можливі причини помилки: 1) був обраний заборонений регіон видачі: Куба, Іран, Судан, Сирія, Північна Корея, росія [країна-терорист]; 2) Google не надав інформацію за фразою; 3) Google замінив частину символів у фразі. В такому випадку ми не можемо надати інформацію щодо первісного формулювання фрази. | string |
| cost | Середня вартість за клік в Google Ads за останній рік в USD | int |
| searchVolume | Частотність по обраному регіону і типу відповідності | int |
| searchVolumeHistory | Історія частотності за ключовою фразою за останні 12 місяців. Кожен об'єкт складається з полів date (дата першого дня місяця в форматі YYYY-MM-DDTHH: MM: SS) і value (місячна частотність). | int |
| competition | Конкуренція за ключовою фразою в Google Ads для Google (від 1 до 100%), яка показує який відсоток слотів для реклами по цій фразі зайнято в даному регіоні. | int |
Request data:
{
"id": 1,
"method": "SerpstatTaskProcedure.getTaskResult",
"params": {
"taskId": "bc0a46cc-357e-4706-a674-1e8166f81fb2",
"page": 1,
"pageSize" : 10
}
}Response data:
{
"id": "1",
"result": {
"total": 6,
"page": 1,
"pageSize": 10,
"taskMeta": {
"typeId": "1",
"seId": "1",
"regionId": "2840",
"match": "exact"
},
"keywords": [
{
"keyword": "iphone 10",
"keyword.raw": "iphone 10",
"status": 2,
"cost": 1.01,
"searchVolume": 246000,
"searchVolumeHistory": [
{
"date": "2020-09-01T00:00:00",
"value": 246000
},
{
"date": "2020-10-01T00:00:00",
"value": 301000
},
{
"date": "2020-11-01T00:00:00",
"value": 368000
},
{
"date": "2020-12-01T00:00:00",
"value": 368000
},
{
"date": "2021-01-01T00:00:00",
"value": 246000
},
{
"date": "2021-02-01T00:00:00",
"value": 201000
},
{
"date": "2021-03-01T00:00:00",
"value": 246000
},
{
"date": "2021-04-01T00:00:00",
"value": 201000
},
{
"date": "2021-05-01T00:00:00",
"value": 246000
},
{
"date": "2021-06-01T00:00:00",
"value": 201000
},
{
"date": "2021-07-01T00:00:00",
"value": 246000
},
{
"date": "2021-08-01T00:00:00",
"value": 246000
}
],
"competition": 100
},
{
"keyword": "iphone X",
"keyword.raw": "iphone X",
"status": 2,
"cost": 0.94999999999999996,
"searchVolume": 550000,
"searchVolumeHistory": [
{
"date": "2020-09-01T00:00:00",
"value": 550000
},
{
"date": "2020-10-01T00:00:00",
"value": 673000
},
{
"date": "2020-11-01T00:00:00",
"value": 673000
},
{
"date": "2020-12-01T00:00:00",
"value": 673000
},
{
"date": "2021-01-01T00:00:00",
"value": 550000
},
{
"date": "2021-02-01T00:00:00",
"value": 450000
},
{
"date": "2021-03-01T00:00:00",
"value": 550000
},
{
"date": "2021-04-01T00:00:00",
"value": 550000
},
{
"date": "2021-05-01T00:00:00",
"value": 450000
},
{
"date": "2021-06-01T00:00:00",
"value": 450000
},
{
"date": "2021-07-01T00:00:00",
"value": 450000
},
{
"date": "2021-08-01T00:00:00",
"value": 673000
}
],
"competition": 81
}
]
}
}