Method: files.listLabels

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

בקשת HTTP

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

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

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

פרמטרים
fileId

string

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

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

פרמטרים
maxResults

integer

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

pageToken

string

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

גוף הבקשה

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

גוף התגובה

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

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

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

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

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