Comments: list

تعرض هذه الطريقة قائمة بالتعليقات التي تتطابق مع مَعلمات طلب بيانات من واجهة برمجة التطبيقات.

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

حالات الاستخدام الشائعة

طلب

طلب HTTP

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

المعلمات

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

المعلمات
المعلمات المطلوبة
part string
تحدّد المَعلمة part قائمة قيم مفصولة بفاصلة تضمّ سمة واحدة أو أكثر من سمات مورد comment التي سيتضمّنها ردّ من واجهة برمجة التطبيقات.

تحتوي القائمة التالية على أسماء part التي يمكنك تضمينها في قيمة المَعلمة:
  • id
  • snippet
الفلاتر (حدِّد مَعلمة واحدة فقط من المَعلمات التالية)
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.

القيم المقبولة هي:
  • html : تعرض التعليقات بتنسيق HTML. هذه هي القيمة الافتراضية.
  • plainText : تعرض التعليقات بتنسيق نص عادي.

نص الطلب

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

الردّ

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

{
  "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 لاستدعاء واجهة برمجة التطبيقات هذه والاطّلاع على طلب بيانات من واجهة برمجة التطبيقات واستجابتها.