لعرض قائمة بالتعليقات التي تتطابق مع معلمات طلب واجهة برمجة التطبيقات.
تأثير الحصّة: إنّ استدعاء لهذه الطريقة لديه تكلفة حصة وحدة واحدة.
حالات الاستخدام الشائعة
طلب
طلب HTTP
GET https://www.googleapis.com/youtube/v3/comments
المعلَمات
يسرد الجدول التالي المعلمات التي يدعمها طلب البحث هذا. جميع المعلمات المدرجة هي معلمات طلب بحث.
المعلَمات | ||
---|---|---|
المعلّمات المطلوبة | ||
part |
string تحدّد المعلمة part قائمة مفصولة بفواصل لخاصية مورد واحدة أو أكثر من comment التي ستتضمّن استجابة واجهة برمجة التطبيقات.تحتوي القائمة التالية على أسماء part التي يمكنك تضمينها في قيمة المعلّمة:
|
|
الفلاتر (حدد معلمة واحدة من المعلمات التالية) | ||
id |
string تحدّد المعلّمة id قائمة بمعرّفات التعليقات مفصولة بفواصل للموارد التي يتم استردادها. في مورد comment ، تحدّد السمة id رقم تعريف التعليق. |
|
parentId |
string تحدّد المعلّمة parentId رقم تعريف التعليق الذي يجب استرداد الردود عليه. ملاحظة: يتيح YouTube حاليًا استخدام الردود على التعليقات ذات المستوى الأعلى فقط. ومع ذلك، قد يتم دعم الردود على الردود في المستقبل. |
|
المعلّمات الاختيارية | ||
maxResults |
unsigned integer تحدّد المعلمة maxResults الحد الأقصى لعدد العناصر التي يجب عرضها في مجموعة النتائج.ملاحظة: هذه المعلَمة غير متاحة للاستخدام مع المعلّمة id . القيم المقبولة هي 1 إلى 100 ، بما في ذلك القيم الواقعة بينهما. القيمة التلقائية هي 20 . |
|
pageToken |
string تحدّد المعلمة pageToken صفحة محدّدة في مجموعة النتائج التي يجب عرضها. في استجابة واجهة برمجة التطبيقات، تحدد السمة nextPageToken الصفحة التالية من النتيجة التي يمكن استردادها.ملاحظة: هذه المعلَمة غير متاحة للاستخدام مع المعلَمة id . |
|
textFormat |
string تشير هذه المعلّمة إلى ما إذا كان يجب أن تعرض واجهة برمجة التطبيقات تعليقات بتنسيق HTML أو نص عادي. القيمة التلقائية هي html .القيم المقبولة هي:
|
نص الطلب
لا تقدِّم نص طلب عند طلب هذه الطريقة.
الإجابة
إذا نجحت هذه الطريقة، فإنها تعرض نص الاستجابة بالبنية التالية:
{ "kind": "youtube#commentListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ comment Resource ] }
أماكن إقامة
يحدد الجدول التالي الخصائص التي تظهر في هذا المورد:
أماكن إقامة | |
---|---|
kind |
string تحدد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#commentListResponse . |
etag |
etag Etag لهذا المورد. |
nextPageToken |
string الرمز المميّز الذي يمكن استخدامه كقيمة للمعلَمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج |
pageInfo |
object يتضمّن الكائن pageInfo معلومات الصفحات في مجموعة النتائج. |
pageInfo.totalResults |
integer إجمالي عدد النتائج في مجموعة النتائج. |
pageInfo.resultsPerPage |
integer عدد النتائج المضمّنة في استجابة واجهة برمجة التطبيقات. |
items[] |
list قائمة بالتعليقات التي تتطابق مع معايير الطلب. |
الأخطاء
يحدد الجدول التالي رسائل الخطأ التي يمكن أن تعرضها واجهة برمجة التطبيقات ردًا على استدعاء لهذه الطريقة. يرجى الاطلاع على وثائق رسالة الخطأ لمزيد من التفاصيل.
نوع الخطأ | تفاصيل الخطأ | الوصف |
---|---|---|
badRequest (400) |
operationNotSupported |
فلتر المعرّف متوافق فقط مع التعليقات التي تستند إلى Google+. |
forbidden (403) |
forbidden |
لا يمكن استرداد تعليق واحد أو أكثر من التعليقات المطلوبة لأن الأذونات غير كافية. قد يكون الطلب غير مصرح به بشكلٍ صحيح. |
notFound (404) |
commentNotFound |
تعذر العثور على واحد أو أكثر من التعليقات المحددة. تحقّق من قيم معلّمتَي id وparentId للطلب للتأكّد من صحتها. |
جرِّب هذه الميزة الآن.
يمكنك استخدام APIs Explorer لاستدعاء واجهة برمجة التطبيقات هذه والاطّلاع على طلب واجهة برمجة التطبيقات والاستجابة له.