CommentThreads: list

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

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

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

الطلب

طلب HTTP

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

المَعلمات

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

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

تتضمّن القائمة التالية أسماء part التي يمكنك تضمينها في قيمة المَعلمة:
  • id
  • replies
  • snippet
الفلاتر (حدِّد إحدى المَعلمات التالية بالضبط)
allThreadsRelatedToChannelId string
توجّه المَعلمة allThreadsRelatedToChannelId واجهة برمجة التطبيقات إلى عرض جميع سلاسل التعليقات المرتبطة بالقناة المحددة.
id string
تحدّد المعلَمة id قائمة مفصولة بفواصل من معرّفات سلاسل التعليقات للموارد التي يجب استردادها.
videoId string
توجّه المَعلمة videoId واجهة برمجة التطبيقات إلى عرض سلاسل محادثات التعليقات المرتبطة بمعرّف الفيديو المحدّد.
المَعلمات الاختيارية
maxResults unsigned integer
تحدّد المعلَمة maxResults الحدّ الأقصى لعدد العناصر التي يجب عرضها في مجموعة النتائج.

ملاحظة: هذه المَعلمة غير متاحة للاستخدام مع مَعلمة id. تتراوح القيم المقبولة بين 1 و100، بما في ذلك القيم الواقعة بينهما. القيمة التلقائية هي 20.
moderationStatus string
لا يمكن استخدام هذه المَعلمة إلا في طلب معتمد بشكل صحيح. اضبط هذه المَعلمة لحصر سلاسل التعليقات المعروضة في حالة إشراف معيّنة.

ملاحظة: لا يمكن استخدام هذه المَعلمة مع المَعلمة id. القيمة التلقائية هي published.

القيم المقبولة هي:
  • heldForReview – استرداد سلاسل التعليقات التي تنتظر المراجعة من قِبل المشرف يمكن تضمين سلسلة تعليقات في الرد إذا كان تعليق المستوى الأعلى أو رد واحد على الأقل على ذلك التعليق في انتظار المراجعة.
  • likelySpam – استرداد سلاسل التعليقات المصنّفة على أنّها يُحتمل أن تكون غير مرغوب فيها يمكن تضمين سلسلة تعليقات في الرد إذا كان من المحتمل أن يكون التعليق ذو المستوى الأعلى أو أحد الردود على ذلك التعليق على الأقل غير مرغوب فيه.
  • published – استرداد سلاسل المحادثات من التعليقات المنشورة هذه هي القيمة الافتراضية. يمكن تضمين سلسلة تعليقات في الرد إذا كان تعليقها ذو المستوى الأعلى قد تم نشره.
order string
تحدّد المعلَمة order الترتيب الذي يجب أن تدرج به استجابة واجهة برمجة التطبيقات سلاسل التعليقات. القيم الصالحة هي:
  • time: يتم ترتيب سلاسل المحادثات من التعليقات حسب الوقت. وهذا هو الخيار التلقائي.
  • relevance: يتم ترتيب سلاسل المحادثات من التعليقات حسب مدى الصلة بموضوع البحث.
ملاحظة: لا يمكن استخدام هذه المَعلمة مع المَعلمة id.
pageToken string
تحدِّد المعلَمة pageToken صفحة معيّنة في مجموعة النتائج يجب عرضها. في استجابة واجهة برمجة التطبيقات، تحدّد السمة nextPageToken الصفحة التالية من النتيجة التي يمكن استردادها.

ملاحظة: هذه المَعلمة غير متاحة للاستخدام مع مَعلمة id.
searchTerms string
توجّه المَعلمة searchTerms واجهة برمجة التطبيقات إلى الحدّ من استجابة واجهة برمجة التطبيقات لتتضمّن فقط التعليقات التي تحتوي على عبارات البحث المحدّدة.

ملاحظة: لا يمكن استخدام هذه المَعلمة مع مَعلمة id.
textFormat string
يمكنك ضبط قيمة هذه المعلَمة على html أو plainText لتوجيه واجهة برمجة التطبيقات إلى عرض تعليقات المستخدمين بتنسيق html أو بتنسيق نص عادي. القيمة التلقائية هي html.

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

نص الطلب

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

الإجابة

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

{
  "kind": "youtube#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread Resource
  ]
}

أماكن إقامة

يحدد الجدول التالي الخصائص التي تظهر في هذا المورد:

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

الأخطاء

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

نوع الخطأ تفاصيل الخطأ الوصف
badRequest (400) operationNotSupported فلتر id متوافق فقط مع التعليقات المستندة إلى +Google.
badRequest (400) processingFailure تعذّر على خادم واجهة برمجة التطبيقات معالجة الطلب بنجاح. وعلى الرغم من أن هذا الخطأ قد يكون عابرًا، إلا أنه يشير عادةً إلى أن ما تم إدخاله في الطلب غير صالح. راجِع بنية مورد commentThread في نص الطلب للتأكّد من أنّه صالح.
forbidden (403) commentsDisabled لقد أوقف الفيديو الذي حددته المعلَمة videoId ميزة التعليقات.
forbidden (403) forbidden يتعذّر استرداد سلسلة واحدة أو أكثر من سلاسل التعليقات المطلوبة بسبب عدم توفّر أذونات كافية. قد يكون الطلب غير مفوَّض بشكل صحيح.
notFound (404) channelNotFound تعذّر العثور على القناة التي حدّدتها المعلَمة allThreadsRelatedToChannelId.
notFound (404) commentThreadNotFound تعذر العثور على سلسلة واحدة أو أكثر من سلاسل التعليقات المحددة. تحقّق من قيم معلَمة id للطلب للتأكّد من صحتها.
notFound (404) videoNotFound تعذّر العثور على الفيديو الذي حدّدته المعلَمة videoId.

تجربة

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