List
|
|||||
|
|
||||
Lists a file's comments
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- See, edit, create, and delete all of your Google Drive files
- View and manage Google Drive files and folders that you have opened or created with this app
- See and download all your Google Drive files
Input
This building block consumes 5 input parameters
| Name | Format | Description |
|---|---|---|
fileId Required |
STRING |
The ID of the file |
includeDeleted |
BOOLEAN |
Whether to include deleted comments. Deleted comments will not include their original content |
pageSize |
INTEGER |
The maximum number of comments to return per page |
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) |
= Parameter name
= Format
|
fileId STRING Required The ID of the file |
|
includeDeleted BOOLEAN Whether to include deleted comments. Deleted comments will not include their original content |
|
pageSize INTEGER The maximum number of comments to return per page |
|
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) |
Output
This building block provides 32 output parameters
| Name | Format | Description |
|---|---|---|
comments[] |
OBJECT |
A comment on a file |
comments[].anchor |
STRING |
A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties |
comments[].author |
OBJECT |
Information about a Drive user |
comments[].author.displayName |
STRING |
A plain text displayable name for this user |
comments[].author.emailAddress |
STRING |
The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester |
comments[].author.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "drive#user" |
comments[].author.me |
BOOLEAN |
Whether this user is the requesting user |
comments[].author.permissionId |
STRING |
The user's ID as visible in Permission resources |
comments[].author.photoLink |
STRING |
A link to the user's profile photo, if available |
comments[].content |
STRING |
The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed |
comments[].createdTime |
DATE_TIME |
The time at which the comment was created (RFC 3339 date-time) |
comments[].deleted |
BOOLEAN |
Whether the comment has been deleted. A deleted comment has no content |
comments[].htmlContent |
STRING |
The content of the comment with HTML formatting |
comments[].id |
STRING |
The ID of the comment |
comments[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "drive#comment" |
comments[].modifiedTime |
DATE_TIME |
The last time the comment or any of its replies was modified (RFC 3339 date-time) |
comments[].quotedFileContent |
OBJECT |
The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment |
comments[].quotedFileContent.mimeType |
STRING |
The MIME type of the quoted content |
comments[].quotedFileContent.value |
STRING |
The quoted content itself. This is interpreted as plain text if set through the API |
comments[].replies[] |
OBJECT |
A reply to a comment on a file |
comments[].replies[].action |
STRING |
The action the reply performed to the parent comment. Valid values are:
|
comments[].replies[].author |
OBJECT |
Information about a Drive user |
comments[].replies[].content |
STRING |
The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified |
comments[].replies[].createdTime |
DATE_TIME |
The time at which the reply was created (RFC 3339 date-time) |
comments[].replies[].deleted |
BOOLEAN |
Whether the reply has been deleted. A deleted reply has no content |
comments[].replies[].htmlContent |
STRING |
The content of the reply with HTML formatting |
comments[].replies[].id |
STRING |
The ID of the reply |
comments[].replies[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "drive#reply" |
comments[].replies[].modifiedTime |
DATE_TIME |
The last time the reply was modified (RFC 3339 date-time) |
comments[].resolved |
BOOLEAN |
Whether the comment has been resolved by one of its replies |
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 |
= Parameter name
= Format
|
comments[] OBJECT A comment on a file |
|
comments[].anchor STRING A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties |
|
comments[].author OBJECT Information about a Drive user |
|
comments[].author.displayName STRING A plain text displayable name for this user |
|
comments[].author.emailAddress STRING The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester |
|
comments[].author.kind STRING Identifies what kind of resource this is. Value: the fixed string "drive#user" |
|
comments[].author.me BOOLEAN Whether this user is the requesting user |
|
comments[].author.permissionId STRING The user's ID as visible in Permission resources |
|
comments[].author.photoLink STRING A link to the user's profile photo, if available |
|
comments[].content STRING The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed |
|
comments[].createdTime DATE_TIME The time at which the comment was created (RFC 3339 date-time) |
|
comments[].deleted BOOLEAN Whether the comment has been deleted. A deleted comment has no content |
|
comments[].htmlContent STRING The content of the comment with HTML formatting |
|
comments[].id STRING The ID of the comment |
|
comments[].kind STRING Identifies what kind of resource this is. Value: the fixed string "drive#comment" |
|
comments[].modifiedTime DATE_TIME The last time the comment or any of its replies was modified (RFC 3339 date-time) |
|
comments[].quotedFileContent OBJECT The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment |
|
comments[].quotedFileContent.mimeType STRING The MIME type of the quoted content |
|
comments[].quotedFileContent.value STRING The quoted content itself. This is interpreted as plain text if set through the API |
|
comments[].replies[] OBJECT A reply to a comment on a file |
|
comments[].replies[].action STRING The action the reply performed to the parent comment. Valid values are:
|
|
comments[].replies[].author OBJECT Information about a Drive user |
|
comments[].replies[].content STRING The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified |
|
comments[].replies[].createdTime DATE_TIME The time at which the reply was created (RFC 3339 date-time) |
|
comments[].replies[].deleted BOOLEAN Whether the reply has been deleted. A deleted reply has no content |
|
comments[].replies[].htmlContent STRING The content of the reply with HTML formatting |
|
comments[].replies[].id STRING The ID of the reply |
|
comments[].replies[].kind STRING Identifies what kind of resource this is. Value: the fixed string "drive#reply" |
|
comments[].replies[].modifiedTime DATE_TIME The last time the reply was modified (RFC 3339 date-time) |
|
comments[].resolved BOOLEAN Whether the comment has been resolved by one of its replies |
|
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 |