Method: comments.list

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

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

בקשת HTTP

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

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

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

פרמטרים
fileId

string

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

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

פרמטרים
includeDeleted

boolean

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

integer

מספר התגובות המקסימלי שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה.

אם לא מציינים ערך, יוחזרו לכל היותר 20 תגובות.

הערך המקסימלי הוא 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

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