v0.2.0-beta

OpenAPI 3.1.0

Отримання результатів пошукового обсягу за id

Felo API Support

MIT

Сервер

https://openapi.felo.ai

Клієнтські бібліотеки

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Операції

get/v1/beta/dataforseo/keywords_data/google_ads/search_volume/task_get/{id}

Отримання результатів пошукового обсягу за id

Отримує за id поставлене в чергу завдання обсягу пошуку Google Ads. Та сама структура, що в post_dataforseo_keywords_gads_search_volume_live. Відповідь обгорнуто в конверт DataForSEO: дані в tasks[0].result, результат у tasks[0].status_code — відхилений запит усе одно повертає HTTP 200.

Довідкові ціни

Тарифікація: вартість відповіді за даними постачальника.
Довідкова оцінка запиту: USD 0.012.
Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Лише довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

Параметри шляху

id
Тип: string
обов'язкове

ідентифікатор завдання
унікальний ідентифікатор завдання в нашій системі у форматі UUID
протягом 30 днів ви зможете будь-коли запросити за ним результати завдання

Відповіді

200
Тип: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeTaskGetResponseInfo
cost
Тип: number | null Формат: double

загальна вартість завдань, USD

status_code
Тип: integer | null

загальний код стану. Повний список кодів відповіді можна знайти тут.

status_message
Тип: string | null

загальне інформаційне повідомлення. Повний список загальних інформаційних повідомлень можна знайти тут.

tasks
Тип: array (object | null)[] | null

масив завдань

Тип: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeTaskGetTaskInfo
cost
Тип: number | null Формат: double

загальна вартість завдань, USD

data
Тип: object | null

містить ті самі параметри, які ви вказали в POST-запиті

propertyName
Тип: object | null
id
Тип: string | null

ідентифікатор завдання унікальний ідентифікатор завдання в нашій системі у форматі UUID

path
Тип: array (string | null)[] | null

шлях URL

result
Тип: array (object | null)[] | null

масив результатів

competition
Тип: string | null

конкуренція
відносний рівень конкуренції за зазначеним ключовим словом лише в платній видачі SERP;
значення базується на даних Google Ads і може набувати таких значень: HIGH, MEDIUM, LOW;
якщо даних немає, значення — null;
докладніше про метрику — у цій статті довідкового центру

competition_index
Тип: integer | null

конкуренція
відносний рівень конкуренції за зазначеним ключовим словом лише в платній видачі SERP;
значення базується на даних Google Ads і може перебувати в діапазоні від 0 до 100 включно;
якщо даних немає, значення — null;
докладніше про метрику — у цій статті довідкового центру

cpc
Тип: number | null

ціна за клік
сума (USD), що сплачується за кожен клік за оголошенням, показаним для зазначеного ключового слова

high_top_of_page_bid
Тип: number | null

максимальна ставка для показу оголошення у верхній частині першої сторінки
означає значення, що перевищує приблизно 80% мінімальних ставок, за яких показувалися оголошення (на основі статистики Google Ads для рекламодавців);
значення може відрізнятися залежно від локації, зазначеної в POST-запиті

keyword
Тип: string | null

ключове слово
ключове слово повертається з декодованим %## (символ плюса '+' декодується в пробіл)

language_code
Тип: string | null

код мови в масиві POST
якщо даних немає, значення — null

location_code
Тип: integer | null

код локації в масиві POST
якщо даних немає, значення — null

low_top_of_page_bid
Тип: number | null

мінімальна ставка для показу оголошення у верхній частині першої сторінки
означає значення, що перевищує приблизно 20% мінімальних ставок, за яких показувалися оголошення (на основі статистики Google Ads для рекламодавців);
значення може відрізнятися залежно від локації, зазначеної в POST-запиті

monthly_searches
Тип: array (object | null)[] | null

пошукових запитів на місяць
приблизна кількість пошукових запитів за цією ідеєю ключового слова (за замовчуванням за останні дванадцять місяців), націлених на зазначені географічні локації;
якщо даних немає, значення —_nulln

month
Тип: integer | null

місяць

search_volume
Тип: integer | null

середньомісячний показник пошукового обсягу

year
Тип: integer | null

рік

search_partners
Тип: boolean | null

указує, чи включено у відповідь дані партнерських мереж

search_volume
Тип: integer | null Формат: int64

середньомісячний показник пошукового обсягу

spell
Тип: string | null

правильне написання ключового слова
Примітка:якщо ключове слово в масиві POST виглядає з помилкою, дані буде повернуто для ключового слова з правильним написанням;
для перевірки та валідації написання ключових слів ми використовуємо функціональність Google Ads API, докладніше за цим посиланням

result_count
Тип: integer | null Формат: int64

кількість елементів у масиві result

status_code
Тип: integer | null

код стану завдання формується DataForSEO, може перебувати в діапазоні 10000-60000 Повний список кодів відповіді можна знайти тут.

status_message
Тип: string | null

інформаційне повідомлення завдання Повний список загальних інформаційних повідомлень можна знайти тут.

time
Тип: string | null

час виконання, секунди

tasks_count
Тип: integer | null Формат: int64

кількість завдань у масиві tasks

tasks_error
Тип: integer | null Формат: int64

кількість завдань у масиві tasks, повернутих з помилкою

time
Тип: string | null

загальний час виконання, секунди

version
Тип: string | null

поточна версія API
application/json
400

Не вдалося обробити запит. Перевірте параметри запиту.
401

Потрібен дійсний API-ключ Felo.
402

Запит неможливо виконати: умови білінгу не виконано.
403

Обліковий запис не має дозволу на цю операцію.
429

Досягнуто ліміту запитів або витрат.
502

Служба не змогла виконати запит.
503

API або служба білінгу тимчасово недоступні.
504

Час очікування обробки запиту вичерпано.
default

Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

application/json

get/v1/beta/dataforseo/keywords_data/google_ads/search_volume/task_get/{id}

curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/search_volume/task_get/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Показати схему

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "keyword": null,
          "spell": null,
          "location_code": null,
          "language_code": null,
          "search_partners": null,
          "competition": null,
          "competition_index": null,
          "search_volume": null,
          "low_top_of_page_bid": null,
          "high_top_of_page_bid": null,
          "cpc": null,
          "monthly_searches": [
            {
              "year": null,
              "month": null,
              "search_volume": null
            }
          ]
        }
      ]
    }
  ]
}

Успішна операція

Отримання результатів пошукового обсягу за id

АвтентифікаціяRequired

DataForSEO

Отримання результатів пошукового обсягу за id

Довідкові ціни