تم إيقاف العمل بمورد
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 . استخدم طريقة guideCategory.list لاسترداد قائمة بالقيم الصالحة. |
جرِّب هذه الميزة الآن.
يمكنك استخدام APIs Explorer لاستدعاء واجهة برمجة التطبيقات هذه والاطّلاع على طلب واجهة برمجة التطبيقات والاستجابة له.