create(fileId, body=None)

Creates a new comment on a file.

Args:
  fileId: string, The ID of the file. (required)
  body: object, The request body.
    The object takes the form of:

{ # A comment on a file.
  "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to  Add comments and replies.
  "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A 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.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "me": True or False, # Whether this user is the requesting user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
  "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
  "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
  "htmlContent": "A String", # The content of the comment with HTML formatting.
  "id": "A String", # The ID of the comment.
  "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
  "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
  "quotedFileContent": { # 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.
    "mimeType": "A String", # The MIME type of the quoted content.
    "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
  },
  "replies": [ # The full list of replies to the comment in chronological order.
    { # A reply to a comment on a file.
      "action": "A String", # The action the reply performed to the parent comment. Valid values are:
          # - resolve
          # - reopen
      "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
        "displayName": "A String", # A plain text displayable name for this user.
        "emailAddress": "A 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.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "me": True or False, # Whether this user is the requesting user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
      "content": "A 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.
      "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
      "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
      "htmlContent": "A String", # The content of the reply with HTML formatting.
      "id": "A String", # The ID of the reply.
      "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
      "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
    },
  ],
  "resolved": True or False, # Whether the comment has been resolved by one of its replies.
}


Returns:
  An object of the form:

    { # A comment on a file.
  "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to  Add comments and replies.
  "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A 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.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "me": True or False, # Whether this user is the requesting user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
  "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
  "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
  "htmlContent": "A String", # The content of the comment with HTML formatting.
  "id": "A String", # The ID of the comment.
  "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
  "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
  "quotedFileContent": { # 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.
    "mimeType": "A String", # The MIME type of the quoted content.
    "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
  },
  "replies": [ # The full list of replies to the comment in chronological order.
    { # A reply to a comment on a file.
      "action": "A String", # The action the reply performed to the parent comment. Valid values are:
          # - resolve
          # - reopen
      "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
        "displayName": "A String", # A plain text displayable name for this user.
        "emailAddress": "A 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.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "me": True or False, # Whether this user is the requesting user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
      "content": "A 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.
      "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
      "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
      "htmlContent": "A String", # The content of the reply with HTML formatting.
      "id": "A String", # The ID of the reply.
      "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
      "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
    },
  ],
  "resolved": True or False, # Whether the comment has been resolved by one of its replies.
}

delete(fileId, commentId)

Deletes a comment.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)

get(fileId, commentId, includeDeleted=None)

Gets a comment by ID.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)
  includeDeleted: boolean, Whether to return deleted comments. Deleted comments will not include their original content.

Returns:
  An object of the form:

    { # A comment on a file.
  "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to  Add comments and replies.
  "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A 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.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "me": True or False, # Whether this user is the requesting user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
  "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
  "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
  "htmlContent": "A String", # The content of the comment with HTML formatting.
  "id": "A String", # The ID of the comment.
  "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
  "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
  "quotedFileContent": { # 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.
    "mimeType": "A String", # The MIME type of the quoted content.
    "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
  },
  "replies": [ # The full list of replies to the comment in chronological order.
    { # A reply to a comment on a file.
      "action": "A String", # The action the reply performed to the parent comment. Valid values are:
          # - resolve
          # - reopen
      "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
        "displayName": "A String", # A plain text displayable name for this user.
        "emailAddress": "A 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.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "me": True or False, # Whether this user is the requesting user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
      "content": "A 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.
      "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
      "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
      "htmlContent": "A String", # The content of the reply with HTML formatting.
      "id": "A String", # The ID of the reply.
      "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
      "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
    },
  ],
  "resolved": True or False, # Whether the comment has been resolved by one of its replies.
}

list(fileId, includeDeleted=None, pageSize=None, pageToken=None, startModifiedTime=None)

Lists a file's comments.

Args:
  fileId: string, The ID of the file. (required)
  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).

