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

تنظیم وظایف ‘Ad Traffic By Keywords’

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

DataForSEO

​

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

تنظیم وظایف ‘Ad Traffic By Keywords’

​

پیش‌بینی کلیک، نمایش و هزینه را برای keywords در bid و نوع match مشخص در صف قرار می‌دهد و id وظیفه را برمی‌گرداند. search_partners شبکه شریکان Google را شامل می‌شود. پاسخ در پاکت DataForSEO قرار می‌گیرد: داده‌ها در tasks[0].result و نتیجه در tasks[0].status_code — درخواست ردشده نیز همچنان HTTP 200 برمی‌گرداند. این تنها نقطه پایانی Google Ads در اینجا بدون نسخه زنده است — پیش‌بینی همیشه در صف قرار می‌گیرد. بازیابی با get_dataforseo_keywords_gads_ad_traffic_fetch.

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

  • اندازه‌گیری: هزینه گزارش‌شده پاسخ.
  • برآورد درخواست مرجع: 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 در فیلد actual_data مقدار false برگرداند، date_from را می‌توان روی ماه قبل از ماه گذشته و پیش‌تر تنظیم کرد؛
      اگر نقطه پایانی Status در فیلد actual_data مقدار true برگرداند، 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 در این مقاله مرکز راهنمایی بیشتر بدانید

    • 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 باید در قالب "latitude,longitude" مشخص شود؛
      داده‌ها برای کشوری ارائه می‌شوند که مختصات مشخص‌شده به آن تعلق دارند؛
      مثال:
      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’ را به‌عنوان متغیر $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 کدگذاری می‌شود

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

    • 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

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

    • status_code
      نوع: integer | null

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

    • status_message
      نوع: string | null

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

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

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

      • نوع: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo
        • 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/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
    }
  ]
}
Setting ‘Ad Traffic By Keywords’ Tasks