تخطَّ إلى المحتوى
AR
الحصول على مفتاح API
تصفح الوثائق

مرجع API

YouTube Suggestions API

احصل على مفتاح API

استرجع اقتراحات الإكمال التلقائي من YouTube لكلمة أو عبارة، مع التحكم في اللغة والمنطقة.

إنشاء طلب

Caption or suggestion language code, such as en.

رمز قطري من حرفين، مثل الولايات المتحدة.

POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_suggestions",
    "query": "python",
    "params": {
        "language": "en",
        "region": "us",
    },
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
النتائج في رد HTTPX-API-Key authentication

البارامترات

أرسل source و query على المستوى الأعلى خيارات المصادر تنتمي إلى params. ويمكن إغفال الحقول الاختيارية.

نص الطلب

sourcestring / مطلوب
جاهزون إلى youtube_suggestions.
querystring / مطلوب
ابحثي عن (بريفيكس)
1 إلى 2,000 الشخصياتالتقصير: غير محدد
paramsobject / اختياري
Settings for this request.
التقصير: {}
callback_urlstring · nullable / اختياري
لـ async وbatch فقط. رابط HTTPS عام للإشعار بالاكتمال على المنفذ 443، بطول يصل إلى 2,048 حرفًا، دون بيانات اعتماد مستخدم أو جزء رابط. احذف القيمة أو استخدم null أو سلسلة فارغة لعدم إرسال إشعار. في batch، ضعه في كل استعلام خارج params.
التقصير: غير محدد

المنطقة اللغوية

params.languagestring / اختياري
رمز اللغة.
1 إلى 35 الشخصياتالتقصير: "en"
الشكل المقبول^[A-Za-z0-9-]+$
params.regionstring / اختياري
رمز قطري من حرفين، مثل الولايات المتحدة، GB، أو DE.
بالضبط 2 الشخصياتالتقصير: "US"
الشكل المقبول^[A-Za-z]{2}$

استجابة

Realtime Returns status: done. اقرأ الناتج المصدري في results[0]; usage.credits سجل التهمة.

وتمثل النتائج [0] مجموعة من عبارات البحث المقترحة، لا الأجسام المرئية. ويمكن أن تكون فارغة؛ ولا يوجد شريط فيديو IDs أو عدد خطوبة في هذا الرد.

اقرأ النتيجة

وفّر ردّ شركة JSON الناجح على أنها response.json. احفظ هذا read-response.py و اركضوا بيثون read-response.py. إنها تستخدم فقط Pythonمكتبة عادية ولا تقدم طلباً جديداً

read-response.py
import json
from pathlib import Path

response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
    raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
    print("[]")
    raise SystemExit(0)
result = response["results"][0]

output = result  # An array of phrases, including an empty array.
print(json.dumps(output, ensure_ascii=False, indent=2))

أرسلوا مفترق البحث كسؤال، فاللغة ومنطقة الإرسالتين تنتميان إلى المظلات؛ والأخطاء المتخلفة تقع في الولايات المتحدة. فهي تؤثر على سياق المكمل الآلي، وليس على البيانات الوصفية بالفيديو.

استخدم البحث أو البحث الموسّع مع عبارة مقترحة على أشرطة فيديو discover. والاقتراحات لا تدعم max_results أو مرشحات البحث.

جميع مجالات الاستجابة
الميدانالوصف
sourcestringالمصدر المطلوب من شركة API.
statusstringتم عندما يتكلل الطلب بالنجاح.
created_atstringوقت إنشاء الاستجابة في شكل ISO 8601.
usage.creditsnumberإئتمانات مُقيدة على الطلب، بناءً على خطتك.
results[0]array<string>اقتراحات اكتملت كل دخول للصفوفة عبارة بحث مقترحة.

وتصف المجالات المذكورة أعلاه رد شركة JSON. JSON, plain text and Markdown formats.

Async Returns one job receipt; batch return one per الاستفسار. تحققي من حالة كل وظيفة وإسترجاع نتائجها باستخدام الوصلات العائدة

Async ' batch lifecycle

يعيد الإرسال إيصالًا وليس نتائج. ينشئ Async مهمة واحدة؛ ويعيد batch مهمة مستقلة في queries[] لكل سؤال مقبول تتبع كل وظيفة واسترجاعها بشكل مستقل.

Submit to data.flashdata.dev; قراءــة مركز العمل والنتائج api.flashdata.dev مع نفس X-API-Key. وتستخدم الأمثلة الأساسية للزدحام الزكسكسيك ذات الصلة API Python و cURL.

  1. 1. وفّر الوظيفة IDs

    أبقوا حقول طلب هذا المصدر عند التحول إلى Async. وبالنسبة إلى Batch، وضع كل طلب داخل مجموعة الاستفسارات من جسم JSON. انقذوا كل عمل ID.

    Async Request and receipt · Batch

  2. 2. حالة التحقق

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing: استطلاع مع التأخير والاحترام Retry-After عندما تكون حاضراً completed: تحقيق النتائج failed: التفتيش job.error.

    اقرأ job.statusليس حالة إيصال المعلومات.

    مركز التحقير: Python و cURL

    المرجعي API
  3. 3. نتائج الرسم

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    بعد الإكمال، توثّق النتيجة على النحو التالي، ثمّ تُحضر مخزن 302 URL بدون مفتاحك API. وفّر الرقم JSON في غضون ساعات الإنجاز من تاريخ الـ 24.

    نتائج المشاهدة: Python و cURL · تنسيقات الاستجابة

    Result download API reference

