Method: files.listLabels

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 or shared drive.

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

If successful, the response body contains data with the following structure:

A list of labels applied to a file.

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.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.