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