blob: ff76bea908d459f7cbe0dbc7b274acc51bee12a3 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Inserts a new resource into this collection.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000083<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080084 <code><a href="#list">list(part, order=None, maxResults=None, searchTerms=None, textFormat=None, channelId=None, pageToken=None, videoId=None, moderationStatus=None, id=None, allThreadsRelatedToChannelId=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070085<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000086<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070090 <code><a href="#update">update(part, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Updates an existing resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000092<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070099 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
100 <pre>Inserts a new resource into this collection.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700104 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000105 The object takes the form of:
106
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700107{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800108 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
109 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
110 { # A *comment* represents a single YouTube comment.
111 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
112 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
113 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800115 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700116 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800117 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
118 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700119 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800120 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
121 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
122 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700123 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
124 &quot;value&quot;: &quot;A String&quot;,
125 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800126 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700127 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800128 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
129 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
130 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
131 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700132 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700133 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800134 ],
135 },
136 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
137 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#commentThread&quot;.
138 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
139 &quot;snippet&quot;: { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
140 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
141 &quot;topLevelComment&quot;: { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
142 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
143 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
144 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
145 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
146 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
147 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
148 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
149 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
150 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
151 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
152 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
153 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
154 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
155 &quot;value&quot;: &quot;A String&quot;,
156 },
157 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
158 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
159 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
160 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
161 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
162 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
163 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000164 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800165 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn&#x27;t set the comments refer to the channel itself.
166 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
167 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
168 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
169 },
170}
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000171
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700172 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000176
177Returns:
178 An object of the form:
179
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700180 { # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800181 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
182 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
183 { # A *comment* represents a single YouTube comment.
184 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
185 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
186 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700187 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800188 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700189 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800190 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
191 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700192 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800193 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
194 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
195 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700196 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
197 &quot;value&quot;: &quot;A String&quot;,
198 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800199 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700200 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800201 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
202 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
203 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
204 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700205 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700206 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800207 ],
208 },
209 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
210 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#commentThread&quot;.
211 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
212 &quot;snippet&quot;: { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
213 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
214 &quot;topLevelComment&quot;: { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
215 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
216 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
217 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
218 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
219 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
220 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
221 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
222 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
223 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
224 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
225 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
226 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
227 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
228 &quot;value&quot;: &quot;A String&quot;,
229 },
230 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
231 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
232 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
233 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
234 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
235 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
236 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000237 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800238 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn&#x27;t set the comments refer to the channel itself.
239 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
240 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
241 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
242 },
243 }</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000244</div>
245
246<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800247 <code class="details" id="list">list(part, order=None, maxResults=None, searchTerms=None, textFormat=None, channelId=None, pageToken=None, videoId=None, moderationStatus=None, id=None, allThreadsRelatedToChannelId=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700248 <pre>Retrieves a list of resources, possibly filtered.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000249
250Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700251 part: string, The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include. (required) (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700252 order: string, A parameter
253 Allowed values
254 orderUnspecified -
255 time - Order by time.
256 relevance - Order by relevance.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800257 maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
258 searchTerms: string, Limits the returned comment threads to those matching the specified key words. Not compatible with the &#x27;id&#x27; filter.
259 textFormat: string, The requested text format for the returned comments.
260 Allowed values
261 textFormatUnspecified -
262 html - Returns the comments in HTML format. This is the default value.
263 plainText - Returns the comments in plain text format.
264 channelId: string, Returns the comment threads for all the channel comments (ie does not include comments left on videos).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700265 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800266 videoId: string, Returns the comment threads of the specified video.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700267 moderationStatus: string, Limits the returned comment threads to those with the specified moderation status. Not compatible with the &#x27;id&#x27; filter. Valid values: published, heldForReview, likelySpam.
268 Allowed values
269 published - The comment is available for public display.
270 heldForReview - The comment is awaiting review by a moderator.
271 likelySpam -
272 rejected - The comment is unfit for display.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800273 id: string, Returns the comment threads with the given IDs for Stubby or Apiary. (repeated)
274 allThreadsRelatedToChannelId: string, Returns the comment threads of all videos of the channel and the channel comments as well.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700275 x__xgafv: string, V1 error format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000276 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700277 1 - v1 error format
278 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000279
280Returns:
281 An object of the form:
282
283 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700284 &quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.
285 &quot;totalResults&quot;: 42, # The total number of results in the result set.
286 &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
287 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800288 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
289 &quot;kind&quot;: &quot;youtube#commentThreadListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#commentThreadListResponse&quot;.
290 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700291 &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
292 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800293 &quot;items&quot;: [ # A list of comment threads that match the request criteria.
294 { # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
295 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
296 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
297 { # A *comment* represents a single YouTube comment.
298 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
299 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
300 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
301 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
302 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
303 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
304 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
305 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
306 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
307 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
308 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
309 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
310 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
311 &quot;value&quot;: &quot;A String&quot;,
312 },
313 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
314 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
315 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
316 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
317 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
318 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
319 },
320 },
321 ],
322 },
323 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
324 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#commentThread&quot;.
325 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
326 &quot;snippet&quot;: { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
327 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
328 &quot;topLevelComment&quot;: { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
329 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
330 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
331 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
332 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
333 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
334 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
335 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
336 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
337 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
338 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
339 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
340 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
341 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
342 &quot;value&quot;: &quot;A String&quot;,
343 },
344 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
345 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
346 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
347 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
348 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
349 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
350 },
351 },
352 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn&#x27;t set the comments refer to the channel itself.
353 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
354 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
355 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
356 },
357 },
358 ],
359 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
360 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000361 }</pre>
362</div>
363
364<div class="method">
365 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
366 <pre>Retrieves the next page of results.
367
368Args:
369 previous_request: The request for the previous page. (required)
370 previous_response: The response from the request for the previous page. (required)
371
372Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700373 A request object that you can call &#x27;execute()&#x27; on to request the next
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000374 page. Returns None if there are no more items in the collection.
375 </pre>
376</div>
377
378<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700379 <code class="details" id="update">update(part, body=None, x__xgafv=None)</code>
380 <pre>Updates an existing resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000381
382Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700383 part: string, The *part* parameter specifies a comma-separated list of commentThread resource 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700384 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000385 The object takes the form of:
386
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700387{ # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800388 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
389 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
390 { # A *comment* represents a single YouTube comment.
391 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
392 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
393 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700394 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800395 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700396 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800397 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
398 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700399 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800400 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
401 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
402 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700403 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
404 &quot;value&quot;: &quot;A String&quot;,
405 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800406 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700407 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800408 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
409 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
410 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
411 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700412 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700413 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800414 ],
415 },
416 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
417 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#commentThread&quot;.
418 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
419 &quot;snippet&quot;: { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
420 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
421 &quot;topLevelComment&quot;: { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
422 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
423 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
424 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
425 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
426 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
427 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
428 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
429 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
430 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
431 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
432 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
433 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
434 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
435 &quot;value&quot;: &quot;A String&quot;,
436 },
437 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
438 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
439 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
440 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
441 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
442 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
443 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000444 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800445 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn&#x27;t set the comments refer to the channel itself.
446 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
447 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
448 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
449 },
450}
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000451
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700452 x__xgafv: string, V1 error format.
453 Allowed values
454 1 - v1 error format
455 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000456
457Returns:
458 An object of the form:
459
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700460 { # A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800461 &quot;replies&quot;: { # Comments written in (direct or indirect) reply to the top level comment. # The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.
462 &quot;comments&quot;: [ # A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.
463 { # A *comment* represents a single YouTube comment.
464 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
465 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
466 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700467 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800468 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700469 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800470 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
471 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700472 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800473 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
474 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
475 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700476 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
477 &quot;value&quot;: &quot;A String&quot;,
478 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800479 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700480 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800481 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
482 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
483 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
484 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700485 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700486 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800487 ],
488 },
489 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment thread.
490 &quot;kind&quot;: &quot;youtube#commentThread&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#commentThread&quot;.
491 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
492 &quot;snippet&quot;: { # Basic details about a comment thread. # The snippet object contains basic details about the comment thread and also the top level comment.
493 &quot;canReply&quot;: True or False, # Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.
494 &quot;topLevelComment&quot;: { # A *comment* represents a single YouTube comment. # The top level comment of this thread.
495 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the comment.
496 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
497 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#comment&quot;.
498 &quot;snippet&quot;: { # Basic details about a comment, such as its author and text. # The snippet object contains basic details about the comment.
499 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is specified in ISO 8601 format.
500 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
501 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;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&#x27;s author.
502 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were requested through the id filter.
503 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is specified in ISO 8601 format.
504 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comment refers to, if any.
505 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;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.
506 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
507 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
508 &quot;value&quot;: &quot;A String&quot;,
509 },
510 &quot;viewerRating&quot;: &quot;A String&quot;, # 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.
511 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
512 &quot;parentId&quot;: &quot;A String&quot;, # The unique id of the parent comment, only set for replies.
513 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
514 &quot;channelId&quot;: &quot;A String&quot;, # 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 comment it&#x27;s the video&#x27;s channel.
515 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
516 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000517 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800518 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn&#x27;t set the comments refer to the channel itself.
519 &quot;isPublic&quot;: True or False, # Whether the thread (and therefore all its comments) is visible to all YouTube users.
520 &quot;videoId&quot;: &quot;A String&quot;, # The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.
521 &quot;totalReplyCount&quot;: 42, # The total number of replies (not including the top level comment).
522 },
523 }</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000524</div>
525
526</body></html>