Method: comments.list

نظرات یک فایل را فهرست می‌کند. برای اطلاعات بیشتر، به مدیریت نظرات و پاسخ‌ها مراجعه کنید.

الزامی: پارامتر fields باید تنظیم شود. برای برگرداندن فیلدهای دقیقی که نیاز دارید، به Return specific fields مراجعه کنید.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
fileId

string

شناسه فایل.

پارامترهای پرس و جو

پارامترها
includeDeleted

boolean

اینکه آیا نظرات حذف شده لحاظ شوند یا خیر. نظرات حذف شده محتوای اصلی خود را شامل نخواهند شد.

pageSize

integer

حداکثر تعداد نظراتی که باید برگردانده شود. سرویس ممکن است کمتر از این مقدار را برگرداند.

اگر مشخص نشده باشد، حداکثر ۲۰ نظر برگردانده خواهد شد.

حداکثر مقدار ۱۰۰ است؛ مقادیر بالاتر از ۱۰۰ به اجبار به ۱۰۰ کاهش داده می‌شوند.

pageToken

string

توکن برای ادامه درخواست لیست قبلی در صفحه بعد. این توکن باید روی مقدار 'nextPageToken' از پاسخ قبلی تنظیم شود.

startModifiedTime

string

حداقل مقدار 'modifiedTime' برای نظرات نتیجه (RFC 3339 date-time).

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

فهرستی از نظرات مربوط به یک فایل.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش 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

برخی از حوزه‌ها محدود شده‌اند و برای استفاده برنامه شما از آنها، ارزیابی امنیتی لازم است. برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.