ولا تستهلك السياسات وتحقق النتائج القائمة أي تنازلات للأسئلة. ولا يلغى وقت الاقتراع هذا العمل: فإبقاء مقره ID بدلاً من تقديم عمل مكرر قابل للتعديل. شفرات الرعب وسلوك الاعادة.

إشعارات Webhook عند الاكتمال

Subscribe per query

المجموعة callback_url على أعلى مستوى لطلب الأسينك، أو داخل كل استفسار في دفعة، في الخارج params. ولا يلزم طلب تسجيل منفصل على الشبكة العالمية. ولا تُرسل طلبات شركة Realtime ردوداً.

استخدم عنوان HTTPS عامًا على المنفذ 443. ترسل FlashData إشعار POST لكل مهمة تصل إلى completed أو failed; The event contains links, not the result itself.

الاعتراف والتحقق

العودة 2xx بعد قبول الحدث بشكل مكثف. مُتَوَجَّل delivery_id, كما أُرسلت X-Delivery-Id. لا تتبع إعادة التوجيه.

عمليات التسليم الفاشلة تُعاد مع التراجع المفاجئ، حتى 8 مجموع المحاولات على الأكثر 24 بعد ساعات من الانتهاء. استمر في الاقتراع كتراجع

النداءات غير موقعة. تأكد من معرّف المهمة ومصدرها وحالتها النهائية باستخدام نقطة نهاية الوضع الموثقة قبل تجهيز الإخطار. التسليم ID هو للتحلل، وليس إثبات صحة.

مناسبة وميادين على الشبكة العالمية
الإخطار بالإكمال التوضيحي
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_suggestions",
  "status": "completed",
  "links": [
    {
      "rel": "self",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001",
      "method": "GET"
    },
    {
      "rel": "results",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
      "method": "GET"
    }
  ]
}
الميدانالوصف
delivery_idstringمعرّف تسليم ثابت. امنع تكرار الإشعارات باستخدام هذه القيمة؛ وتُرسل أيضًا في ترويسة X-Delivery-Id.
idstringوظيفة(ب) ID.
sourcestringطلب مصدر بيانات.
statusstringاكتملت أو فشلت
linksarrayوصلات الوضع والنتائج. ولا تشمل الإخطارات محتوى النتائج أو مفتاحاً من طراز API.
links[].relstringذاتي أو نتائج.
links[].hrefstringعنوان URL كامل لواجهة الإدارة؛ صادِق باستخدام مفتاح API.
links[].methodstringGET.

عقد كامل على الشبكة العالمية وقيود URL

التعافي من الأخطاء

لا توجد اقتراحات من أجل الفحوصات المسبقة استجابة فارغة ناجحة. عدل الميول أو اللغة أو المنطقة إذا لزم الأمر؛ ولا تعامل صفيفة فارغة كوظيفة فاشلة.

وللتوثيق، والتوازن، وطريقة الطلب، والإخفاقات في الحد الأقصى للمعدلات، تستخدم مرجع الخطأ المشترك. وقد يكون الوقت المتاح لتقديم الطلبات قد أدى إلى خلق وظيفة؛ والتحقق من العمل القائم قبل إعادة التجريب.

الأخطاء ورموز الحالة · متى يُعيدُ النظر · الحد الأقصى للمعدل

دليل الخطوة خطوة: تحويل الاقتراحات إلى بحث

الأسعار

الخططمعدلات الاستخداملكل 1,000 طلب قياسيالاشتراكاتتشمل الأرصدة الدائنة لكل فترة من فترات إعداد الفواتير
الدفع حسب الاستخدام‏0.50 US$بلا رسوم شهريةأضف رصيدًا عند الحاجة
Micro‏0.40 US$‏49.00 US$ / الشهر1,000 credits (‏50.00 US$ of API usage) included
Starter‏0.35 US$‏199.00 US$ / الشهر4,000 credits (‏200.00 US$ of API usage) included
Pro‏0.30 US$‏499.00 US$ / الشهر10,000 credits (‏500.00 US$ of API usage) included
Scale‏0.25 US$‏999.00 US$ / الشهر20,000 credits (‏1,000.00 US$ of API usage) included
Business‏0.20 US$‏1,999.00 US$ / الشهر40,000 credits (‏2,000.00 US$ of API usage) included

خطة واحدة للحساب. رصيد مشترك للمنتجات الثلاثة. لا تُفرض رسوم مرة أخرى على الاستخدام المغطى بالرصيد المضمّن.

الأسعار والحدود الحالية للخطة