Method: comments.list

Lists a file's comments.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
fileId

string

The ID of the file.

Query parameters

Parameters
includeDeleted

boolean

If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
maxResults

integer

The maximum number of discussions to include in the response, used for paging.
pageToken

string

The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
updatedMin

string

Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.

Request body

The request body must be empty.

Response body

A list of comments on a file in Google Drive.

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

JSON representation 
{
  "kind": string,
  "selfLink": string,
  "nextLink": string,
  "items": [
    {
      object (Comment)
    }
  ],
  "nextPageToken": string
}
Fields
kind

string

This is always drive#commentList.
items[]

object (Comment)

The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
nextPageToken

string

The page token for the next page of comments. This will be absent if the end of the comments 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.

Authorization scopes

Requires one of the following OAuth scopes:

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

Some scopes are restricted and require a security assessment for your app to use them. For more information, see the Authorization guide.