blob: 9d14cfb7332ef3a3f9dfa8dc706241066276bcfb [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kimd059ad82020-07-22 17:02:09 -070075<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.commentThreads.html">commentThreads</a></h1>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000076<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070078 <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Inserts a new resource into this collection.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000080<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#list">list(part, searchTerms=None, maxResults=None, videoId=None, order=None, moderationStatus=None, allThreadsRelatedToChannelId=None, pageToken=None, id=None, channelId=None, textFormat=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000083<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#update">update(part, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Updates an existing resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000089<h3>Method Details</h3>
90<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070091 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
92 <pre>Inserts a new resource into this collection.
Nathaniel Manista4f877e52015-06-15 16:44:50 +000093
94Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -070095 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter identifies the properties
96that the API response will include. Set the parameter value to
97&lt;code&gt;snippet&lt;/code&gt;. The &lt;code&gt;snippet&lt;/code&gt; part has a quota cost of 2
98units. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -070099 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000100 The object takes the form of:
101
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700102{ # A &lt;code&gt;&lt;strong&gt;comment thread&lt;/strong&gt;&lt;/code&gt; represents information that
103 # applies to a top level comment and all its replies. It can also include the
104 # top level comment itself and some of the replies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700105 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700106 &quot;snippet&quot;: { # Basic details about a comment thread. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment
107 # thread and also the top level comment.
108 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel
109 # with the video the comments refer to. If video_id isn&#x27;t set the comments
110 # refer to the channel itself.
111 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
112 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a
113 # channel discussion comment.
114 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer
115 # specific - other viewers may see a different value for this field.
116 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all
117 # YouTube users.
118 &quot;topLevelComment&quot;: { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment. # The top level comment of this thread.
119 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
120 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
121 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
122 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
123 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
124 # requested through the id filter.
125 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
126 &quot;value&quot;: &quot;A String&quot;,
127 },
128 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
129 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
130 # what has been requested. Even the plain text representation may differ
131 # from the text originally posted in that it may replace video links with
132 # video titles etc.
133 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
134 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
135 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
136 # This may change in the future.
137 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
138 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
139 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
140 # this is the channel the comment refers to. In case of a video comment
141 # it&#x27;s the video&#x27;s channel.
142 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
143 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
144 # format.
145 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
146 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
147 # format.
148 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
149 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
150 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
151 # original text will only be returned if it is accessible to the viewer,
152 # which is only guaranteed if the viewer is the comment&#x27;s author.
153 },
154 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
155 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
156 },
157 },
158 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The &lt;code&gt;replies&lt;/code&gt; object contains a limited number of replies (if
159 # any) to the top level comment found in the snippet.
160 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals
161 # total_reply_count in the snippet the returned replies are only a subset
162 # of the total number of replies.
163 { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700164 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
165 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700166 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700167 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700168 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
169 # requested through the id filter.
170 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
171 &quot;value&quot;: &quot;A String&quot;,
172 },
173 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
174 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
175 # what has been requested. Even the plain text representation may differ
176 # from the text originally posted in that it may replace video links with
177 # video titles etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700178 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700179 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
180 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
181 # This may change in the future.
182 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
183 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
184 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
185 # this is the channel the comment refers to. In case of a video comment
186 # it&#x27;s the video&#x27;s channel.
187 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
188 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
189 # format.
190 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
191 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
192 # format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700193 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700194 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700195 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
196 # original text will only be returned if it is accessible to the viewer,
197 # which is only guaranteed if the viewer is the comment&#x27;s author.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000198 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700199 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
200 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000201 },
202 ],
203 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700204 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
205 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string
206 # &lt;code&gt;&quot;youtube#commentThread&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000207 }
208
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000213
214Returns:
215 An object of the form:
216
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700217 { # A &lt;code&gt;&lt;strong&gt;comment thread&lt;/strong&gt;&lt;/code&gt; represents information that
218 # applies to a top level comment and all its replies. It can also include the
219 # top level comment itself and some of the replies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700220 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700221 &quot;snippet&quot;: { # Basic details about a comment thread. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment
222 # thread and also the top level comment.
223 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel
224 # with the video the comments refer to. If video_id isn&#x27;t set the comments
225 # refer to the channel itself.
226 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
227 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a
228 # channel discussion comment.
229 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer
230 # specific - other viewers may see a different value for this field.
231 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all
232 # YouTube users.
233 &quot;topLevelComment&quot;: { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment. # The top level comment of this thread.
234 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
235 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
236 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
237 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
238 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
239 # requested through the id filter.
240 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
241 &quot;value&quot;: &quot;A String&quot;,
242 },
243 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
244 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
245 # what has been requested. Even the plain text representation may differ
246 # from the text originally posted in that it may replace video links with
247 # video titles etc.
248 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
249 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
250 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
251 # This may change in the future.
252 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
253 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
254 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
255 # this is the channel the comment refers to. In case of a video comment
256 # it&#x27;s the video&#x27;s channel.
257 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
258 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
259 # format.
260 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
261 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
262 # format.
263 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
264 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
265 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
266 # original text will only be returned if it is accessible to the viewer,
267 # which is only guaranteed if the viewer is the comment&#x27;s author.
268 },
269 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
270 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
271 },
272 },
273 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The &lt;code&gt;replies&lt;/code&gt; object contains a limited number of replies (if
274 # any) to the top level comment found in the snippet.
275 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals
276 # total_reply_count in the snippet the returned replies are only a subset
277 # of the total number of replies.
278 { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700279 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
280 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700281 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700282 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700283 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
284 # requested through the id filter.
285 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
286 &quot;value&quot;: &quot;A String&quot;,
287 },
288 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
289 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
290 # what has been requested. Even the plain text representation may differ
291 # from the text originally posted in that it may replace video links with
292 # video titles etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700293 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700294 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
295 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
296 # This may change in the future.
297 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
298 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
299 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
300 # this is the channel the comment refers to. In case of a video comment
301 # it&#x27;s the video&#x27;s channel.
302 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
303 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
304 # format.
305 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
306 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
307 # format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700308 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700309 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700310 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
311 # original text will only be returned if it is accessible to the viewer,
312 # which is only guaranteed if the viewer is the comment&#x27;s author.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000313 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700314 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
315 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000316 },
317 ],
318 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700319 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
320 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string
321 # &lt;code&gt;&quot;youtube#commentThread&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000322 }</pre>
323</div>
324
325<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700326 <code class="details" id="list">list(part, searchTerms=None, maxResults=None, videoId=None, order=None, moderationStatus=None, allThreadsRelatedToChannelId=None, pageToken=None, id=None, channelId=None, textFormat=None, x__xgafv=None)</code>
327 <pre>Retrieves a list of resources, possibly filtered.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000328
329Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700330 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies a
331comma-separated list of one or more &lt;code&gt;commentThread&lt;/code&gt; resource
332properties that the API response will include. (required) (repeated)
333 searchTerms: string, Limits the returned comment threads to those matching the specified
334key words. Not compatible with the &#x27;id&#x27; filter.
335 maxResults: integer, The &lt;code&gt;&lt;strong&gt;maxResults&lt;/strong&gt;&lt;/code&gt; parameter specifies the
336maximum number of items that should be returned in the result set.
337 videoId: string, Returns the comment threads of the specified video.
338 order: string, A parameter
339 moderationStatus: string, Limits the returned comment threads to those with the specified
340moderation status. Not compatible with the &#x27;id&#x27; filter.
341Valid values: published, heldForReview, likelySpam.
342 allThreadsRelatedToChannelId: string, Returns the comment threads of all videos of the channel and the
343channel comments as well.
344 pageToken: string, The &lt;code&gt;&lt;strong&gt;pageToken&lt;/strong&gt;&lt;/code&gt; parameter identifies a specific
345page in the result set that should be returned. In an API response, the
346&lt;code&gt;nextPageToken&lt;/code&gt; and &lt;code&gt;prevPageToken&lt;/code&gt; properties
347identify other pages that could be retrieved.
348 id: string, Returns the comment threads with the given IDs for Stubby or Apiary. (repeated)
349 channelId: string, Returns the comment threads for all the channel comments (ie does not
350include comments left on videos).
351 textFormat: string, The requested text format for the returned comments.
352 x__xgafv: string, V1 error format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000353 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700354 1 - v1 error format
355 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000356
357Returns:
358 An object of the form:
359
360 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700361 &quot;visitorId&quot;: &quot;A String&quot;, # The &lt;code&gt;visitorId&lt;/code&gt; identifies the visitor.
362 &quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items # General pagination information.
363 # available and number of resources returned in a single page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700364 &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
365 &quot;totalResults&quot;: 42, # The total number of results in the result set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000366 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700367 &quot;items&quot;: [ # A list of comment threads that match the request criteria.
368 { # A &lt;code&gt;&lt;strong&gt;comment thread&lt;/strong&gt;&lt;/code&gt; represents information that
369 # applies to a top level comment and all its replies. It can also include the
370 # top level comment itself and some of the replies.
371 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
372 &quot;snippet&quot;: { # Basic details about a comment thread. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment
373 # thread and also the top level comment.
374 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel
375 # with the video the comments refer to. If video_id isn&#x27;t set the comments
376 # refer to the channel itself.
377 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
378 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a
379 # channel discussion comment.
380 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer
381 # specific - other viewers may see a different value for this field.
382 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all
383 # YouTube users.
384 &quot;topLevelComment&quot;: { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment. # The top level comment of this thread.
385 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
386 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
387 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
388 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
389 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
390 # requested through the id filter.
391 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
392 &quot;value&quot;: &quot;A String&quot;,
393 },
394 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
395 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
396 # what has been requested. Even the plain text representation may differ
397 # from the text originally posted in that it may replace video links with
398 # video titles etc.
399 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
400 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
401 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
402 # This may change in the future.
403 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
404 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
405 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
406 # this is the channel the comment refers to. In case of a video comment
407 # it&#x27;s the video&#x27;s channel.
408 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
409 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
410 # format.
411 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
412 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
413 # format.
414 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
415 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
416 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
417 # original text will only be returned if it is accessible to the viewer,
418 # which is only guaranteed if the viewer is the comment&#x27;s author.
419 },
420 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
421 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
422 },
423 },
424 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The &lt;code&gt;replies&lt;/code&gt; object contains a limited number of replies (if
425 # any) to the top level comment found in the snippet.
426 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals
427 # total_reply_count in the snippet the returned replies are only a subset
428 # of the total number of replies.
429 { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment.
430 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
431 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
432 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
433 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
434 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
435 # requested through the id filter.
436 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
437 &quot;value&quot;: &quot;A String&quot;,
438 },
439 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
440 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
441 # what has been requested. Even the plain text representation may differ
442 # from the text originally posted in that it may replace video links with
443 # video titles etc.
444 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
445 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
446 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
447 # This may change in the future.
448 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
449 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
450 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
451 # this is the channel the comment refers to. In case of a video comment
452 # it&#x27;s the video&#x27;s channel.
453 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
454 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
455 # format.
456 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
457 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
458 # format.
459 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
460 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
461 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
462 # original text will only be returned if it is accessible to the viewer,
463 # which is only guaranteed if the viewer is the comment&#x27;s author.
464 },
465 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
466 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
467 },
468 ],
469 },
470 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
471 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string
472 # &lt;code&gt;&quot;youtube#commentThread&quot;&lt;/code&gt;.
473 },
474 ],
475 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the &lt;code&gt;pageToken&lt;/code&gt;
476 # parameter to retrieve the next page in the result set.
477 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700478 &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000479 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700480 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
481 &quot;kind&quot;: &quot;youtube#commentThreadListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string
482 # &lt;code&gt;&quot;youtube#commentThreadListResponse&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000483 }</pre>
484</div>
485
486<div class="method">
487 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
488 <pre>Retrieves the next page of results.
489
490Args:
491 previous_request: The request for the previous page. (required)
492 previous_response: The response from the request for the previous page. (required)
493
494Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700495 A request object that you can call &#x27;execute()&#x27; on to request the next
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000496 page. Returns None if there are no more items in the collection.
497 </pre>
498</div>
499
500<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700501 <code class="details" id="update">update(part, body=None, x__xgafv=None)</code>
502 <pre>Updates an existing resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000503
504Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700505 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies a
506comma-separated list of &lt;code&gt;commentThread&lt;/code&gt; resource properties that
507the API response will include. You must at least include the
508&lt;code&gt;snippet&lt;/code&gt; part in the parameter value since that part contains
509all of the properties that the API request can update. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700510 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000511 The object takes the form of:
512
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700513{ # A &lt;code&gt;&lt;strong&gt;comment thread&lt;/strong&gt;&lt;/code&gt; represents information that
514 # applies to a top level comment and all its replies. It can also include the
515 # top level comment itself and some of the replies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700516 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700517 &quot;snippet&quot;: { # Basic details about a comment thread. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment
518 # thread and also the top level comment.
519 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel
520 # with the video the comments refer to. If video_id isn&#x27;t set the comments
521 # refer to the channel itself.
522 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
523 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a
524 # channel discussion comment.
525 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer
526 # specific - other viewers may see a different value for this field.
527 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all
528 # YouTube users.
529 &quot;topLevelComment&quot;: { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment. # The top level comment of this thread.
530 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
531 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
532 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
533 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
534 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
535 # requested through the id filter.
536 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
537 &quot;value&quot;: &quot;A String&quot;,
538 },
539 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
540 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
541 # what has been requested. Even the plain text representation may differ
542 # from the text originally posted in that it may replace video links with
543 # video titles etc.
544 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
545 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
546 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
547 # This may change in the future.
548 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
549 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
550 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
551 # this is the channel the comment refers to. In case of a video comment
552 # it&#x27;s the video&#x27;s channel.
553 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
554 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
555 # format.
556 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
557 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
558 # format.
559 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
560 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
561 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
562 # original text will only be returned if it is accessible to the viewer,
563 # which is only guaranteed if the viewer is the comment&#x27;s author.
564 },
565 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
566 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
567 },
568 },
569 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The &lt;code&gt;replies&lt;/code&gt; object contains a limited number of replies (if
570 # any) to the top level comment found in the snippet.
571 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals
572 # total_reply_count in the snippet the returned replies are only a subset
573 # of the total number of replies.
574 { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700575 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
576 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700577 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700578 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700579 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
580 # requested through the id filter.
581 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
582 &quot;value&quot;: &quot;A String&quot;,
583 },
584 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
585 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
586 # what has been requested. Even the plain text representation may differ
587 # from the text originally posted in that it may replace video links with
588 # video titles etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700589 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700590 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
591 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
592 # This may change in the future.
593 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
594 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
595 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
596 # this is the channel the comment refers to. In case of a video comment
597 # it&#x27;s the video&#x27;s channel.
598 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
599 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
600 # format.
601 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
602 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
603 # format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700604 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700605 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700606 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
607 # original text will only be returned if it is accessible to the viewer,
608 # which is only guaranteed if the viewer is the comment&#x27;s author.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000609 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700610 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
611 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000612 },
613 ],
614 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700615 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
616 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string
617 # &lt;code&gt;&quot;youtube#commentThread&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000618 }
619
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700620 x__xgafv: string, V1 error format.
621 Allowed values
622 1 - v1 error format
623 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000624
625Returns:
626 An object of the form:
627
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700628 { # A &lt;code&gt;&lt;strong&gt;comment thread&lt;/strong&gt;&lt;/code&gt; represents information that
629 # applies to a top level comment and all its replies. It can also include the
630 # top level comment itself and some of the replies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700631 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700632 &quot;snippet&quot;: { # Basic details about a comment thread. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment
633 # thread and also the top level comment.
634 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel
635 # with the video the comments refer to. If video_id isn&#x27;t set the comments
636 # refer to the channel itself.
637 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
638 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a
639 # channel discussion comment.
640 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer
641 # specific - other viewers may see a different value for this field.
642 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all
643 # YouTube users.
644 &quot;topLevelComment&quot;: { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment. # The top level comment of this thread.
645 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
646 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
647 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
648 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
649 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
650 # requested through the id filter.
651 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
652 &quot;value&quot;: &quot;A String&quot;,
653 },
654 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
655 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
656 # what has been requested. Even the plain text representation may differ
657 # from the text originally posted in that it may replace video links with
658 # video titles etc.
659 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
660 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
661 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
662 # This may change in the future.
663 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
664 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
665 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
666 # this is the channel the comment refers to. In case of a video comment
667 # it&#x27;s the video&#x27;s channel.
668 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
669 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
670 # format.
671 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
672 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
673 # format.
674 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
675 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
676 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
677 # original text will only be returned if it is accessible to the viewer,
678 # which is only guaranteed if the viewer is the comment&#x27;s author.
679 },
680 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
681 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
682 },
683 },
684 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The &lt;code&gt;replies&lt;/code&gt; object contains a limited number of replies (if
685 # any) to the top level comment found in the snippet.
686 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals
687 # total_reply_count in the snippet the returned replies are only a subset
688 # of the total number of replies.
689 { # A &lt;code&gt;&lt;strong&gt;comment&lt;/strong&gt;&lt;/code&gt; represents a single YouTube comment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700690 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
691 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700692 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the comment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700693 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700694 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
695 # requested through the id filter.
696 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
697 &quot;value&quot;: &quot;A String&quot;,
698 },
699 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
700 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
701 # what has been requested. Even the plain text representation may differ
702 # from the text originally posted in that it may replace video links with
703 # video titles etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700704 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700705 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
706 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
707 # This may change in the future.
708 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
709 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
710 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
711 # this is the channel the comment refers to. In case of a video comment
712 # it&#x27;s the video&#x27;s channel.
713 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
714 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
715 # format.
716 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
717 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
718 # format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700719 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700720 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700721 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
722 # original text will only be returned if it is accessible to the viewer,
723 # which is only guaranteed if the viewer is the comment&#x27;s author.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000724 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700725 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
726 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000727 },
728 ],
729 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700730 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
731 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string
732 # &lt;code&gt;&quot;youtube#commentThread&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000733 }</pre>
734</div>
735
736</body></html>