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
|
<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="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.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(id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new resource into this collection.</p>
<p class="toc_element">
<code><a href="#list">list(part, id=None, maxResults=None, pageToken=None, parentId=None, textFormat=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</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="#markAsSpam">markAsSpam(id, x__xgafv=None)</a></code></p>
<p class="firstline">Expresses the caller's opinion that one or more comments should be flagged as spam.</p>
<p class="toc_element">
<code><a href="#setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the moderation status of one or more comments.</p>
<p class="toc_element">
<code><a href="#update">update(part, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing resource.</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(id, x__xgafv=None)</code>
<pre>Deletes a resource.
Args:
id: string, A parameter (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="insert">insert(part, body=None, x__xgafv=None)</code>
<pre>Inserts a new resource into this collection.
Args:
part: string, The *part* parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A *comment* represents a single YouTube comment.
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the comment.
"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
"authorChannelId": { # Contains the id of the author's YouTube channel, if any.
"value": "A String", # The id of the author's YouTube channel.
},
"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorDisplayName": "A String", # The name of the user who posted the comment.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
"canRate": True or False, # Whether the current viewer can rate this comment.
"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel.
"likeCount": 42, # The total number of likes this comment has received.
"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"parentId": "A String", # The unique id of the top-level comment, only set for replies.
"postId": "A String", # The ID of the post the comment refers to, if any.
"publishedAt": "A String", # The date and time when the comment was originally published.
"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
"updatedAt": "A String", # The date and time when the comment was last updated.
"videoId": "A String", # The ID of the video the comment refers to, if any.
"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A *comment* represents a single YouTube comment.
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the comment.
"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
"authorChannelId": { # Contains the id of the author's YouTube channel, if any.
"value": "A String", # The id of the author's YouTube channel.
},
"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorDisplayName": "A String", # The name of the user who posted the comment.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
"canRate": True or False, # Whether the current viewer can rate this comment.
"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel.
"likeCount": 42, # The total number of likes this comment has received.
"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"parentId": "A String", # The unique id of the top-level comment, only set for replies.
"postId": "A String", # The ID of the post the comment refers to, if any.
"publishedAt": "A String", # The date and time when the comment was originally published.
"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
"updatedAt": "A String", # The date and time when the comment was last updated.
"videoId": "A String", # The ID of the video the comment refers to, if any.
"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(part, id=None, maxResults=None, pageToken=None, parentId=None, textFormat=None, x__xgafv=None)</code>
<pre>Retrieves a list of resources, possibly filtered.
Args:
part: string, The *part* parameter specifies a comma-separated list of one or more comment resource properties that the API response will include. (required) (repeated)
id: string, Returns the comments with the given IDs for One Platform. (repeated)
maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
parentId: string, Returns replies to the specified comment. Note, currently YouTube features only one level of replies (ie replies to top level comments). However replies to replies may be supported in the future.
textFormat: string, The requested text format for the returned comments.
Allowed values
textFormatUnspecified -
html - Returns the comments in HTML format. This is the default value.
plainText - Returns the comments in plain text format.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # Etag of this resource.
"eventId": "A String", # Serialized EventId of the request which produced this response.
"items": [ # A list of comments that match the request criteria.
{ # A *comment* represents a single YouTube comment.
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the comment.
"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
"authorChannelId": { # Contains the id of the author's YouTube channel, if any.
"value": "A String", # The id of the author's YouTube channel.
},
"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorDisplayName": "A String", # The name of the user who posted the comment.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
"canRate": True or False, # Whether the current viewer can rate this comment.
"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel.
"likeCount": 42, # The total number of likes this comment has received.
"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"parentId": "A String", # The unique id of the top-level comment, only set for replies.
"postId": "A String", # The ID of the post the comment refers to, if any.
"publishedAt": "A String", # The date and time when the comment was originally published.
"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
"updatedAt": "A String", # The date and time when the comment was last updated.
"videoId": "A String", # The ID of the video the comment refers to, if any.
"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
},
},
],
"kind": "youtube#commentListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".
"nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.
"resultsPerPage": 42, # The number of results included in the API response.
"totalResults": 42, # The total number of results in the result set.
},
"tokenPagination": { # Stub token pagination template to suppress results.
},
"visitorId": "A String", # The visitorId identifies the visitor.
}</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="markAsSpam">markAsSpam(id, x__xgafv=None)</code>
<pre>Expresses the caller's opinion that one or more comments should be flagged as spam.
Args:
id: string, Flags the comments with the given IDs as spam in the caller's opinion. (required) (repeated)
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="setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None, x__xgafv=None)</code>
<pre>Sets the moderation status of one or more comments.
Args:
id: string, Modifies the moderation status of the comments with the given IDs (required) (repeated)
moderationStatus: string, Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: 'heldForReview', 'published' or 'rejected'. (required)
Allowed values
published - The comment is available for public display.
heldForReview - The comment is awaiting review by a moderator.
likelySpam -
rejected - The comment is unfit for display.
banAuthor: boolean, If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED.
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="update">update(part, body=None, x__xgafv=None)</code>
<pre>Updates an existing resource.
Args:
part: string, The *part* parameter identifies the properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A *comment* represents a single YouTube comment.
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the comment.
"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
"authorChannelId": { # Contains the id of the author's YouTube channel, if any.
"value": "A String", # The id of the author's YouTube channel.
},
"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorDisplayName": "A String", # The name of the user who posted the comment.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
"canRate": True or False, # Whether the current viewer can rate this comment.
"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel.
"likeCount": 42, # The total number of likes this comment has received.
"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"parentId": "A String", # The unique id of the top-level comment, only set for replies.
"postId": "A String", # The ID of the post the comment refers to, if any.
"publishedAt": "A String", # The date and time when the comment was originally published.
"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
"updatedAt": "A String", # The date and time when the comment was last updated.
"videoId": "A String", # The ID of the video the comment refers to, if any.
"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A *comment* represents a single YouTube comment.
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the comment.
"kind": "youtube#comment", # Identifies what kind of resource this is. Value: the fixed string "youtube#comment".
"snippet": { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
"authorChannelId": { # Contains the id of the author's YouTube channel, if any.
"value": "A String", # The id of the author's YouTube channel.
},
"authorChannelUrl": "A String", # Link to the author's YouTube channel, if any.
"authorDisplayName": "A String", # The name of the user who posted the comment.
"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment.
"canRate": True or False, # Whether the current viewer can rate this comment.
"channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel.
"likeCount": 42, # The total number of likes this comment has received.
"moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter.
"parentId": "A String", # The unique id of the top-level comment, only set for replies.
"postId": "A String", # The ID of the post the comment refers to, if any.
"publishedAt": "A String", # The date and time when the comment was originally published.
"textDisplay": "A String", # The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.
"textOriginal": "A String", # The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.
"updatedAt": "A String", # The date and time when the comment was last updated.
"videoId": "A String", # The ID of the video the comment refers to, if any.
"viewerRating": "A String", # The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.
},
}</pre>
</div>
</body></html>
|
