Method: files.listLabels
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בקשת HTTP
GET https://www.googleapis.com/drive/v3/files/{fileId}/listLabels
כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.
פרמטרים של נתיב
| פרמטרים |
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.meet.readonly
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.readonly
יש היקפי הרשאות מוגבלים שנדרשת הערכת אבטחה כדי להשתמש בהם באפליקציה. מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-27 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-27 (שעון UTC)."],[],[],null,["# Method: files.listLabels\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.LabelList.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the labels on a file.\n\n### HTTP request\n\n`GET https://www.googleapis.com/drive/v3/files/{fileId}/listLabels`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------|\n| `fileId` | `string` The ID for the file. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer` The maximum number of labels to return per page. When not set, defaults to 100. |\n| `pageToken` | `string` The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA list of labels applied to a file.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"labels\": [ { object (/workspace/drive/api/reference/rest/v3/Label) } ], \"nextPageToken\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `labels[]` | `object (`[Label](/workspace/drive/api/reference/rest/v3/Label)`)` The list of labels. |\n| `nextPageToken` | `string` The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. |\n| `kind` | `string` This is always drive#labelList |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive`\n- `\n https://www.googleapis.com/auth/drive.file`\n- `\n https://www.googleapis.com/auth/drive.meet.readonly`\n- `\n https://www.googleapis.com/auth/drive.metadata`\n- `\n https://www.googleapis.com/auth/drive.metadata.readonly`\n- `\n https://www.googleapis.com/auth/drive.readonly`\n\nSome scopes are restricted and require a security assessment for your app to use them. For more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
