v0.2.0-beta

OpenAPI 3.1.0

Постановка завдань SERP пошукової реклами Google Ads

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/ads_search/task_post

Постановка завдань SERP пошукової реклами Google Ads

Ставить у чергу оголошення, що показуються за ключовим словом у 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)[]
- advertiser_ids
  Тип: array string[]
  
  ідентифікатори рекламодавців
  
  обов'язкове поле, якщо target не вказано
  
  у цьому масиві можна вказати максимум 25 значень;
  
  значення advertiser_ids для цього параметра можна знайти в ендпоінті Google Ads Advertisers;
- date_from
  Тип: string
  
  початкова дата часового діапазону
  
  необов'язкове поле
  
  обов'язкове поле, якщо вказано date_to;
  
  формат дати: "yyyy-mm-dd"
  
  мінімальне значення: 2018-05-31
  
  максимальне значення: сьогоднішня дата
  
  приклад:
  
  "2020-01-01"
- date_to
  Тип: string
  
  кінцева дата часового діапазону
  
  необов'язкове поле
  
  обов'язкове поле, якщо вказано date_from;
  
  формат дати: "yyyy-mm-dd"
  
  мінімальне значення: 2018-05-31
  
  максимальне значення: сьогоднішня дата
  
  приклад:
  
  "2020-01-01"
- depth
  Тип: integer | null
  
  глибина парсингу
  
  необов'язкове поле
  
  кількість результатів у SERP
  
  значення за замовчуванням: 40
  
  максимальне значення: 700
  
  Оплата стягується за кожен SERP, що містить до 40 результатів;
  Встановлення глибини понад 40 може призвести до додаткових витрат, якщо пошукова система повертає більше 40 результатів;
  
  Вартість можна розрахувати на сторінці Тарифи.
- format
  Тип: string | null
  
  формат оголошення
  
  необов'язкове поле
  
  можливі значення: all, text, image, video
- location_code
  Тип: integer | null
  
  код місцеположення пошукової системи
  
  необов'язкове поле
  
  якщо використовуєте це поле, location_name або location_coordinate вказувати не потрібно
  
  список доступних місцеположень з їхнім location_code можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/ads_search/locations
  
  приклад:
  
  2840
  
  Примітка: якщо не вказати location_name, location_code або location_coordinate, пошук оголошень виконується за всіма доступними місцеположеннями
- location_coordinate
  Тип: string | null
  
  GPS-координати місцеположення
  
  необов'язкове поле
  
  якщо використовуєте це поле, location_name або location_code вказувати не потрібно
  
  приклад:
  
  52.6178549,-155.352142
  
  Примітка: якщо не вказати location_name, location_code або location_coordinate, пошук оголошень виконується за всіма доступними місцеположеннями
- location_name
  Тип: string | null
  
  повна назва місцеположення пошукової системи
  
  необов'язкове поле
  
  якщо використовуєте це поле, location_code або location_coordinate вказувати не потрібно
  
  список доступних місцеположень з їхньою location_name можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/ads_search/locations
  
  приклад:
  
  London,England,United Kingdom
  
  Примітка: якщо не вказати location_name, location_code або location_coordinate, пошук оголошень виконується за всіма доступними місцеположеннями
- 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
- platform
  Тип: string | null
  
  рекламна платформа
  
  необов'язкове поле
  
  можливі значення: all, google_play, google_maps, google_search, google_shopping, youtube
  
  значення за замовчуванням: all
- 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 — високий пріоритет виконання
  
  За завдання з високим пріоритетом виконання стягується додаткова плата.
  Вартість можна розрахувати на сторінці Тарифи.
- tag
  Тип: string | null
  
  визначений користувачем ідентифікатор завдання
  
  необов'язкове поле
  
  обмеження — 255 символів
  
  цей параметр дає змогу ідентифікувати завдання та зіставити його з результатом
  
  вказане значення tag ви знайдете в об'єкті data відповіді
- target
  Тип: string
  
  ім'я домену
  
  обов'язкове поле, якщо advertiser_ids не вказано
  
  ім'я домену, пов'язане з акаунтом рекламодавця

Відповіді

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

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

status_code
Тип: integer | null

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

status_message
Тип: string | null

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

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

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

Тип: object | null · Response36Afe1097B20_SerpGoogleAdsSearchTaskPostTaskInfo
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

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

curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/ads_search/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "location_code": 2840,
    "platform": "google_search",
    "advertiser_ids": [
      "AR13752565271262920705",
      "AR02439908557932462081"
    ]
  }
]'

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

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

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

Постановка завдань SERP пошукової реклами Google Ads

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

DataForSEO

Постановка завдань SERP пошукової реклами Google Ads

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