Felo API PlatformFelo API Platform
Усі endpoint DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

Постановка завдань органічної видачі Google

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клієнтські бібліотеки
Shell Curl

DataForSEO

​

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

DataForSEO Операції

Постановка завдань органічної видачі Google

​

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

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

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

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

Тіло
application/json
  • Тип: array (object | null)[]
    • browser_screen_height
      Тип: integer | null

      висота екрана браузера

      необов'язкове поле

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

      можна вказати в такому діапазоні: 240-9999;

      за замовчуванням параметр встановлено в:

      1080 для desktop;

      640 для mobile на android;

      812 для mobile на iOS;

      Примітка: щоб використовувати цей параметр, задайте для calculate_rectangles значення true

    • browser_screen_resolution_ratio
      Тип: integer | null

      коефіцієнт роздільної здатності екрана браузера

      необов'язкове поле

      можна задати власний коефіцієнт роздільної здатності екрана браузера для розрахунку піксельних позицій для конкретного пристрою;

      можна вказати в такому діапазоні: 0.5-3;

      за замовчуванням параметр встановлено в:

      1 для desktop;

      3 для mobile на android;

      3 для mobile на iOS;

      Примітка: щоб використовувати цей параметр, задайте для calculate_rectangles значення true

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

      ширина екрана браузера

      необов'язкове поле

      можна задати власну ширину екрана браузера для розрахунку піксельних позицій для конкретного пристрою;

      можна вказати в такому діапазоні: 240-9999;

      за замовчуванням параметр встановлено в:

      1920 для desktop;

      360 для mobile на android;

      375 для mobile на iOS;

      Примітка: щоб використовувати цей параметр, задайте для calculate_rectangles значення true

    • calculate_rectangles
      Тип: boolean | null

      розрахунок піксельних позицій для елементів SERP у розширених результатах

      необов'язкове поле

      піксельна позиція — це відстань між снипетом результату та верхнім лівим кутом екрана;

      Докладніше в Help Center>>

      за замовчуванням параметр встановлено в false

      Примітка: за використання цього параметра додатково стягується $0.0006

    • depth
      Тип: integer | null

      глибина парсингу

      необов'язкове поле

      кількість результатів у SERP

      значення за замовчуванням: 10

      максимальне значення: 700


      З вашого облікового запису стягується плата за кожен SERP, що містить до 10 результатів;

      Встановлення глибини понад 10 може призвести до додаткових списань, якщо пошукова система повертає понад 10 результатів;

      Вартість можна розрахувати на сторінці тарифів.

    • device
      Тип: string | null

      тип пристрою

      необов'язкове поле

      повертати результати для певного типу пристрою

      може набувати значень:desktop, mobile

      значення за замовчуванням: desktop

    • expand_ai_overview
      Тип: boolean | null

      розгорнути AI-огляд

      необов'язкове поле

      установіть true, щоб розгорнути елемент ai_overview;

      значення за замовчуванням: false;

      Примітка: цей параметр застосовується лише до HTML-результатів завдань

    • find_targets_in
      Тип: array string[] | null

      типи елементів SERP для перевірки на цілі

      необов'язкове поле

      щоб увімкнути цей параметр, також має бути ввімкнено stop_crawl_on_match

      указує, які типи елементів SERP слід перевіряти на збіг із цілями

      якщо не вказано, на цілі перевіряються всі елементи першого рівня з полями url і domain

      можливі значення: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter

      Примітка: не може містити ті самі типи елементів, що й ignore_targets_in

      приклад:

      "find_targets_in": ["organic", "featured_snippet"]

      докладніше про цей параметр — у нашому Help Center

    • group_organic_results
      Тип: boolean | null

      показувати пов'язані результати

      необов'язкове поле

      якщо задано true, елемент related_result у відповіді буде надано як сніпет його батьківського органічного результату;

      якщо задано false, елемент related_result буде надано як окремий органічний результат;

      значення за замовчуванням: true

    • ignore_targets_in
      Тип: array string[] | null

      типи елементів SERP, що виключаються з пошуку цілей

      необов'язкове поле

      щоб увімкнути цей параметр, також має бути ввімкнено stop_crawl_on_match

      указує, які типи елементів SERP слід виключати під час пошуку збігів із цілями

      можливі значення: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter

      Примітка: не може містити ті самі типи елементів, що й find_targets_in

      приклад:

      "ignore_targets_in": ["paid", "images"]

      докладніше про цей параметр — у нашому Help Center

    • keyword
      Тип: string

      ключове слово

      обов'язкове поле

      у полі keyword можна вказати до 700 символів

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

      якщо в keyword потрібен символ “%”, укажіть його як “%25”;

      якщо в keyword потрібен символ “+”, укажіть його як “%2B”;

      якщо це поле містить такі параметри, як ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, вартість завдання множиться на 5

      Докладніше про правила й обмеження полів keyword і keywords в API DataForSEO читайте в цій статті довідкового центру

    • language_code
      Тип: string

      код мови пошукової системи

      обов'язкове поле, якщо не вказано language_name

      якщо використовуєте це поле, language_name вказувати не потрібно

      список доступних мов пошукової системи з їхнім language_code можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/languages

      приклад:

      en

    • language_name
      Тип: string

      повна назва мови пошукової системи

      обов'язкове поле, якщо не вказано language_code

      якщо використовуєте це поле, language_code вказувати не потрібно

      список доступних мов пошукової системи з їхньою language_name можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/languages

      приклад:

      English

    • load_async_ai_overview
      Тип: boolean | null

      завантаження асинхронного AI-огляду

      необов'язкове поле

      установіть true, щоб отримувати елементи ai_overview у SERP, навіть якщо вони завантажуються асинхронно;

      якщо задано false, ви отримаєте елементи ai_overview лише з кешу;

      значення за замовчуванням: false

      Примітка: за використання цього параметра додатково стягується $0.0006;

      якщо елемент відсутній або містить "asynchronous_ai_overview": false, усі додаткові списання буде повернено на баланс вашого облікового запису

    • location_code
      Тип: integer

      код місцезнаходження пошукової системи

      обов'язкове поле, якщо не вказано location_name або location_coordinate

      якщо використовуєте це поле, location_name або location_coordinate вказувати не потрібно

      список доступних місцезнаходжень пошукових систем з їхнім location_code можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/locations

      приклад:

      2840

    • location_coordinate
      Тип: string

      GPS-координати місцезнаходження

      обов'язкове поле, якщо не вказано location_name або location_code

      якщо використовуєте це поле, location_name або location_code вказувати не потрібно

      параметр location_coordinate слід указувати у форматі "latitude,longitude,radius"

      максимальна кількість десяткових знаків для "latitude" і "longitude": 7

      мінімальне значення для "radius": 199 (мм)

      максимальне значення для "radius": 199999 (мм)

      приклад:

      53.476225,-2.243572,200

    • location_name
      Тип: string

      повна назва місцезнаходження пошукової системи

      обов'язкове поле, якщо не вказано location_code або location_coordinate

      якщо використовуєте це поле, location_code або location_coordinate вказувати не потрібно

      список доступних місцезнаходжень пошукової системи з їхнім location_name можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/locations

      приклад:

      London,England,United Kingdom

    • match_type
      Тип: string

      тип відповідності цілі

      обов'язкове поле, якщо вказано stop_crawl_on_match

      тип відповідності для match_value

      можливі значення:

      domain – конкретний домен або піддомен

      with_subdomains – основний домен і піддомени

      wildcard – шаблон із символами підстановки

    • match_value
      Тип: string

      цільовий домен, піддомен або значення шаблону

      обов'язкове поле, якщо вказано stop_crawl_on_match

      укажіть цільовий домен, піддомен або значення шаблону;

      Примітка: домен або піддомен вказується без протоколу запиту;

      приклад: "match_value": "dataforseo.com",

      "match_value": "/blog/post-*"

    • max_crawl_pages
      Тип: integer | null

      ліміт обходу сторінок

      необов'язкове поле

      кількість сторінок результатів пошуку для обходу

      максимальне значення: 100

      Примітка: плата стягується за кожну проскановану сторінку (10 органічних результатів на сторінку);

      докладніше про тарифи — на сторінці Pricing;

      Примітка#2: параметри max_crawl_pages і depth доповнюють один одного;

      докладніше в довідковому центрі

    • os
      Тип: string | null

      операційна система пристрою

      необов'язкове поле

      якщо desktop вказано в полі device, вибирайте зі значень: windows, macos

      значення за замовчуванням: windows

      якщо mobile вказано в полі device, вибирайте зі значень: android, ios

      значення за замовчуванням: android

    • people_also_ask_click_depth
      Тип: integer | null

      кліки по відповідному елементу

      необов'язкове поле

      укажіть глибину кліків по елементу people_also_ask, щоб отримати додаткові елементи people_also_ask_element;

      Примітка незалежно від пріоритету завдання за кожен клік з облікового запису додатково стягується $0.00015;

      якщо елемент відсутній або ми виконаємо менше кліків, ніж ви вказали, усі додаткові списання буде повернено на баланс вашого облікового запису

      можливі значення: від 1 до 4

    • pingback_url
      Тип: string | null

      URL сповіщення про завершення завдання

      необов'язкове поле

      коли завдання буде виконано, ми надішлемо GET-запит на вказаний вами URL

      рядок «$id» можна використовувати як змінну $id, а «$tag» — як urlencoded-змінну $tag. Перед надсиланням запиту ми підставимо потрібні значення.

      приклад:

      http://your-server.com/pingscript?id=$id

      http://your-server.com/pingscript?id=$id&tag=$tag

      Примітка: спеціальні символи в pingback_url буде urlencoded;

      зокрема, символ # кодується як %23


      Докладніше див. в Help Center

    • postback_data
      Тип: string

      тип даних postback_url

      обов'язкове поле, якщо вказано postback_url

      відповідає типу даних, які буде надіслано на ваш сервер

      можливі значення:

      regular, advanced, html

    • postback_url
      Тип: string | null

      URL для надсилання результатів завдання

      необов'язкове поле

      коли завдання буде виконано, ми надішлемо POST-запит із результатами, стисненими у форматі gzip, на вказаний вами postback_url

      рядок «$id» можна використовувати як змінну $id, а «$tag» — як urlencoded-змінну $tag. Перед надсиланням запиту ми підставимо потрібні значення

      приклад:

      http://your-server.com/postbackscript?id=$id

      http://your-server.com/postbackscript?id=$id&tag=$tag

      Примітка: спеціальні символи в postback_url буде закодовано в URL;

      зокрема, символ # буде закодовано як %23


      докладніше — у довідковому центрі

    • priority
      Тип: integer | null

      пріоритет завдання

      необов'язкове поле

      може приймати такі значення:

      1 — звичайний пріоритет виконання (встановлюється за замовчуванням);

      2 — високий пріоритет виконання


      За завдання з високим пріоритетом виконання стягується додаткова плата.

      Вартість можна розрахувати на сторінці тарифів.

    • remove_from_url
      Тип: array string[] | null

      видалення певних параметрів з URL

      необов'язкове поле

      за допомогою цього поля можна вказати до 10 параметрів для видалення з URL у результаті

      приклад:

      "remove_from_url": ["srsltid"]

    • se_domain
      Тип: string | null

      домен пошукової системи

      необов'язкове поле

      ми автоматично вибираємо відповідний домен пошукової системи залежно від указаних вами місцезнаходження та мови

      однак у цьому полі можна задати власний домен пошукової системи

      приклад:

      google.co.uk, google.com.au, google.de тощо.

    • search_param
      Тип: string | null

      додаткові параметри пошукового запиту

      необов'язкове поле

      список доступних параметрів і додаткові відомості наведено тут


      Примітка: такі параметри пошукової системи не підтримуються й буде автоматично скасовано, якщо їх указати: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
    • stop_crawl_on_match
      Тип: array (object | null)[] | null

      масив цілей для зупинки обходу необов'язкове поле якщо вказано, відповідь міститиме результати SERP до вказаного match_value включно; у цьому масиві можна вказати до 10 цільових значень приклад: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] докладніше про цей параметр — у нашому довідковому центрі: https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api оплата стягується за кожен SERP, обійдений за вказаними цілями

      • match_type
        Тип: string | null

        тип зіставлення цілі обов'язкове поле, якщо вказано stop_crawl_on_match; тип зіставлення для match_value можливі значення: domain, with_subdomains, wildcard

      • match_value
        Тип: string | null

        цільовий домен або значення з підстановкою обов'язкове поле, якщо вказано stop_crawl_on_match; укажіть цільовий домен або значення з підстановкою; Примітка: ім'я домену вказується без протоколу запиту; приклад: dataforseo.com

    • tag
      Тип: string | null

      визначений користувачем ідентифікатор завдання

      необов'язкове поле

      обмеження — 255 символів

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

      вказане значення tag ви знайдете в об'єкті data відповіді

    • target_search_mode
      Тип: string | null

      режим зіставлення цілей

      необов'язкове поле

      щоб використовувати цей параметр, також має бути ввімкнено stop_crawl_on_match

      визначає, як має зупинятися обхід, коли в stop_crawl_on_match указано кілька цілей

      можливі значення: all, any

      all – обхід зупиняється лише тоді, коли знайдено всі вказані цілі

      any – обхід зупиняється, коли знайдено будь-яку одну ціль

      значення за замовчуванням: any

      докладніше про цей параметр — у довідковому центрі

    • url
      Тип: string | null

      прямий URL пошукового запиту

      необов'язкове поле

      можна вказати прямий URL, і ми розберемо його на потрібні поля. Зауважте, що цей спосіб найскладніший для обробки нашим API, а також вимагає вказати точну мову й місцезнаходження в URL. У більшості випадків ми не рекомендуємо використовувати цей спосіб.

      приклад:

      https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS


      Примітка: такі параметри пошукової системи не підтримуються й буде автоматично скасовано, якщо вказати їх в URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
Відповіді
  • 200
    Тип: object | null · Response36Afe1097B20_SerpGoogleOrganicTaskPostResponseInfo
    • cost
      Тип: number | null Формат: double

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

    • status_code
      Тип: integer | null

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

    • status_message
      Тип: string | null

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

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

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

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

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

        • data
          Тип: object | null

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

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

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

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

          шлях URL

        • result
          Тип: object | null

          масив результатів
          у цьому випадку значення буде null

        • 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
Request Example for post/v1/beta/dataforseo/serp/google/organic/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/organic/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  },
  {
    "language_name": "English",
    "location_name": "United States",
    "keyword": "albert einstein",
    "priority": 2,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  },
  {
    "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
    "postback_data": "html",
    "postback_url": "https://your-server.com/postbackscript"
  }
]'

{
  "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": null
    }
  ]
}

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

Setting Google Organic SERP Tasks