Felo API PlatformFelo API Platform
Все эндпоинты DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

Постановка задач Google Maps SERP

Сервер:https://openapi.felo.ai
Клиентские библиотеки

DataForSEO

​

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

Постановка задач Google Maps SERP

​

Ставит в очередь блок карт для локального запроса — рейтинг, адрес и place id каждой организации в 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)[]
    • depth
      Тип: integer | null

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

      необязательное поле

      количество результатов в SERP

      значение по умолчанию: 100

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


      С каждого SERP, содержащего до 100 результатов, с вашего аккаунта взимается плата;

      Установка глубины выше 100 может привести к дополнительным расходам, если поисковая система вернёт больше 100 результатов;

      Стоимость можно рассчитать на странице тарифов.

    • device
      Тип: string | null

      тип устройства

      необязательное поле

      возвращает результаты для определённого типа устройства

      может принимать значения:desktop, mobile

      значение по умолчанию: desktop

      примечание: для устройства mobile для каждого SERP возвращается только 20 результатов

    • keyword
      Тип: string

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

      обязательное поле

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

      все %## будут декодированы (символ «+» декодируется в пробел)

      если в keyword нужен символ «%», укажите его как «%25»;

      если в keyword нужен символ «+», укажите его как «%2B»;

      Подробнее о правилах и ограничениях полей keyword и keywords в API DataForSEO читайте в статье Help Center

    • language_code
      Тип: string

      код языка поисковой системы

      обязательное поле, если не указан language_name

      если используете это поле, language_name указывать не нужно

      список доступных языков поисковой системы и их language_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages

      пример:

      en

    • language_name
      Тип: string

      полное название языка поисковой системы

      обязательное поле, если не указан language_code

      если используете это поле, language_code указывать не нужно

      список доступных языков поисковой системы и их language_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages

      пример:

      English

    • location_code
      Тип: integer

      код местоположения поисковой системы

      обязательное поле, если не указаны location_name или location_coordinate

      если используете это поле, location_name или location_coordinate указывать не нужно

      список доступных местоположений поисковых систем и их location_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations

      пример:

      2840

    • location_coordinate
      Тип: string

      GPS-координаты местоположения

      обязательное поле, если не указаны location_name или location_code

      если используете это поле, location_name или location_code указывать не нужно

      параметр location_coordinate нужно указывать в формате "latitude,longitude,zoom"

      если "zoom" не указан, по умолчанию применяется 17z

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

      минимальное значение для "zoom": 3z

      максимальное значение для "zoom": 21z

      пример:

      52.6178549,-155.352142,20z

    • location_name
      Тип: string

      полное название местоположения поисковой системы

      обязательное поле, если не указаны location_code или location_coordinate

      если используете это поле, location_code или location_coordinate указывать не нужно

      список доступных местоположений поисковой системы с их location_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations

      пример:

      London,England,United Kingdom

    • max_crawl_pages
      Тип: integer | null

      лимит обхода страниц

      необязательное поле

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

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

      Примечание: параметры max_crawl_pages и depth дополняют друг друга;

      подробнее в справочном центре

    • os
      Тип: string | null

      операционная система устройства

      необязательное поле

      если desktop указан в поле device, выбирайте из значений: windows, macos

      значение по умолчанию: windows

      если mobile указан в поле device, выбирайте из значений: android, ios

      значение по умолчанию: android

    • 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

      соответствует функции, использованной для постановки задачи

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

      advanced

    • 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 будут urlencoded;

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


      Подробнее см. в Help Center

    • priority
      Тип: integer | null

      приоритет задачи

      необязательное поле

      может принимать следующие значения:

      1 – обычный приоритет выполнения (устанавливается по умолчанию)

      2 – высокий приоритет выполнения


      За задачи с высоким приоритетом выполнения взимается дополнительная плата.

      Стоимость можно рассчитать на странице тарифов.

    • se_domain
      Тип: string | null

      домен поисковой системы

      необязательное поле

      мы автоматически выбираем подходящий домен поисковой системы в соответствии с указанными местоположением и языком

      однако в этом поле можно задать собственный домен поисковой системы

      пример:

      google.co.uk

    • search_places
      Тип: boolean | null

      режим поиска мест

      необязательное поле

      режим поиска мест позволяет получать результаты Google Maps по определённому месту (например, Apple Store в Нью-Йорке)

      однако из-за особенностей нашего алгоритма извлечения данных этот режим может мешать некоторым запросам с локальным намерением и показывать результаты для местоположения, отличного от указанного в запросе;

      чтобы предотвратить такое вмешательство и получать корректные результаты для ключевых слов с локальным намерением, задайте для этого параметра значение false;значение по умолчанию: true

      Примечание: если режим search_places отключён и в области поиска не найдено результатов, массив results будет пустым

    • search_this_area
      Тип: boolean | null

      показывать результаты из отображаемой области

      необязательное поле

      может принимать значения:true, false

      значение по умолчанию: true

      если задано false, режим search_this_area отключается

      Примечание: если режим search_this_area отключён, в списках Google Maps могут появиться результаты за пределами отображаемой области

    • tag
      Тип: string | null

      пользовательский идентификатор задачи

      необязательное поле

      ограничение — 255 символов

      этот параметр позволяет идентифицировать задачу и сопоставить её с результатом

      указанное значение tag вы найдёте в объекте data ответа

    • url
      Тип: string | null

      прямой URL поискового запроса

      необязательное поле

      вы можете указать прямой URL, и мы разберём его по нужным полям. Учтите, что этот способ самый сложный для обработки нашим API и требует указать в URL точный язык и местоположение. В большинстве случаев мы не рекомендуем этот способ.

      пример:

      https://google.com/maps/search/pizza/@37.09024,-95.712891,4z


      Примечание: следующие параметры поисковой системы не поддерживаются и будут автоматически сброшены, если указаны в URL: allinanchor:, allintext:, allintitle:, allinurl:, cache:, define:, definition:, filetype:, id:, inanchor:, info:, intext:, intitle:, inurl:, link:, site:.
Ответы
  • 200
    Тип: object | null · Response36Afe1097B20_SerpGoogleMapsTaskPostResponseInfo
    • cost
      Тип: number | null Формат: double

      общая стоимость задач, USD

    • status_code
      Тип: integer | null

      общий код состояния. Полный список кодов ответа можно найти здесь.

    • status_message
      Тип: string | null

      общее информационное сообщение. Полный список общих информационных сообщений можно найти здесь.

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

      массив задач

      • Тип: object | null · Response36Afe1097B20_SerpGoogleMapsTaskPostTaskInfo
        • 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
Request Example for post/v1/beta/dataforseo/serp/google/maps/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/maps/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"
  }
]'
{
  "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 Maps SERP Tasks

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