Felo API PlatformFelo API Platform
همه endpointهای DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

تنظیم وظایف Google AI Mode SERP

سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت

DataForSEO

​

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

تنظیم وظایف Google AI Mode SERP

​

پاسخ Google AI Mode را برای یک پرس‌وجو، همراه با منابعی که در Google به آن‌ها استناد می‌کند، در صف قرار می‌دهد و id وظیفه را در tasks[0].id برمی‌گرداند. پاسخ در پاکت DataForSEO قرار می‌گیرد: داده‌ها در tasks[0].result و نتیجه در tasks[0].status_code — درخواست ردشده نیز همچنان HTTP 200 برمی‌گرداند. همتای زنده بلافاصله پاسخ می‌دهد و برای یک پرس‌وجوی واحد ساده‌تر است؛ وقتی دسته از یک فراخوانی ابزار فراتر می‌رود از صف استفاده کنید.

مرجع قیمت‌گذاری

  • اندازه‌گیری: هزینه گزارش‌شده پاسخ.
  • برآورد درخواست مرجع: 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 در نتایج پیشرفته

      فیلد اختیاری

      رتبه‌بندی پیکسلی به فاصله بین قطعه نتیجه و گوشه بالا سمت چپ صفحه اشاره دارد؛

      برای اطلاعات بیشتر به مرکز راهنمایی مراجعه کنید>>

      به‌طور پیش‌فرض، این پارامتر روی false تنظیم شده است

      نکته: اگر روی true تنظیم شود، هزینه هر وظیفه در 2 ضرب می‌شود

    • device
      نوع: string | null

      نوع دستگاه

      فیلد اختیاری

      برگرداندن نتایج برای نوع دستگاه مشخص

      می‌تواند مقادیر زیر را داشته باشد:desktop، mobile

      مقدار پیش‌فرض: desktop

    • keyword
      نوع: string

      کلمه کلیدی

      فیلد الزامی

      می‌توانید حداکثر 700 کاراکتر در فیلد keyword مشخص کنید

      همه %## رمزگشایی می‌شوند (کاراکتر '+' به فاصله رمزگشایی می‌شود)

      اگر باید از کاراکتر "%" برای keyword استفاده کنید، آن را به‌صورت "%25" مشخص کنید؛

      اگر باید از کاراکتر "+" برای keyword استفاده کنید، آن را به‌صورت "%2B" مشخص کنید


      درباره قواعد و محدودیت‌های فیلدهای keyword و keywords در APIهای DataForSEO در این مقاله مرکز راهنمایی بیشتر بدانید

    • 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’ را به‌عنوان متغیر $tag کدگذاری‌شده با urlencoded استفاده کنید. مقادیر لازم را پیش از ارسال درخواست تنظیم می‌کنیم.

      مثال:

      http://your-server.com/pingscript?id=$id

      http://your-server.com/pingscript?id=$id&tag=$tag

      نکته: کاراکترهای خاص در pingback_url با urlencoded کدگذاری می‌شوند؛

      از جمله کاراکتر # به %23 کدگذاری می‌شود


      در مرکز راهنمایی ما بیشتر بدانید

    • postback_data
      نوع: string

      نوع داده postback_url

      فیلد الزامی اگر postback_url را مشخص کنید

      با تابعی مطابقت دارد که برای تنظیم وظیفه استفاده کرده‌اید

      مقادیر ممکن:

      advanced، html

    • postback_url
      نوع: string | null

      نشانی URL برای ارسال نتایج وظیفه

      فیلد اختیاری

      وقتی وظیفه تکمیل شد، درخواست POST با نتایج فشرده‌شده در قالب gzip را به postback_url که تعیین کرده‌اید می‌فرستیم

      می‌توانید رشته ‘$id’ را به‌عنوان متغیر $id و ‘$tag’ را به‌عنوان متغیر $tag کدگذاری‌شده با urlencoded استفاده کنید. مقادیر لازم را پیش از ارسال درخواست تنظیم می‌کنیم.

      مثال:

      http://your-server.com/postbackscript?id=$id

      http://your-server.com/postbackscript?id=$id&tag=$tag

      توجه: کاراکترهای خاص در postback_url با urlencoded کدگذاری می‌شوند؛

      از جمله کاراکتر # به %23 کدگذاری می‌شود


      در مرکز راهنمایی ما بیشتر بدانید

    • priority
      نوع: integer | null

      اولویت وظیفه

      فیلد اختیاری

      می‌تواند مقادیر زیر را داشته باشد:

      1 – اولویت اجرای عادی (به‌صورت پیش‌فرض تنظیم می‌شود)

      2 – اولویت اجرای بالا


      برای وظایف با اولویت اجرای بالا هزینه اضافی از شما دریافت می‌شود.

      هزینه را می‌توان در صفحه قیمت‌گذاری محاسبه کرد.

    • tag
      نوع: string | null

      شناسه وظیفه تعریف‌شده توسط کاربر

      فیلد اختیاری

      محدودیت کاراکتر 255 است

      می‌توانید از این پارامتر برای شناسایی وظیفه و تطبیق آن با نتیجه استفاده کنید

      مقدار tag مشخص‌شده را در شیء data پاسخ خواهید یافت

پاسخ‌ها
  • 200
    نوع: object | null · Response36Afe1097B20_SerpGoogleAiModeTaskPostResponseInfo
    • cost
      نوع: number | null قالب: double

      هزینه کل وظایف، دلار آمریکا

    • status_code
      نوع: integer | null

      کد وضعیت عمومی فهرست کامل کدهای پاسخ را اینجا پیدا می‌کنید

    • status_message
      نوع: string | null

      پیام اطلاعاتی عمومی فهرست کامل پیام‌های اطلاعاتی عمومی را اینجا پیدا می‌کنید

    • tasks
      نوع: array (object | null)[] | null

      آرایه‌ای از وظایف

      • نوع: object | null · Response36Afe1097B20_SerpGoogleAiModeTaskPostTaskInfo
        • cost
          نوع: number | null قالب: double

          هزینه کل وظایف، دلار آمریکا

        • 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
Request Example for 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
    }
  ]
}
Setting Google AI Mode SERP Tasks