comments

GET /files/{fileId}/comments/{commentId}

Changed on

Gets a comment by ID. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.

Request

  • Base URL
    https://www.googleapis.com/drive/v3
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.file
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.file
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.meet.readonly
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.meet.readonly
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.readonly
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.readonly

Path parameters

fileIdstring required

The ID of the file.

commentIdstring required

The ID of the comment.

Query parameters

includeDeletedboolean

Whether to return deleted comments. Deleted comments will not include their original content.

Response

Successful response

anchorstring

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

assigneeEmailAddressstring

Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.

contentstring

The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.

createdTimestring date-time

The time at which the comment was created (RFC 3339 date-time).

deletedboolean

Output only. Whether the comment has been deleted. A deleted comment has no content.

htmlContentstring

Output only. The content of the comment with HTML formatting.

idstring

Output only. The ID of the comment.

kindstring

Output only. Identifies what kind of resource this is. Value: the fixed string "drive#comment".

mentionedEmailAddressesstring[]

Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.

modifiedTimestring date-time

The last time the comment or any of its replies was modified (RFC 3339 date-time).

resolvedboolean

Output only. Whether the comment has been resolved by one of its replies.

Changes

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2c