Method: comments.list

הצגת רשימה של התגובות לקובץ.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
fileId

string

המזהה של הקובץ.

פרמטרים של שאילתה

פרמטרים
includeDeleted

boolean

אם תגדירו את האפשרות הזו, כל התגובות והתשובות, כולל תגובות ותשובות שנמחקו (ללא התוכן), יוחזרו.

maxResults

integer

המספר המקסימלי של דיונים שייכללו בתשובה, לשימוש בהחלפת דפים.

pageToken

string

אסימון ההמשך, שמשמש לעימוד של קבוצות גדולות של תוצאות. כדי לקבל את דף התוצאות הבא, מגדירים את הפרמטר הזה לערך של nextPageToken מהתגובה הקודמת.

updatedMin

string

יוחזרו רק דיונים שעודכנו אחרי חותמת הזמן הזו. הפורמט הוא חותמת זמן RFC 3339.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

רשימה של תגובות על קובץ ב-Google Drive.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "items": [
    {
      object (Comment)
    }
  ],
  "kind": string,
  "selfLink": string,
  "nextLink": string,
  "nextPageToken": string
}
שדות
items[]

object (Comment)

רשימת התגובות. אם הערך של nextPageToken מאוכלס, יכול להיות שהרשימה הזו לא מלאה וצריך לאחזר דף נוסף של תוצאות.

kind

string

הערך הזה הוא תמיד drive#commentList.

nextPageToken

string

אסימון הדף של הדף הבא של התגובות. השדה הזה לא יופיע אם הגעתם לסוף רשימת התגובות. אם האסימון נדחה מסיבה כלשהי, צריך להשליך אותו ולהתחיל מחדש את העימוד מהדף הראשון של התוצאות.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/docs
  • 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

חלק מההיקפים מוגבלים ונדרשת הערכת אבטחה כדי שהאפליקציה תוכל להשתמש בהם. מידע נוסף זמין במדריך ההרשאות.