Debian Codegraph @

docs/dyn/drive_v3.comments.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="drive_v3.html">Google Drive API</a> . <a href="drive_v3.comments.html">comments</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(fileId, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(fileId, commentId, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).</p>
86 <p class="toc_element">
87 <code><a href="#get">get(fileId, commentId, includeDeleted=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).</p>
89 <p class="toc_element">
90 <code><a href="#list">list(fileId, includeDeleted=None, pageSize=None, pageToken=None, startModifiedTime=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists a file's comments. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#update">update(fileId, commentId, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates a comment with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(fileId, body=None, x__xgafv=None)</code>
106 <pre>Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).
107
108 Args:
109 fileId: string, The ID of the file. (required)
110 body: object, The request body.
111 The object takes the form of:
112
113 { # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.
114 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).
115 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
116 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the comment. The author&#x27;s email address and permission ID will not be populated.
117 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
118 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
119 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
120 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
121 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
122 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
123 },
124 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.
125 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
126 &quot;deleted&quot;: True or False, # Output only. Whether the comment has been deleted. A deleted comment has no content.
127 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the comment with HTML formatting.
128 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the comment.
129 &quot;kind&quot;: &quot;drive#comment&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#comment&quot;`.
130 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
131 &quot;A String&quot;,
132 ],
133 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
134 &quot;quotedFileContent&quot;: { # 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.
135 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
136 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
137 },
138 &quot;replies&quot;: [ # Output only. The full list of replies to the comment in chronological order.
139 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
140 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
141 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
142 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
143 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
144 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
145 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
146 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
147 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
148 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
149 },
150 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.
151 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
152 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
153 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
154 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
155 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
156 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
157 &quot;A String&quot;,
158 ],
159 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
160 },
161 ],
162 &quot;resolved&quot;: True or False, # Output only. Whether the comment has been resolved by one of its replies.
163 }
164
165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170 Returns:
171 An object of the form:
172
173 { # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.
174 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).
175 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
176 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the comment. The author&#x27;s email address and permission ID will not be populated.
177 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
178 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
179 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
180 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
181 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
182 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
183 },
184 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.
185 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
186 &quot;deleted&quot;: True or False, # Output only. Whether the comment has been deleted. A deleted comment has no content.
187 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the comment with HTML formatting.
188 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the comment.
189 &quot;kind&quot;: &quot;drive#comment&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#comment&quot;`.
190 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
191 &quot;A String&quot;,
192 ],
193 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
194 &quot;quotedFileContent&quot;: { # 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.
195 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
196 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
197 },
198 &quot;replies&quot;: [ # Output only. The full list of replies to the comment in chronological order.
199 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
200 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
201 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
202 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
203 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
204 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
205 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
206 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
207 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
208 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
209 },
210 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.
211 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
212 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
213 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
214 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
215 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
216 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
217 &quot;A String&quot;,
218 ],
219 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
220 },
221 ],
222 &quot;resolved&quot;: True or False, # Output only. Whether the comment has been resolved by one of its replies.
223 }</pre>
224 </div>
225
226 <div class="method">
227 <code class="details" id="delete">delete(fileId, commentId, x__xgafv=None)</code>
228 <pre>Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).
229
230 Args:
231 fileId: string, The ID of the file. (required)
232 commentId: string, The ID of the comment. (required)
233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
237 </pre>
238 </div>
239
240 <div class="method">
241 <code class="details" id="get">get(fileId, commentId, includeDeleted=None, x__xgafv=None)</code>
242 <pre>Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).
243
244 Args:
245 fileId: string, The ID of the file. (required)
246 commentId: string, The ID of the comment. (required)
247 includeDeleted: boolean, Whether to return deleted comments. Deleted comments will not include their original content.
248 x__xgafv: string, V1 error format.
249 Allowed values
250 1 - v1 error format
251 2 - v2 error format
252
253 Returns:
254 An object of the form:
255
256 { # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.
257 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).
258 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
259 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the comment. The author&#x27;s email address and permission ID will not be populated.
260 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
261 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
262 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
263 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
264 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
265 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
266 },
267 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.
268 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
269 &quot;deleted&quot;: True or False, # Output only. Whether the comment has been deleted. A deleted comment has no content.
270 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the comment with HTML formatting.
271 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the comment.
272 &quot;kind&quot;: &quot;drive#comment&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#comment&quot;`.
273 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
274 &quot;A String&quot;,
275 ],
276 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
277 &quot;quotedFileContent&quot;: { # 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.
278 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
279 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
280 },
281 &quot;replies&quot;: [ # Output only. The full list of replies to the comment in chronological order.
282 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
283 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
284 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
285 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
286 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
287 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
288 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
289 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
290 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
291 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
292 },
293 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.
294 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
295 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
296 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
297 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
298 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
299 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
300 &quot;A String&quot;,
301 ],
302 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
303 },
304 ],
305 &quot;resolved&quot;: True or False, # Output only. Whether the comment has been resolved by one of its replies.
306 }</pre>
307 </div>
308
309 <div class="method">
310 <code class="details" id="list">list(fileId, includeDeleted=None, pageSize=None, pageToken=None, startModifiedTime=None, x__xgafv=None)</code>
311 <pre>Lists a file&#x27;s comments. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).
312
313 Args:
314 fileId: string, The ID of the file. (required)
315 includeDeleted: boolean, Whether to include deleted comments. Deleted comments will not include their original content.
316 pageSize: integer, The maximum number of comments to return per page.
317 pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of &#x27;nextPageToken&#x27; from the previous response.
318 startModifiedTime: string, The minimum value of &#x27;modifiedTime&#x27; for the result comments (RFC 3339 date-time).
319 x__xgafv: string, V1 error format.
320 Allowed values
321 1 - v1 error format
322 2 - v2 error format
323
324 Returns:
325 An object of the form:
326
327 { # A list of comments on a file.
328 &quot;comments&quot;: [ # The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
329 { # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.
330 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).
331 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
332 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the comment. The author&#x27;s email address and permission ID will not be populated.
333 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
334 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
335 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
336 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
337 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
338 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
339 },
340 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.
341 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
342 &quot;deleted&quot;: True or False, # Output only. Whether the comment has been deleted. A deleted comment has no content.
343 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the comment with HTML formatting.
344 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the comment.
345 &quot;kind&quot;: &quot;drive#comment&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#comment&quot;`.
346 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
347 &quot;A String&quot;,
348 ],
349 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
350 &quot;quotedFileContent&quot;: { # 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.
351 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
352 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
353 },
354 &quot;replies&quot;: [ # Output only. The full list of replies to the comment in chronological order.
355 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
356 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
357 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
358 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
359 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
360 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
361 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
362 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
363 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
364 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
365 },
366 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.
367 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
368 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
369 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
370 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
371 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
372 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
373 &quot;A String&quot;,
374 ],
375 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
376 },
377 ],
378 &quot;resolved&quot;: True or False, # Output only. Whether the comment has been resolved by one of its replies.
379 },
380 ],
381 &quot;kind&quot;: &quot;drive#commentList&quot;, # Identifies what kind of resource this is. Value: the fixed string `&quot;drive#commentList&quot;`.
382 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
383 }</pre>
384 </div>
385
386 <div class="method">
387 <code class="details" id="list_next">list_next()</code>
388 <pre>Retrieves the next page of results.
389
390 Args:
391 previous_request: The request for the previous page. (required)
392 previous_response: The response from the request for the previous page. (required)
393
394 Returns:
395 A request object that you can call &#x27;execute()&#x27; on to request the next
396 page. Returns None if there are no more items in the collection.
397 </pre>
398 </div>
399
400 <div class="method">
401 <code class="details" id="update">update(fileId, commentId, body=None, x__xgafv=None)</code>
402 <pre>Updates a comment with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).
403
404 Args:
405 fileId: string, The ID of the file. (required)
406 commentId: string, The ID of the comment. (required)
407 body: object, The request body.
408 The object takes the form of:
409
410 { # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.
411 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).
412 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
413 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the comment. The author&#x27;s email address and permission ID will not be populated.
414 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
415 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
416 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
417 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
418 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
419 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
420 },
421 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.
422 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
423 &quot;deleted&quot;: True or False, # Output only. Whether the comment has been deleted. A deleted comment has no content.
424 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the comment with HTML formatting.
425 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the comment.
426 &quot;kind&quot;: &quot;drive#comment&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#comment&quot;`.
427 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
428 &quot;A String&quot;,
429 ],
430 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
431 &quot;quotedFileContent&quot;: { # 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.
432 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
433 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
434 },
435 &quot;replies&quot;: [ # Output only. The full list of replies to the comment in chronological order.
436 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
437 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
438 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
439 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
440 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
441 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
442 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
443 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
444 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
445 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
446 },
447 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.
448 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
449 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
450 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
451 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
452 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
453 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
454 &quot;A String&quot;,
455 ],
456 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
457 },
458 ],
459 &quot;resolved&quot;: True or False, # Output only. Whether the comment has been resolved by one of its replies.
460 }
461
462 x__xgafv: string, V1 error format.
463 Allowed values
464 1 - v1 error format
465 2 - v2 error format
466
467 Returns:
468 An object of the form:
469
470 { # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.
471 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).
472 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
473 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the comment. The author&#x27;s email address and permission ID will not be populated.
474 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
475 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
476 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
477 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
478 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
479 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
480 },
481 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.
482 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
483 &quot;deleted&quot;: True or False, # Output only. Whether the comment has been deleted. A deleted comment has no content.
484 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the comment with HTML formatting.
485 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the comment.
486 &quot;kind&quot;: &quot;drive#comment&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#comment&quot;`.
487 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
488 &quot;A String&quot;,
489 ],
490 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
491 &quot;quotedFileContent&quot;: { # 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.
492 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
493 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
494 },
495 &quot;replies&quot;: [ # Output only. The full list of replies to the comment in chronological order.
496 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
497 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
498 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
499 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
500 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
501 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
502 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
503 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
504 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
505 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
506 },
507 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.
508 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
509 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
510 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
511 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
512 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
513 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
514 &quot;A String&quot;,
515 ],
516 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
517 },
518 ],
519 &quot;resolved&quot;: True or False, # Output only. Whether the comment has been resolved by one of its replies.
520 }</pre>
521 </div>
522
523 </body></html>