REST Resource: comments

Resource: Comment

A comment on a file in Google Drive.

Some resource methods (such as comments.update) require a commentId. Use the comments.list method to retrieve the ID for a comment in a file.

JSON representation 
{
  "commentId": string,
  "kind": string,
  "createdDate": string,
  "modifiedDate": string,
  "fileId": string,
  "status": string,
  "anchor": string,
  "replies": [
    {
      object (CommentReply)
    }
  ],
  "author": {
    object (User)
  },
  "deleted": boolean,
  "selfLink": string,
  "htmlContent": string,
  "content": string,
  "context": {
    "type": string,
    "value": string
  },
  "fileTitle": string
}
Fields
commentId

string

Output only. The ID of the comment.
kind

string

Output only. This is always drive#comment.
createdDate

string

Output only. The date when this comment was first created.
modifiedDate

string

Output only. The date when this comment or any of its replies were last modified.
fileId

string

Output only. The file which this comment is addressing.
status

string

Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status.

  • open - The comment is still open.
  • resolved - The comment has been resolved by one of its replies.
anchor

string

A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies.
replies[]

object (CommentReply)

Output only. Replies to this post.
author

object (User)

Output only. The author of the comment. The author's email address and permission ID will not be populated.
deleted

boolean

Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
htmlContent

string

Output only. HTML formatted content for this comment.
content

string

The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
context

object

The context of the file which is being commented on.
context.type

string

The MIME type of the context snippet.
context.value

string

Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
fileTitle

string

Output only. The title of the file which this comment is addressing.

Methods

delete

 Deletes a comment.

get

 Gets a comment by ID.

insert

 Creates a new comment on the given file.

list

 Lists a file's comments.

patch

 Updates an existing comment.

update

 Updates an existing comment.