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
|
<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_v3.html">Drive API</a> . <a href="drive_v3.comments.html">comments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(fileId, body)</a></code></p>
<p class="firstline">Creates a new comment on a file.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, commentId)</a></code></p>
<p class="firstline">Deletes a comment.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, commentId, includeDeleted=None)</a></code></p>
<p class="firstline">Gets a comment by ID.</p>
<p class="toc_element">
<code><a href="#list">list(fileId, includeDeleted=None, pageToken=None, startModifiedTime=None, pageSize=None)</a></code></p>
<p class="firstline">Lists a file's comments.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, commentId, body)</a></code></p>
<p class="firstline">Updates a comment with patch semantics.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(fileId, body)</code>
<pre>Creates a new comment on a file.
Args:
fileId: string, The ID of the file. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
"kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
"quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
"mimeType": "A String", # The MIME type of the quoted content.
"value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
},
"htmlContent": "A String", # The content of the comment with HTML formatting.
"id": "A String", # The ID of the comment.
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
"kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
"htmlContent": "A String", # The content of the reply with HTML formatting.
"content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
"createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
"action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
"id": "A String", # The ID of the reply.
},
],
"createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
"anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
}
Returns:
An object of the form:
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
"kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
"quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
"mimeType": "A String", # The MIME type of the quoted content.
"value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
},
"htmlContent": "A String", # The content of the comment with HTML formatting.
"id": "A String", # The ID of the comment.
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
"kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
"htmlContent": "A String", # The content of the reply with HTML formatting.
"content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
"createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
"action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
"id": "A String", # The ID of the reply.
},
],
"createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
"anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(fileId, commentId)</code>
<pre>Deletes a comment.
Args:
fileId: string, The ID of the file. (required)
commentId: string, The ID of the comment. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, commentId, includeDeleted=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, Whether to return deleted comments. Deleted comments will not include their original content.
Returns:
An object of the form:
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
"kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
"quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
"mimeType": "A String", # The MIME type of the quoted content.
"value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
},
"htmlContent": "A String", # The content of the comment with HTML formatting.
"id": "A String", # The ID of the comment.
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
"kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
"htmlContent": "A String", # The content of the reply with HTML formatting.
"content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
"createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
"action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
"id": "A String", # The ID of the reply.
},
],
"createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
"anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId, includeDeleted=None, pageToken=None, startModifiedTime=None, pageSize=None)</code>
<pre>Lists a file's comments.
Args:
fileId: string, The ID of the file. (required)
includeDeleted: boolean, Whether to include deleted comments. Deleted comments will not include their original content.
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
startModifiedTime: string, The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
pageSize: integer, The maximum number of comments to return per page.
Returns:
An object of the form:
{ # A list of comments on a file.
"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.
"kind": "drive#commentList", # Identifies what kind of resource this is. Value: the fixed string "drive#commentList".
"comments": [ # The page of comments.
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
"kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
"quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
"mimeType": "A String", # The MIME type of the quoted content.
"value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
},
"htmlContent": "A String", # The content of the comment with HTML formatting.
"id": "A String", # The ID of the comment.
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
"kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
"htmlContent": "A String", # The content of the reply with HTML formatting.
"content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
"createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
"action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
"id": "A String", # The ID of the reply.
},
],
"createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
"anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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="update">update(fileId, commentId, body)</code>
<pre>Updates a comment with patch semantics.
Args:
fileId: string, The ID of the file. (required)
commentId: string, The ID of the comment. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
"kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
"quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
"mimeType": "A String", # The MIME type of the quoted content.
"value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
},
"htmlContent": "A String", # The content of the comment with HTML formatting.
"id": "A String", # The ID of the comment.
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
"kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
"htmlContent": "A String", # The content of the reply with HTML formatting.
"content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
"createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
"action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
"id": "A String", # The ID of the reply.
},
],
"createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
"anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
}
Returns:
An object of the form:
{ # A comment on a file.
"resolved": True or False, # Whether the comment has been resolved by one of its replies.
"kind": "drive#comment", # Identifies what kind of resource this is. Value: the fixed string "drive#comment".
"modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the comment.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
"quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
"mimeType": "A String", # The MIME type of the quoted content.
"value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
},
"htmlContent": "A String", # The content of the comment with HTML formatting.
"id": "A String", # The ID of the comment.
"content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
"replies": [ # The full list of replies to the comment in chronological order.
{ # A reply to a comment on a file.
"kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
"modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
"author": { # Information about a Drive user. # The user who created the reply.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
"htmlContent": "A String", # The content of the reply with HTML formatting.
"content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
"createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
"action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
"id": "A String", # The ID of the reply.
},
],
"createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
"anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
}</pre>
</div>
</body></html>
|
