v0.2.0-beta

OpenAPI 3.1.0

Постановка завдань Google AI Mode SERP

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

Постановка завдань Google AI Mode SERP

Ставить у чергу відповідь AI Mode 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
  
  Примітка: якщо задати true, вартість завдання множиться на 2
- device
  Тип: string | null
  
  тип пристрою
  
  необов'язкове поле
  
  повертати результати для певного типу пристрою
  
  може набувати значень:desktop, mobile
  
  значення за замовчуванням: desktop
- 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/google/ai_mode/languages
- language_name
  Тип: string
  
  повна назва мови пошукової системи
  
  обов'язкове поле, якщо не вказано language_code;
  
  якщо використовуєте це поле, language_code вказувати не потрібно;
  
  список доступних мов з їхньою language_name можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/ai_mode/languages;
- location_code
  Тип: integer
  
  код місцезнаходження пошукової системи
  
  обов'язкове поле, якщо не вказано location_name або location_coordinate
  
  якщо використовуєте це поле, location_name або location_coordinate вказувати не потрібно
  
  список доступних місцезнаходжень пошукових систем і відповідних location_code можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/locations
  
  Примітка: список країн, де AI Mode зараз доступний, див. у Google Search Help
- location_coordinate
  Тип: string
  
  GPS-координати місцезнаходження
  
  обов'язкове поле, якщо не вказано location_name або location_code
  
  якщо використовуєте це поле, location_name або location_code вказувати не потрібно
  
  параметр location_coordinate потрібно вказувати у форматі "latitude,longitude,zoom"
  
  якщо "zoom" не вказано, за замовчуванням застосовується 9z
  
  максимальна кількість десяткових знаків для "latitude" і "longitude": 7
  
  мінімальне значення для "zoom": 4z
  
  максимальне значення для "zoom": 18z
  
  приклад:
  
  52.6178549,-155.352142,18z
- location_name
  Тип: string
  
  повна назва місцезнаходження пошукової системи
  
  обов'язкове поле, якщо не вказано location_code або location_coordinate
  
  якщо використовуєте це поле, location_code або location_coordinate вказувати не потрібно
  
  список доступних місцезнаходжень пошукової системи й відповідних location_name можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/locations
  
  Примітка: список країн, де AI Mode зараз доступний, див. у Google Search Help
- 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, 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 буде urlencoded;
  
  зокрема, символ # кодується як %23
  
  Докладніше див. в Help Center
- priority
  Тип: integer | null
  
  пріоритет завдання
  
  необов'язкове поле
  
  може приймати такі значення:
  
  1 – звичайний пріоритет виконання (встановлюється за замовчуванням)
  
  2 – високий пріоритет виконання
  
  За завдання з високим пріоритетом виконання стягується додаткова плата.
  Вартість можна розрахувати на сторінці тарифів.
- tag
  Тип: string | null
  
  визначений користувачем ідентифікатор завдання
  
  необов'язкове поле
  
  обмеження — 255 символів
  
  цей параметр дає змогу ідентифікувати завдання та зіставити його з результатом
  
  вказане значення tag ви знайдете в об'єкті data відповіді

Відповіді

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

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

status_code
Тип: integer | null

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

status_message
Тип: string | null

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

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

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

Тип: object | null · Response36Afe1097B20_SerpGoogleAiModeTaskPostTaskInfo
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/ai_mode/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/ai_mode/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "what is google ai mode"
  }
]'

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

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

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

Постановка завдань Google AI Mode SERP

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

DataForSEO

Постановка завдань Google AI Mode SERP

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