Method: comments.list

הצגת רשימה של התגובות לקובץ. מידע נוסף על ניהול תגובות ותשובות

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

בקשת HTTP

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

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

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

פרמטרים
fileId

string

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

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

פרמטרים
includeDeleted

boolean

האם לכלול תגובות שנמחקו. התוכן המקורי לא ייכלל בתגובות שנמחקו.
pageSize

integer

המספר המקסימלי של תגובות שיוחזרו בכל דף.
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

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