1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v2.html">Google Drive API</a> . <a href="drive_v2.comments.html">comments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, commentId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a comment.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, commentId, includeDeleted=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a comment by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(fileId, body=None, x__xgafv=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, maxResults=None, pageToken=None, updatedMin=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a file's comments.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(fileId, commentId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing comment.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, commentId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing comment.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(fileId, commentId, x__xgafv=None)</code>
<pre>Deletes a comment.
Args:
fileId: string, The ID of the file. (required)
commentId: string, The ID of the comment. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, commentId, includeDeleted=None, x__xgafv=None)</code>
<pre>Gets a comment by ID.
Args:
fileId: string, The ID of the file. (required)
commentId: string, The ID of the comment. (required)
includeDeleted: boolean, If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A comment on a file in Google Drive. 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.
"anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).
"author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"commentId": "A String", # Output only. 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, # Output only. 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", # Output only. The file which this comment is addressing.
"fileTitle": "A String", # Output only. The title of the file which this comment is addressing.
"htmlContent": "A String", # Output only. HTML formatted content for this comment.
"kind": "drive#comment", # Output only. This is always `drive#comment`.
"modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
"replies": [ # Output only. Replies to this post.
{ # A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
"author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. 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, # Output only. 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", # Output only. HTML formatted content for this reply.
"kind": "drive#commentReply", # Output only. This is always `drive#commentReply`.
"modifiedDate": "A String", # The date when this reply was last modified.
"replyId": "A String", # Output only. 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", # Output only. A link back to this comment.
"status": "A String", # Output only. 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="insert">insert(fileId, body=None, x__xgafv=None)</code>
<pre>Creates a new comment on the given file.
Args:
fileId: string, The ID of the file. (required)
body: object, The request body.
The object takes the form of:
{ # A comment on a file in Google Drive. 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.
"anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).
"author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"commentId": "A String", # Output only. 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, # Output only. 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", # Output only. The file which this comment is addressing.
"fileTitle": "A String", # Output only. The title of the file which this comment is addressing.
"htmlContent": "A String", # Output only. HTML formatted content for this comment.
"kind": "drive#comment", # Output only. This is always `drive#comment`.
"modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
"replies": [ # Output only. Replies to this post.
{ # A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
"author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. 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, # Output only. 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", # Output only. HTML formatted content for this reply.
"kind": "drive#commentReply", # Output only. This is always `drive#commentReply`.
"modifiedDate": "A String", # The date when this reply was last modified.
"replyId": "A String", # Output only. 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", # Output only. A link back to this comment.
"status": "A String", # Output only. 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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A comment on a file in Google Drive. 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.
"anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).
"author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"commentId": "A String", # Output only. 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, # Output only. 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", # Output only. The file which this comment is addressing.
"fileTitle": "A String", # Output only. The title of the file which this comment is addressing.
"htmlContent": "A String", # Output only. HTML formatted content for this comment.
"kind": "drive#comment", # Output only. This is always `drive#comment`.
"modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
"replies": [ # Output only. Replies to this post.
{ # A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
"author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. 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, # Output only. 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", # Output only. HTML formatted content for this reply.
"kind": "drive#commentReply", # Output only. This is always `drive#commentReply`.
"modifiedDate": "A String", # The date when this reply was last modified.
"replyId": "A String", # Output only. 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", # Output only. A link back to this comment.
"status": "A String", # Output only. 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, maxResults=None, pageToken=None, updatedMin=None, x__xgafv=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.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of comments on a file in Google Drive.
"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. 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.
"anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).
"author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"commentId": "A String", # Output only. 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, # Output only. 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", # Output only. The file which this comment is addressing.
"fileTitle": "A String", # Output only. The title of the file which this comment is addressing.
"htmlContent": "A String", # Output only. HTML formatted content for this comment.
"kind": "drive#comment", # Output only. This is always `drive#comment`.
"modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
"replies": [ # Output only. Replies to this post.
{ # A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
"author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. 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, # Output only. 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", # Output only. HTML formatted content for this reply.
"kind": "drive#commentReply", # Output only. This is always `drive#commentReply`.
"modifiedDate": "A String", # The date when this reply was last modified.
"replyId": "A String", # Output only. 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", # Output only. A link back to this comment.
"status": "A String", # Output only. 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`.
"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>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(fileId, commentId, body=None, x__xgafv=None)</code>
<pre>Updates an existing comment.
Args:
fileId: string, The ID of the file. (required)
commentId: string, The ID of the comment. (required)
body: object, The request body.
The object takes the form of:
{ # A comment on a file in Google Drive. 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.
"anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).
"author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"commentId": "A String", # Output only. 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, # Output only. 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", # Output only. The file which this comment is addressing.
"fileTitle": "A String", # Output only. The title of the file which this comment is addressing.
"htmlContent": "A String", # Output only. HTML formatted content for this comment.
"kind": "drive#comment", # Output only. This is always `drive#comment`.
"modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
"replies": [ # Output only. Replies to this post.
{ # A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
"author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. 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, # Output only. 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", # Output only. HTML formatted content for this reply.
"kind": "drive#commentReply", # Output only. This is always `drive#commentReply`.
"modifiedDate": "A String", # The date when this reply was last modified.
"replyId": "A String", # Output only. 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", # Output only. A link back to this comment.
"status": "A String", # Output only. 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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A comment on a file in Google Drive. 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.
"anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).
"author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"commentId": "A String", # Output only. 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, # Output only. 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", # Output only. The file which this comment is addressing.
"fileTitle": "A String", # Output only. The title of the file which this comment is addressing.
"htmlContent": "A String", # Output only. HTML formatted content for this comment.
"kind": "drive#comment", # Output only. This is always `drive#comment`.
"modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
"replies": [ # Output only. Replies to this post.
{ # A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
"author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. 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, # Output only. 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", # Output only. HTML formatted content for this reply.
"kind": "drive#commentReply", # Output only. This is always `drive#commentReply`.
"modifiedDate": "A String", # The date when this reply was last modified.
"replyId": "A String", # Output only. 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", # Output only. A link back to this comment.
"status": "A String", # Output only. 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="update">update(fileId, commentId, body=None, x__xgafv=None)</code>
<pre>Updates an existing comment.
Args:
fileId: string, The ID of the file. (required)
commentId: string, The ID of the comment. (required)
body: object, The request body.
The object takes the form of:
{ # A comment on a file in Google Drive. 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.
"anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).
"author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"commentId": "A String", # Output only. 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, # Output only. 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", # Output only. The file which this comment is addressing.
"fileTitle": "A String", # Output only. The title of the file which this comment is addressing.
"htmlContent": "A String", # Output only. HTML formatted content for this comment.
"kind": "drive#comment", # Output only. This is always `drive#comment`.
"modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
"replies": [ # Output only. Replies to this post.
{ # A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
"author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. 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, # Output only. 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", # Output only. HTML formatted content for this reply.
"kind": "drive#commentReply", # Output only. This is always `drive#commentReply`.
"modifiedDate": "A String", # The date when this reply was last modified.
"replyId": "A String", # Output only. 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", # Output only. A link back to this comment.
"status": "A String", # Output only. 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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A comment on a file in Google Drive. 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.
"anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).
"author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. A URL that points to a profile picture of this user.
},
},
"commentId": "A String", # Output only. 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, # Output only. 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", # Output only. The file which this comment is addressing.
"fileTitle": "A String", # Output only. The title of the file which this comment is addressing.
"htmlContent": "A String", # Output only. HTML formatted content for this comment.
"kind": "drive#comment", # Output only. This is always `drive#comment`.
"modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
"replies": [ # Output only. Replies to this post.
{ # A comment on a file in Google Drive. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
"author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output only. 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, # Output only. 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", # Output only. HTML formatted content for this reply.
"kind": "drive#commentReply", # Output only. This is always `drive#commentReply`.
"modifiedDate": "A String", # The date when this reply was last modified.
"replyId": "A String", # Output only. 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", # Output only. A link back to this comment.
"status": "A String", # Output only. 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>
|
