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 Операции

post/v1/beta/dataforseo/serp/google/organic/task_post

Постановка задач органической выдачи 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

Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

application/json

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
    }
  ]
}

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

Нужна помощь?

По вопросам API, оплаты и аккаунта пишите в поддержку.
Общайтесь с разработчиками Felo в Discord.
Загляните в наш журнал изменений.
Нужны цены за объём или помощь с закупкой? Связаться с отделом продаж.
Создаёте на LLM? Прочитайте llms.txt.

Постановка задач органической выдачи Google

АутентификацияRequired

DataForSEO

Постановка задач органической выдачи Google

Справочные цены

Нужна помощь?