Method: comments.list

בתיבת הדו-שיח הזו מפורטים התגובות בקובץ.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
fileId

string

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

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

פרמטרים
includeDeleted

boolean

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

integer

המספר המקסימלי של תגובות שאפשר להחזיר לכל דף.
pageToken

string

האסימון להמשך בקשת רשימה קודמת בדף הבא. יש להגדיר אותו לערך של 'nextPageToken'. מהתשובה הקודמת.
startModifiedTime

string

הערך המינימלי של 'modifiedTime' עבור תגובות לתוצאות (RFC 3339 date-time).

גוף הבקשה

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

גוף התשובה

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

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

ייצוג JSON 
{
  "kind": string,
  "comments": [
    {
      object (Comment)
    }
  ],
  "nextPageToken": string
}
שדות
kind

string

מזהה את סוג המשאב הזה. ערך: המחרוזת הקבועה "drive#commentList".
comments[]

object (Comment)

רשימת התגובות. אם nextPageToken מאוכלס, יכול להיות שהרשימה הזו חלקית וצריך לאחזר דף נוסף של תוצאות.
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

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