GuideCategories: list

ملاحظة: هذا إشعار بإيقاف نهائي.

تم إيقاف كل من مورد guideCategories وطريقة guideCategories.list نهائيًا اعتبارًا من 9 سبتمبر 2020.

تعرض هذه الطريقة قائمة بالفئات التي يمكن ربطها بقنوات YouTube.

تأثير الحصة: تبلغ تكلفة الحصة لطلب البيانات من هذه الطريقة وحدة واحدة.

طلب

طلب HTTP

GET https://www.googleapis.com/youtube/v3/guideCategories

المعلمات

يسرد الجدول أدناه المَعلمات التي يتيحها طلب البحث هذا. جميع المَعلمات المُدرَجة هي مَعلمات طلب بحث.

المعلمات
المَعلمات المطلوبة
part string
تحدّد المَعلمة part خصائص المورد guideCategory التي سيتضمّنها ردّ واجهة برمجة التطبيقات. اضبط قيمة المَعلمة على snippet.
الفلاتر (حدِّد مَعلمة واحدة فقط من المَعلمات التالية)
id string
تحدّد المَعلمة id قائمة بمعرّفات فئات قنوات YouTube مفصولة بفواصل للموارد التي يتم استردادها. في مورد guideCategory، تحدّد السمة id رقم تعريف فئة قناة YouTube.
regionCode string
تطلب المَعلمة regionCode من واجهة برمجة التطبيقات عرض قائمة بفئات الدليل المتوفّرة في البلد المحدّد. قيمة المَعلمة هي رمز البلد وفقًا لمعيار ISO 3166-1 alpha-2.
المَعلمات الاختيارية
hl string
تحدّد المَعلمة hl اللغة التي سيتم استخدامها للقيم النصية في استجابة واجهة برمجة التطبيقات. القيمة التلقائية هي en-US.

نص الطلب

لا تقدِّم نص طلب عند استدعاء هذه الطريقة.

الردّ

في حال نجاح العملية، تعرض هذه الطريقة نص استجابة بالبنية التالية:

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory resource
  ]
}

الخصائص

يحدّد الجدول التالي السمات التي تظهر في هذا المرجع:

الخصائص
kind string
تحدّد هذه السمة نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#guideCategoryListResponse.
etag etag
تمثّل هذه السمة علامة Etag الخاصة بهذا المرجع.
nextPageToken string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج.
prevPageToken string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة السابقة في مجموعة النتائج.
pageInfo object
يحتوي العنصر pageInfo على معلومات حول تقسيم مجموعة النتائج إلى صفحات.
pageInfo.totalResults integer
تمثّل هذه السمة إجمالي عدد النتائج في مجموعة النتائج.
pageInfo.resultsPerPage integer
عدد النتائج المُضمَّنة في الردّ من واجهة برمجة التطبيقات.
items[] list
قائمة بالفئات التي يمكن ربطها بقنوات YouTube. في هذه الخريطة، يكون معرّف الفئة هو مفتاح الخريطة، وتكون قيمته هي مورد guideCategory المقابل.

الأخطاء

يوضّح الجدول أدناه رسائل الخطأ التي يمكن أن تعرضها واجهة برمجة التطبيقات ردًا على طلب تم إرساله إلى هذه الطريقة. يُرجى الاطّلاع على مستندات رسالة الخطأ لمزيد من التفاصيل.

نوع الخطأ تفاصيل الخطأ الوصف
notFound (404) notFound لا يمكن العثور على فئة الدليل المحدّدة بواسطة المَعلمة id. استخدِم طريقة guideCategories.list لاسترداد قائمة بالقيم الصالحة.

جرّب الآن

استخدِم APIs Explorer لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب البيانات والاستجابة.