Method: files.listLabels

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

בקשת HTTP

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

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

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

פרמטרים
fileId

string

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

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

פרמטרים
maxResults

integer

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

string

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

גוף הבקשה

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

גוף התשובה

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

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

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

object (Label)

רשימת התוויות.
nextPageToken

string

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

string

תמיד מדובר בdrive#labelList

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.readonly

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