Method: comments.list

تعرض هذه الطريقة قائمة بتعليقات ملف. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة إدارة التعليقات والردود.

مطلوب: يجب ضبط المَعلمة fields. لعرض الحقول التي تحتاج إليها بالضبط، يُرجى الاطّلاع على مقالة عرض حقول معيّنة.

طلب HTTP

GET https://www.googleapis.com/drive/v3/files/{fileId}/comments

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
fileId

string

معرّف الملف

معلمات طلب البحث

المعلمات
includeDeleted

boolean

ما إذا كان يجب تضمين التعليقات المحذوفة لن تتضمّن التعليقات المحذوفة محتواها الأصلي.

pageSize

integer

الحد الأقصى لعدد التعليقات المطلوب عرضها قد تعرض الخدمة عددًا أقل من هذا الرقم.

إذا لم يتم تحديد هذه المَعلمة، سيتم عرض 20 تعليقًا على الأكثر.

الحد الأقصى للقيمة هو 100، وسيتم فرض القيمة 100 على القيم التي تزيد عن 100.

pageToken

string

الرمز المميز لمتابعة طلب سابق لعرض قائمة في الصفحة التالية يجب ضبط هذه المَعلمة على قيمة "nextPageToken" من الاستجابة السابقة.

startModifiedTime

string

الحد الأدنى لقيمة "modifiedTime" للتعليقات الناتجة (تاريخ ووقت بتنسيق RFC 3339)

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

قائمة بالتعليقات على ملف

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "comments": [
    {
      object (Comment)
    }
  ],
  "kind": string,
  "nextPageToken": string
}
الحقول
comments[]

object (Comment)

قائمة التعليقات إذا تم ملء nextPageToken، قد تكون هذه القائمة غير مكتملة ويجب جلب صفحة إضافية من النتائج.

kind

string

يحدّد نوع هذا المورد. القيمة: السلسلة الثابتة "drive#commentList".

nextPageToken

string

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

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.meet.readonly
  • https://www.googleapis.com/auth/drive.readonly

بعض النطاقات محظورة وتتطلب إجراء تقييم أمني لتطبيقك كي يتمكّن من استخدامها. لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.