CommentThread

Represents a single comment thread inside a presentation.

JSON representation
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "plainTextQuote": string
  // End of mutually exclusive fields.
}
Fields
commentId

string

The unique ID of the comment thread.

anchorId

string

The ID of the CommentAnchor in the presentation that this thread is tied to.

headPost

object (Post)

The first post in the thread.

replies[]

object (Post)

Replies to the head post.

status

enum (Status)

Whether the thread is open or resolved.

The quoted text from the page element when the comment was created. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
plainTextQuote

string

The quoted text from the page element when the comment was created, formatted as plain-text.

End of mutually exclusive fields.

Post

Represents a single post in a comment thread.

JSON representation
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedPresentation": boolean,
  "fromCopiedPresentation": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
Fields
postId

string

Output only. The unique ID of the post.

content

string

The content of the post.

Required to be non-empty if commentAction is not RESOLVE or REOPEN.

This text content will be handled similarly to comments created in the Slides editor. It will have similar behaviors for formatting, notifications, etc.

May not exceed 2048 UTF-8 code units.

contentHtml

string

Output only. The content of the post as HTML.

author

object (PostAuthor)

Output only. The user who created the post.

createTime

string (Timestamp format)

Output only. The time the post was created.

updateTime

string (Timestamp format)

Output only. The time the post was last updated.

deleted

boolean

Output only. Whether the post is deleted. If true, content and author fields will be empty.

fromImportedPresentation

boolean

Output only. Whether the post is from an imported presentation. This field cannot be set directly by callers.

fromCopiedPresentation

boolean

Output only. Whether the post is from a copied presentation. This field cannot be set directly by callers.

assigneeEmail

string

Optional. The email of the user who is being newly assigned to the thread as part of this post.

Returns a 400 bad request error if:

  • The parent thread is a CommentThread whose headPost does not have an assignee.

  • commentAction is specified as RESOLVE or REOPEN.

  • assigneeEmail exceeds 2048 UTF-8 code units.

commentAction

enum (CommentActionType)

Action taken as part of creating the post.

PostAuthor

Represents a user who authored a comment post.

JSON representation
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Fields
displayName

string

The display name of the user. May be absent if the author is anonymous.

me

boolean

Whether the user is the authenticated user making the request.

anonymous

boolean

Whether the user is anonymous.

user

string

The resource name of the post author user, which can also be used to identify the user in the Google People API. Format: users/{user}. Will not be populated if the anonymous field is true or if the post is from an imported presentation.

CommentActionType

The action taken with this reply to a comment thread.

Enums
COMMENT_ACTION_TYPE_UNSPECIFIED Default value. This value is unused.
NO_COMMENT_ACTION_CHANGE No action change in this post.
RESOLVE This post resolves the thread.
REOPEN This post reopens the thread.

Status

The status options of the comment thread.

Enums
STATUS_UNSPECIFIED Default value. This value is unused.
OPEN The comment thread is open.
RESOLVED The comment thread is resolved.