Method: files.listLabels
Stay organized with collections
Save and categorize content based on your preferences.
Lists the labels on a file.
HTTP request
GET https://www.googleapis.com/drive/v2/files/{fileId}/listLabels
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
fileId |
string
The ID for the file.
|
Query parameters
| Parameters |
maxResults |
integer
The maximum number of labels to return per page. When not set, defaults to 100.
|
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.
|
Request body
The request body must be empty.
Response body
A list of labels applied to a file.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"items": [
{
object (Label)
}
],
"nextPageToken": string,
"kind": string
} |
| Fields |
items[] |
object (Label)
The list of labels.
|
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.
|
kind |
string
This is always drive#labelList
|
Authorization scopes
Requires one of the following OAuth scopes:
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
Some scopes are restricted and require a security assessment for your app to use them. For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-03 UTC.
[null,null,["Last updated 2025-04-03 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/v2/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| ``` { \"items\": [ { object (/workspace/drive/api/reference/rest/v2/Label) } ], \"nextPageToken\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `items[]` | `object (`[Label](/workspace/drive/api/reference/rest/v2/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. |\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)."]]