Returns:
  An object of the form:

    { # A list of comments on a file.
  "comments": [ # The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
    { # A comment on a file.
      "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to  Add comments and replies.
      "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
        "displayName": "A String", # A plain text displayable name for this user.
        "emailAddress": "A 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.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "me": True or False, # Whether this user is the requesting user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
      "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
      "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
      "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
      "htmlContent": "A String", # The content of the comment with HTML formatting.
      "id": "A String", # The ID of the comment.
      "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
      "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
      "quotedFileContent": { # 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.
        "mimeType": "A String", # The MIME type of the quoted content.
        "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
      },
      "replies": [ # The full list of replies to the comment in chronological order.
        { # A reply to a comment on a file.
          "action": "A String", # The action the reply performed to the parent comment. Valid values are:
              # - resolve
              # - reopen
          "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
            "displayName": "A String", # A plain text displayable name for this user.
            "emailAddress": "A 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.
            "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
            "me": True or False, # Whether this user is the requesting user.
            "permissionId": "A String", # The user's ID as visible in Permission resources.
            "photoLink": "A String", # A link to the user's profile photo, if available.
          },
          "content": "A 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.
          "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
          "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
          "htmlContent": "A String", # The content of the reply with HTML formatting.
          "id": "A String", # The ID of the reply.
          "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
          "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
        },
      ],
      "resolved": True or False, # Whether the comment has been resolved by one of its replies.
    },
  ],
  "kind": "drive#commentList", # Identifies what kind of resource this is. Value: the fixed string "drive#commentList".
  "nextPageToken": "A 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.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

update(fileId, commentId, body=None)

Updates a comment with patch semantics.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)
  body: object, The request body.
    The object takes the form of:

{ # A comment on a file.
  "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to  Add comments and replies.
  "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A 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.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "me": True or False, # Whether this user is the requesting user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
  "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
  "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
  "htmlContent": "A String", # The content of the comment with HTML formatting.
  "id": "A String", # The ID of the comment.
  "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
  "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
  "quotedFileContent": { # 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.
    "mimeType": "A String", # The MIME type of the quoted content.
    "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
  },
  "replies": [ # The full list of replies to the comment in chronological order.
    { # A reply to a comment on a file.
      "action": "A String", # The action the reply performed to the parent comment. Valid values are:
          # - resolve
          # - reopen
      "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
        "displayName": "A String", # A plain text displayable name for this user.
        "emailAddress": "A 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.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "me": True or False, # Whether this user is the requesting user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
      "content": "A 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.
      "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
      "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
      "htmlContent": "A String", # The content of the reply with HTML formatting.
      "id": "A String", # The ID of the reply.
      "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
      "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
    },
  ],
  "resolved": True or False, # Whether the comment has been resolved by one of its replies.
}


Returns:
  An object of the form:

    { # A comment on a file.
  "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to  Add comments and replies.
  "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A 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.
    "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
    "me": True or False, # Whether this user is the requesting user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
  "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
  "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
  "htmlContent": "A String", # The content of the comment with HTML formatting.
  "id": "A String", # The ID of the comment.
  "kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
  "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
  "quotedFileContent": { # 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.
    "mimeType": "A String", # The MIME type of the quoted content.
    "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
  },
  "replies": [ # The full list of replies to the comment in chronological order.
    { # A reply to a comment on a file.
      "action": "A String", # The action the reply performed to the parent comment. Valid values are:
          # - resolve
          # - reopen
      "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
        "displayName": "A String", # A plain text displayable name for this user.
        "emailAddress": "A 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.
        "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
        "me": True or False, # Whether this user is the requesting user.
        "permissionId": "A String", # The user's ID as visible in Permission resources.
        "photoLink": "A String", # A link to the user's profile photo, if available.
      },
      "content": "A 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.
      "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
      "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
      "htmlContent": "A String", # The content of the reply with HTML formatting.
      "id": "A String", # The ID of the reply.
      "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
      "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
    },
  ],
  "resolved": True or False, # Whether the comment has been resolved by one of its replies.
}

Drive API . comments

Instance Methods

Method Details