v0.2.0-beta

OpenAPI 3.1.0

Настройка задач «Ad Traffic By Keywords»

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/keywords_data/google_ads/ad_traffic_by_keywords/task_post

Настройка задач «Ad Traffic By Keywords»

Ставит в очередь прогноз кликов, показов и расходов для keywords при заданных bid и типе match и возвращает id задачи. search_partners включает партнёрскую сеть Google. Ответ обёрнут в конверт DataForSEO: данные в tasks[0].result, результат в tasks[0].status_code — отклонённый запрос всё равно возвращает HTTP 200. Это единственный эндпоинт Google Ads здесь без live-варианта — прогнозирование всегда идёт через очередь. Получайте результат через get_dataforseo_keywords_gads_ad_traffic_fetch.

Справочная информация о ценах

Тарификация: заявленная стоимость ответа.
Справочная оценка запроса: USD 0.09.
Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.

Только справочные метаданные, а не котировка для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

Тело

application/json

Тип: array (object | null)[]
- bid
  Тип: number
  
  максимальная индивидуальная ставка
  обязательное поле
  собираемые данные будут основаны на этом значении
  оно обозначает цену, которую вы готовы заплатить за объявление; чем выше указанное здесь значение, тем выше значения возвращаемых метрик
  подробнее — в этой статье справочного центра
- date_from
  Тип: string
  
  начальная дата периода прогнозирования
  обязательное поле, если указан date_to
  если указать date_from и date_to, date_interval указывать не нужно
  минимальное значение — завтрашняя дата
  значение в date_from не должно быть позже date_to
  формат даты: "yyyy-mm-dd"
  пример:
  "2021-10-30" если эндпоинт Status возвращает false в поле actual_data, date_from можно установить на позапрошлый месяц и ранее;
  если эндпоинт Status возвращает true в поле actual_data, date_from можно установить на прошлый месяц и ранее
- date_interval
  Тип: string | null
  
  интервал дат прогнозирования
  необязательное поле
  если указать date_interval, date_from и date_to указывать не нужно
  возможные значения: next_week, next_month, next_quarter
  значение по умолчанию: next_month
- date_to
  Тип: string
  
  конечная дата периода прогнозирования
  обязательное поле, если указан date_from
  если указать date_from и date_to, date_interval указывать не нужно
  минимальное значение — date_from +1 день
  максимальное значение — текущий день и месяц следующего года
  формат даты: "yyyy-mm-dd"
  пример:
  "2022-10-30"
- keywords
  Тип: array string[]
  
  ключевые слова
  обязательное поле
  максимальное количество ключевых слов: 1000
  максимальное количество символов в одном ключевом слове: 80
  максимальное количество слов в одной ключевой фразе: 10
  указанные ключевые слова приводятся к нижнему регистру
  Примечание #1: Google Ads может не возвращать данные по некоторым группам ключевых слов;
  Примечание #2: Google Ads предоставляет объединённые значения объёма поиска для групп похожих ключевых слов
  чтобы получить объём поиска для похожих ключевых слов, рекомендуем отправлять такие слова отдельными запросами;
  Примечание #3: Google Ads не допускает использования некоторых символов и знаков (например, UTF-символов, эмодзи), поэтому их нельзя использовать при постановке задачи;
  чтобы узнать, какие символы и знаки допустимы, см. эту статью
  
  Подробнее о правилах и ограничениях полей keyword и keywords в API DataForSEO читайте в статье Help Center
- language_code
  Тип: string | null
  
  код языка поисковой системы
  необязательное поле
  список доступных языков поисковой системы с их language_code можно получить отдельным запросом к https://api.dataforseo.com/v3/keywords_data/google_ads/languages
  пример:
  en
- language_name
  Тип: string | null
  
  полное название языка поисковой системы
  необязательное поле
  список доступных языков поисковой системы с их language_name можно получить отдельным запросом к https://api.dataforseo.com/v3/keywords_data/google_ads/languages
  пример:
  English
- location_code
  Тип: integer | null
  
  код местоположения поисковой системы
  необязательное поле
  если не указать местоположение, вы получите результаты по всему миру, то есть по всем доступным местоположениям;
  если используете это поле, location_name или location_coordinate указывать не нужно;
  список доступных местоположений поисковых систем с их location_code можно получить отдельным запросом к https://api.dataforseo.com/v3/keywords_data/google_ads/locations
  пример:
  2840
- location_coordinate
  Тип: string | null
  
  GPS-координаты местоположения
  необязательное поле
  если не указать местоположение, вы получите результаты по всему миру, то есть по всем доступным местоположениям;
  если используете это поле, location_name или location_code указывать не нужно;
  параметр location_coordinate указывается в формате "широта,долгота";
  данные будут предоставлены для страны, к которой относятся указанные координаты;
  пример:
  52.6178549,-155.352142
- location_name
  Тип: string | null
  
  полное название местоположения поисковой системы
  необязательное поле
  если не указать местоположение, вы получите результаты по всему миру, то есть по всем доступным местоположениям;
  если используете это поле, location_code или location_coordinate указывать не нужно
  список доступных местоположений поисковой системы с их location_name можно получить отдельным запросом к https://api.dataforseo.com/v3/keywords_data/google_ads/locations
  пример:
  London,England,United Kingdom
- match
  Тип: string
  
  тип соответствия ключевых слов
  обязательное поле
  может принимать следующие значения: exact, broad, phrase
- 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_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
- sort_by
  Тип: string | null
  
  параметры сортировки результатов
  необязательное поле
  используйте эти параметры для сортировки результатов по relevance, average_cpc, cost или clicks по убыванию
  значение по умолчанию: relevance
- tag
  Тип: string | null
  
  пользовательский идентификатор задачи
  необязательное поле
  ограничение — 255 символов
  этот параметр позволяет идентифицировать задачу и сопоставить её с результатом
  указанное значение tag вы найдёте в объекте data ответа

Ответы

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

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

status_code
Тип: integer | null

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

status_message
Тип: string | null

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

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

массив задач

Тип: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo
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/keywords_data/google_ads/ad_traffic_by_keywords/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "bid": 999,
    "match": "exact",
    "keywords": [
      "seo marketing"
    ]
  }
]'

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

{
  "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.

Настройка задач «Ad Traffic By Keywords»

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

DataForSEO

Настройка задач «Ad Traffic By Keywords»

Справочная информация о ценах

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