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