Lists a file's comments. Try it now.
Request
HTTP request
GET https://www.googleapis.com/drive/v3/files/fileId/comments
Parameters
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
fileId |
string |
The ID of the file. |
| Required query parameters | ||
fields |
string |
The paths of the fields you want included in the response. For development you can use the special value * to return all fields, but you'll achieve greater performance by only selecting the fields you need. For more information, see Return specific fields for a file.
|
| Optional query parameters | ||
includeDeleted |
boolean |
Whether to include deleted comments. Deleted comments will not include their original content.
(Default: false)
|
pageSize |
integer |
The maximum number of comments to return per page.
Acceptable values are 1 to 100, inclusive.
(Default: 20)
|
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. |
startModifiedTime |
string |
The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time). |
Authorization
This request allows authorization with at least one of the following scopes:
| Scope |
|---|
https://www.googleapis.com/auth/drive |
https://www.googleapis.com/auth/drive.readonly |
https://www.googleapis.com/auth/drive.file |
Some scopes are restricted and require a security assessment for your app to use them. For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{
"kind": "drive#commentList",
"nextPageToken": string,
"comments": [
comments Resource
]
}
| Property name | Value | Description | Notes |
|---|---|---|---|
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "drive#commentList". |
|
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. | |
comments[] |
list |
The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.