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

تنظیم وظایف ‘Search Volume’

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

DataForSEO

​

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

تنظیم وظایف ‘Search Volume’

​

وظیفه حجم جستجوی Bing را در صف قرار می‌دهد و id وظیفه را برمی‌گرداند. پاسخ در پاکت DataForSEO قرار می‌گیرد: داده‌ها در tasks[0].result و نتیجه در tasks[0].status_code — درخواست ردشده نیز همچنان HTTP 200 برمی‌گرداند. با get_dataforseo_keywords_bing_search_volume_fetch واکشی کنید.

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

  • اندازه‌گیری: هزینه گزارش‌شده پاسخ.
  • برآورد درخواست مرجع: 0.06 دلار آمریکا.
  • ضریب مشتری مرجع: 1.0. آن را دوباره روی مبلغ تسویه‌شده مشتری اعمال نکنید.

فقط فراداده مرجع است، نه نقل‌قول حساب، نه قیمت تضمین‌شده و نه سقف هزینه. اعتبار منابع، اعتبار Felo نیست. هزینه‌های نهایی تابع سوابق صورت‌حساب Felo است.

بدنه
application/json
  • نوع: array (object | null)[]
    • date_from
      نوع: string | null

      تاریخ شروع بازه زمانی
      فیلد اختیاری
      اگر این فیلد را تعیین نکنید، داده‌های 12 ماه گذشته ارائه می‌شود
      حداقل مقدار: 24 ماه از تاریخ امروز
      اگر نقطه پایانی Status در فیلد actual_data مقدار false برگرداند، می‌توان date_from را روی ماه قبل از ماه گذشته و پیش‌تر تنظیم کرد؛
      اگر نقطه پایانی Status در فیلد actual_data مقدار true برگرداند، می‌توان date_from را روی ماه گذشته و پیش‌تر تنظیم کرد؛
      قالب تاریخ: "yyyy-mm-dd"
      مثال:
      "2020-01-01"

      نکته: استفاده از بازه زمانی سفارشی برای تاریخ‌های سال گذشته را توصیه نمی‌کنیم

    • date_to
      نوع: string | null

      تاریخ پایان بازه زمانی
      فیلد اختیاری
      اگر این فیلد را تعیین نکنید، داده‌های 12 ماه گذشته ارائه می‌شود؛
      حداقل مقدار: دو سال پیش از تاریخ امروز؛
      حداکثر مقدار: یک ماه از تاریخ امروز؛
      نکته: استفاده از بازه زمانی سفارشی برای تاریخ‌های سال گذشته را توصیه نمی‌کنیم؛
      قالب تاریخ: "yyyy-mm-dd"
      مثال:
      "2020-03-15"

      نکته: استفاده از بازه زمانی سفارشی برای تاریخ‌های سال گذشته را توصیه نمی‌کنیم

    • device
      نوع: string | null

      نوع دستگاه
      فیلد اختیاری
      اگر می‌خواهید داده‌ها را برای نوع دستگاه خاصی دریافت کنید، این فیلد را تعیین کنید. مقادیر ممکن: all، mobile، desktop، tablet
      مقدار پیش‌فرض: all

    • keywords
      نوع: array string[]

      کلمات کلیدی
      فیلد الزامی
      حداکثر تعداد کلمات کلیدی که می‌توانید تعیین کنید: 1000
      حداکثر تعداد نویسه برای هر کلمه کلیدی: 100
      کلمات کلیدی مشخص‌شده به حروف کوچک تبدیل می‌شوند و داده‌ها در آرایه‌ای جداگانه ارائه می‌شود

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

    • language_code
      نوع: string

      کد زبان موتور جستجو
      فیلد الزامی اگر تعیین نکنید language_name
      در صورت استفاده از این فیلد، نیازی به تعیین language_name نیست
      زبان‌های پشتیبانی‌شده:
      en، fr، de

    • language_name
      نوع: string

      نام کامل زبان موتور جستجو
      فیلد الزامی اگر تعیین نکنید language_code
      در صورت استفاده از این فیلد، نیازی به تعیین language_code نیست
      زبان‌های پشتیبانی‌شده:
      English، French، German

    • location_code
      نوع: integer

      کد موقعیت موتور جستجو
      فیلد الزامی اگر تعیین نکنید location_name یا location_coordinate
      در صورت استفاده از این فیلد، نیازی به تعیین location_name یا location_coordinate نیست
      می‌توانید فهرست موقعیت‌های موجود موتورهای جستجو را همراه با location_code آن‌ها با ارسال درخواستی جداگانه به https://api.dataforseo.com/v3/keywords_data/bing/locations دریافت کنید
      مثال:
      2840

    • location_coordinate
      نوع: string

      مختصات GPS یک موقعیت
      فیلد الزامی اگر تعیین نکنید location_name یا location_code
      در صورت استفاده از این فیلد، نیازی به تعیین location_name یا location_code نیست
      پارامتر location_coordinate باید در قالب "latitude,longitude" مشخص شود
      داده‌ها برای کشوری که مختصات مشخص‌شده به آن تعلق دارند ارائه می‌شود
      مثال:
      52.6178549,-155.352142

    • location_name
      نوع: string

      نام کامل موقعیت موتور جستجو
      فیلد الزامی اگر تعیین نکنید location_code یا location_coordinate
      در صورت استفاده از این فیلد، نیازی به تعیین location_code یا location_coordinate نیست
      می‌توانید فهرست موقعیت‌های موجود موتور جستجو را همراه با location_name آن‌ها با ارسال درخواستی جداگانه به https://api.dataforseo.com/v3/keywords_data/bing/locations دریافت کنید
      مثال:
      London,England,United Kingdom

    • 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_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 کدگذاری می‌شود

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

    • search_partners
      نوع: boolean | null

      نوع شرکای جستجوی Bing
      فیلد اختیاری
      اگر true را تعیین کنید، نتایج برای شبکه‌های تحت مالکیت، تحت بهره‌برداری و توزیع‌شده در Bing، Yahoo، AOL و سایت‌های شریکی که میزبان جستجوی Bing، AOL و Yahoo هستند ارائه می‌شود.
      مقدار پیش‌فرض: false — نتایج برای شبکه‌های جستجوی Bing، AOL و Yahoo برگردانده می‌شوند

    • sort_by
      نوع: string | null

      پارامترهای مرتب‌سازی نتایج
      فیلد اختیاری
      از این پارامترها برای مرتب‌سازی نتایج بر اساس search_volume، cpc، competition یا relevance به ترتیب نزولی استفاده کنید
      مقدار پیش‌فرض: relevance

    • tag
      نوع: string | null

      شناسه وظیفه تعریف‌شده توسط کاربر
      فیلد اختیاری
      محدودیت کاراکتر 255 است
      می‌توانید از این پارامتر برای شناسایی وظیفه و تطبیق آن با نتیجه استفاده کنید
      مقدار tag مشخص‌شده را در شیء data پاسخ پیدا می‌کنید

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

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

    • status_code
      نوع: integer | null

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

    • status_message
      نوع: string | null

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

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

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

      • نوع: object | null · Response36Afe1097B20_KeywordsDataBingSearchVolumeTaskPostTaskInfo
        • 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/keywords_data/bing/search_volume/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/search_volume/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "location_name": "United States",
    "language_name": "English",
    "keywords": [
      "average page rpm adsense",
      "adsense blank ads how long",
      "leads and prospects"
    ]
  }
]'
{
  "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 ‘Search Volume’ Tasks