docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/drive_v2.comments.html b/docs/dyn/drive_v2.comments.html
index 6f624c4..f1f81f0 100644
--- a/docs/dyn/drive_v2.comments.html
+++ b/docs/dyn/drive_v2.comments.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(fileId, body=None)</a></code></p>
<p class="firstline">Creates a new comment on the given file.</p>
<p class="toc_element">
- <code><a href="#list">list(fileId, includeDeleted=None, pageToken=None, updatedMin=None, maxResults=None)</a></code></p>
+ <code><a href="#list">list(fileId, includeDeleted=None, maxResults=None, pageToken=None, updatedMin=None)</a></code></p>
<p class="firstline">Lists a file's comments.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -119,59 +119,59 @@
An object of the form:
{ # A comment on a file in Google Drive.
- "status": "A String", # 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.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # 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.
- "replies": [ # Replies to this post.
- { # A comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ },
+ "commentId": "A String", # The ID of the comment.
+ "content": "A 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": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A 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.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "deleted": True or False, # 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.
+ "fileId": "A String", # The file which this comment is addressing.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "replies": [ # Replies to this post.
+ { # A comment on a file in Google Drive.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
},
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A 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.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A 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.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "createdDate": "A String", # The date when this reply was first created.
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "replyId": "A String", # The ID of the reply.
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
},
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }</pre>
+ ],
+ "selfLink": "A String", # A link back to this comment.
+ "status": "A String", # 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.
+ }</pre>
</div>
<div class="method">
@@ -184,195 +184,195 @@
The object takes the form of:
{ # A comment on a file in Google Drive.
- "status": "A String", # 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.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # 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.
- "replies": [ # Replies to this post.
- { # A comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ },
+ "commentId": "A String", # The ID of the comment.
+ "content": "A 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": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A 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.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "deleted": True or False, # 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.
+ "fileId": "A String", # The file which this comment is addressing.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "replies": [ # Replies to this post.
+ { # A comment on a file in Google Drive.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
},
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A 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.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A 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.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "createdDate": "A String", # The date when this reply was first created.
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "replyId": "A String", # The ID of the reply.
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
},
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
+ ],
+ "selfLink": "A String", # A link back to this comment.
+ "status": "A String", # 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.
+}
Returns:
An object of the form:
{ # A comment on a file in Google Drive.
- "status": "A String", # 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.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # 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.
- "replies": [ # Replies to this post.
- { # A comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ },
+ "commentId": "A String", # The ID of the comment.
+ "content": "A 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": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A 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.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "deleted": True or False, # 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.
+ "fileId": "A String", # The file which this comment is addressing.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "replies": [ # Replies to this post.
+ { # A comment on a file in Google Drive.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
},
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A 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.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A 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.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "createdDate": "A String", # The date when this reply was first created.
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "replyId": "A String", # The ID of the reply.
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
},
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }</pre>
+ ],
+ "selfLink": "A String", # A link back to this comment.
+ "status": "A String", # 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.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(fileId, includeDeleted=None, pageToken=None, updatedMin=None, maxResults=None)</code>
- <pre>Lists a file's comments.
+ <code class="details" id="list">list(fileId, includeDeleted=None, maxResults=None, pageToken=None, updatedMin=None)</code>
+ <pre>Lists a file's comments.
Args:
fileId: string, The ID of the file. (required)
includeDeleted: boolean, If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
- updatedMin: string, Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
maxResults: integer, The maximum number of discussions to include in the response, used for paging.
+ pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ updatedMin: string, Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
Returns:
An object of the form:
{ # A list of comments on a file in Google Drive.
- "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.
- "items": [ # The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
+ "items": [ # 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 in Google Drive.
- "status": "A String", # 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.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # 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.
- "replies": [ # Replies to this post.
- { # A comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A 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.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A 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.
- },
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
},
+ "commentId": "A String", # The ID of the comment.
+ "content": "A 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": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A 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.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "deleted": True or False, # 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.
+ "fileId": "A String", # The file which this comment is addressing.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "replies": [ # Replies to this post.
+ { # A comment on a file in Google Drive.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "createdDate": "A String", # The date when this reply was first created.
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "replyId": "A String", # The ID of the reply.
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ },
+ ],
+ "selfLink": "A String", # A link back to this comment.
+ "status": "A String", # 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.
+ },
],
- "kind": "drive#commentList", # This is always drive#commentList.
- "selfLink": "A String", # A link back to this list.
- "nextLink": "A String", # A link to the next page of comments.
+ "kind": "drive#commentList", # This is always drive#commentList.
+ "nextLink": "A String", # A link to the next page of comments.
+ "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.
+ "selfLink": "A String", # A link back to this list.
}</pre>
</div>
@@ -385,7 +385,7 @@
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
+ 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.
</pre>
</div>
@@ -401,118 +401,118 @@
The object takes the form of:
{ # A comment on a file in Google Drive.
- "status": "A String", # 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.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # 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.
- "replies": [ # Replies to this post.
- { # A comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ },
+ "commentId": "A String", # The ID of the comment.
+ "content": "A 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": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A 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.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "deleted": True or False, # 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.
+ "fileId": "A String", # The file which this comment is addressing.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "replies": [ # Replies to this post.
+ { # A comment on a file in Google Drive.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
},
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A 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.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A 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.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "createdDate": "A String", # The date when this reply was first created.
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "replyId": "A String", # The ID of the reply.
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
},
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
+ ],
+ "selfLink": "A String", # A link back to this comment.
+ "status": "A String", # 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.
+}
Returns:
An object of the form:
{ # A comment on a file in Google Drive.
- "status": "A String", # 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.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # 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.
- "replies": [ # Replies to this post.
- { # A comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ },
+ "commentId": "A String", # The ID of the comment.
+ "content": "A 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": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A 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.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "deleted": True or False, # 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.
+ "fileId": "A String", # The file which this comment is addressing.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "replies": [ # Replies to this post.
+ { # A comment on a file in Google Drive.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
},
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A 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.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A 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.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "createdDate": "A String", # The date when this reply was first created.
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "replyId": "A String", # The ID of the reply.
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
},
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }</pre>
+ ],
+ "selfLink": "A String", # A link back to this comment.
+ "status": "A String", # 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.
+ }</pre>
</div>
<div class="method">
@@ -526,118 +526,118 @@
The object takes the form of:
{ # A comment on a file in Google Drive.
- "status": "A String", # 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.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # 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.
- "replies": [ # Replies to this post.
- { # A comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ },
+ "commentId": "A String", # The ID of the comment.
+ "content": "A 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": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A 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.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "deleted": True or False, # 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.
+ "fileId": "A String", # The file which this comment is addressing.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "replies": [ # Replies to this post.
+ { # A comment on a file in Google Drive.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
},
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A 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.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A 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.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "createdDate": "A String", # The date when this reply was first created.
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "replyId": "A String", # The ID of the reply.
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
},
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
+ ],
+ "selfLink": "A String", # A link back to this comment.
+ "status": "A String", # 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.
+}
Returns:
An object of the form:
{ # A comment on a file in Google Drive.
- "status": "A String", # 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.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # 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.
- "replies": [ # Replies to this post.
- { # A comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "emailAddress": "A String", # The email address of the user.
+ },
+ "commentId": "A String", # The ID of the comment.
+ "content": "A 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": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A 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.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "deleted": True or False, # 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.
+ "fileId": "A String", # The file which this comment is addressing.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "replies": [ # Replies to this post.
+ { # A comment on a file in Google Drive.
+ "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.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
},
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
},
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A 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.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A 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.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "createdDate": "A String", # The date when this reply was first created.
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "replyId": "A String", # The ID of the reply.
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
},
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }</pre>
+ ],
+ "selfLink": "A String", # A link back to this comment.
+ "status": "A String", # 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.
+ }</pre>
</div>
</body></html>
\ No newline at end of file