Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / youtube_v3.comments.html
blob: 4ef1618e1046eeadf7ae9763bbb62af2bd0b8984 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1<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 -0700[diff] [blame^]75<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.comments.html">comments</a></h1>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <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 +0000[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]84 <code><a href="#list">list(part, textFormat=None, parentId=None, pageToken=None, id=None, maxResults=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86<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 -0700[diff] [blame^]90 <code><a href="#markAsSpam">markAsSpam(id, x__xgafv=None)</a></code></p>
91<p class="firstline">Expresses the caller's opinion that one or more comments should be flagged</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]93 <code><a href="#setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Sets the moderation status of one or more comments.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]95<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]96 <code><a href="#update">update(part, body=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates an existing resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]100 <code class="details" id="delete">delete(id, x__xgafv=None)</code>
101 <pre>Deletes a resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]102
103Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]104 id: string, A parameter (required)
105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]109</pre>
110</div>
111
112<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]113 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
114 <pre>Inserts a new resource into this collection.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]115
116Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]117 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter identifies the properties
118that the API response will include. Set the parameter value to
119&lt;code&gt;snippet&lt;/code&gt;. The &lt;code&gt;snippet&lt;/code&gt; part has a quota cost of 2
120units. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]121 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]122 The object takes the form of:
123
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]124{ # 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 -0700[diff] [blame]125 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
126 &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 -0700[diff] [blame^]127 &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 -0700[diff] [blame]128 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]129 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
130 # requested through the id filter.
131 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
132 &quot;value&quot;: &quot;A String&quot;,
133 },
134 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
135 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
136 # what has been requested. Even the plain text representation may differ
137 # from the text originally posted in that it may replace video links with
138 # video titles etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]140 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
141 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
142 # This may change in the future.
143 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
144 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
145 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
146 # this is the channel the comment refers to. In case of a video comment
147 # it&#x27;s the video&#x27;s channel.
148 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
149 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
150 # format.
151 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
152 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
153 # format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 &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 -0700[diff] [blame]155 &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 -0700[diff] [blame^]156 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
157 # original text will only be returned if it is accessible to the viewer,
158 # which is only guaranteed if the viewer is the comment&#x27;s author.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]159 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]160 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
161 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]162}
163
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]168
169Returns:
170 An object of the form:
171
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]172 { # 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 -0700[diff] [blame]173 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
174 &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 -0700[diff] [blame^]175 &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 -0700[diff] [blame]176 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]177 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
178 # requested through the id filter.
179 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
180 &quot;value&quot;: &quot;A String&quot;,
181 },
182 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
183 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
184 # what has been requested. Even the plain text representation may differ
185 # from the text originally posted in that it may replace video links with
186 # video titles etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]188 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
189 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
190 # This may change in the future.
191 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
192 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
193 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
194 # this is the channel the comment refers to. In case of a video comment
195 # it&#x27;s the video&#x27;s channel.
196 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
197 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
198 # format.
199 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
200 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
201 # format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]202 &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 -0700[diff] [blame]203 &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 -0700[diff] [blame^]204 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
205 # original text will only be returned if it is accessible to the viewer,
206 # which is only guaranteed if the viewer is the comment&#x27;s author.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]207 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]208 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
209 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]210 }</pre>
211</div>
212
213<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]214 <code class="details" id="list">list(part, textFormat=None, parentId=None, pageToken=None, id=None, maxResults=None, x__xgafv=None)</code>
215 <pre>Retrieves a list of resources, possibly filtered.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]216
217Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]218 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies a
219comma-separated list of one or more &lt;code&gt;comment&lt;/code&gt; resource
220properties that the API response will include. (required) (repeated)
221 textFormat: string, The requested text format for the returned comments.
222 parentId: string, Returns replies to the specified comment.
223Note, currently YouTube features only one level of replies (ie replies
224to top level comments). However replies to replies may be supported in
225the future.
226 pageToken: string, The &lt;code&gt;&lt;strong&gt;pageToken&lt;/strong&gt;&lt;/code&gt; parameter identifies a specific
227page in the result set that should be returned. In an API response, the
228&lt;code&gt;nextPageToken&lt;/code&gt; and &lt;code&gt;prevPageToken&lt;/code&gt; properties
229identify other pages that could be retrieved.
230 id: string, Returns the comments with the given IDs for One Platform. (repeated)
231 maxResults: integer, The &lt;code&gt;&lt;strong&gt;maxResults&lt;/strong&gt;&lt;/code&gt; parameter specifies the
232maximum number of items that should be returned in the result set.
233 x__xgafv: string, V1 error format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]234 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]235 1 - v1 error format
236 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]237
238Returns:
239 An object of the form:
240
241 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]242 &quot;visitorId&quot;: &quot;A String&quot;, # The &lt;code&gt;visitorId&lt;/code&gt; identifies the visitor.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]243 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
244 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
245 &quot;items&quot;: [ # A list of comments that match the request criteria.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]246 { # 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 -0700[diff] [blame]247 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
248 &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 -0700[diff] [blame^]249 &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 -0700[diff] [blame]250 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]251 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
252 # requested through the id filter.
253 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
254 &quot;value&quot;: &quot;A String&quot;,
255 },
256 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
257 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
258 # what has been requested. Even the plain text representation may differ
259 # from the text originally posted in that it may replace video links with
260 # video titles etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]261 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]262 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
263 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
264 # This may change in the future.
265 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
266 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
267 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
268 # this is the channel the comment refers to. In case of a video comment
269 # it&#x27;s the video&#x27;s channel.
270 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
271 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
272 # format.
273 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
274 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
275 # format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]276 &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 -0700[diff] [blame]277 &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 -0700[diff] [blame^]278 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
279 # original text will only be returned if it is accessible to the viewer,
280 # which is only guaranteed if the viewer is the comment&#x27;s author.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]281 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]282 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
283 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]284 },
285 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]286 &quot;kind&quot;: &quot;youtube#commentListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string
287 # &lt;code&gt;&quot;youtube#commentListResponse&quot;&lt;/code&gt;.
288 &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;
289 # parameter to retrieve the next page in the result set.
290 &quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items # General pagination information.
291 # available and number of resources returned in a single page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]292 &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
293 &quot;totalResults&quot;: 42, # The total number of results in the result set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]294 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]295 &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]296 },
297 }</pre>
298</div>
299
300<div class="method">
301 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
302 <pre>Retrieves the next page of results.
303
304Args:
305 previous_request: The request for the previous page. (required)
306 previous_response: The response from the request for the previous page. (required)
307
308Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]309 A request object that you can call &#x27;execute()&#x27; on to request the next
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]310 page. Returns None if there are no more items in the collection.
311 </pre>
312</div>
313
314<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]315 <code class="details" id="markAsSpam">markAsSpam(id, x__xgafv=None)</code>
316 <pre>Expresses the caller&#x27;s opinion that one or more comments should be flagged
317as spam.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]318
319Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]320 id: string, Flags the comments with the given IDs as spam in the caller&#x27;s opinion. (required) (repeated)
321 x__xgafv: string, V1 error format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]322 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]323 1 - v1 error format
324 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]325</pre>
326</div>
327
328<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]329 <code class="details" id="setModerationStatus">setModerationStatus(id, moderationStatus, banAuthor=None, x__xgafv=None)</code>
330 <pre>Sets the moderation status of one or more comments.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]331
332Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]333 id: string, Modifies the moderation status of the comments with the given IDs (required) (repeated)
334 moderationStatus: string, Specifies the requested moderation status. Note, comments can be in
335statuses, which are not available through this call. For example, this
336call does not allow to mark a comment as &#x27;likely spam&#x27;.
337Valid values: MODERATION_STATUS_PUBLISHED,
338MODERATION_STATUS_HELD_FOR_REVIEW, MODERATION_STATUS_REJECTED. (required)
339 banAuthor: boolean, If set to true the author of the comment gets added to the ban list.
340This means all future comments of the author will autmomatically be
341rejected.
342Only valid in combination with STATUS_REJECTED.
343 x__xgafv: string, V1 error format.
344 Allowed values
345 1 - v1 error format
346 2 - v2 error format
347</pre>
348</div>
349
350<div class="method">
351 <code class="details" id="update">update(part, body=None, x__xgafv=None)</code>
352 <pre>Updates an existing resource.
353
354Args:
355 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter identifies the properties
356that the API response will include. You must at least include the
357&lt;code&gt;snippet&lt;/code&gt; part in the parameter value since that part contains
358all of the properties that the API request can update. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]359 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]360 The object takes the form of:
361
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]362{ # 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 -0700[diff] [blame]363 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
364 &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 -0700[diff] [blame^]365 &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 -0700[diff] [blame]366 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]367 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
368 # requested through the id filter.
369 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
370 &quot;value&quot;: &quot;A String&quot;,
371 },
372 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
373 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
374 # what has been requested. Even the plain text representation may differ
375 # from the text originally posted in that it may replace video links with
376 # video titles etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]377 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]378 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
379 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
380 # This may change in the future.
381 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
382 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
383 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
384 # this is the channel the comment refers to. In case of a video comment
385 # it&#x27;s the video&#x27;s channel.
386 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
387 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
388 # format.
389 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
390 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
391 # format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]392 &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 -0700[diff] [blame]393 &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 -0700[diff] [blame^]394 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
395 # original text will only be returned if it is accessible to the viewer,
396 # which is only guaranteed if the viewer is the comment&#x27;s author.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]397 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]398 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
399 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]400}
401
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]402 x__xgafv: string, V1 error format.
403 Allowed values
404 1 - v1 error format
405 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]406
407Returns:
408 An object of the form:
409
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]410 { # 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 -0700[diff] [blame]411 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
412 &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 -0700[diff] [blame^]413 &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 -0700[diff] [blame]414 &quot;canRate&quot;: True or False, # Whether the current viewer can rate this comment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]415 &quot;moderationStatus&quot;: &quot;A String&quot;, # The comment&#x27;s moderation status. Will not be set if the comments were
416 # requested through the id filter.
417 &quot;authorChannelId&quot;: { # The id of the author&#x27;s YouTube channel, if any.
418 &quot;value&quot;: &quot;A String&quot;,
419 },
420 &quot;authorDisplayName&quot;: &quot;A String&quot;, # The name of the user who posted the comment.
421 &quot;textDisplay&quot;: &quot;A String&quot;, # The comment&#x27;s text. The format is either plain text or HTML dependent on
422 # what has been requested. Even the plain text representation may differ
423 # from the text originally posted in that it may replace video links with
424 # video titles etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]425 &quot;likeCount&quot;: 42, # The total number of likes this comment has received.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]426 &quot;viewerRating&quot;: &quot;A String&quot;, # The rating the viewer has given to this comment. For the time being this
427 # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE.
428 # This may change in the future.
429 &quot;authorChannelUrl&quot;: &quot;A String&quot;, # Link to the author&#x27;s YouTube channel, if any.
430 &quot;authorProfileImageUrl&quot;: &quot;A String&quot;, # The URL for the avatar of the user who posted the comment.
431 &quot;channelId&quot;: &quot;A String&quot;, # The id of the corresponding YouTube channel. In case of a channel comment
432 # this is the channel the comment refers to. In case of a video comment
433 # it&#x27;s the video&#x27;s channel.
434 &quot;updatedAt&quot;: &quot;A String&quot;, # The date and time when was last updated . The value is
435 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
436 # format.
437 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the comment was orignally published. The value is
438 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
439 # format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]440 &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 -0700[diff] [blame]441 &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 -0700[diff] [blame^]442 &quot;textOriginal&quot;: &quot;A String&quot;, # The comment&#x27;s original raw text as initially posted or last updated. The
443 # original text will only be returned if it is accessible to the viewer,
444 # which is only guaranteed if the viewer is the comment&#x27;s author.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]445 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]446 &quot;kind&quot;: &quot;youtube#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string
447 # &lt;code&gt;&quot;youtube#comment&quot;&lt;/code&gt;.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]448 }</pre>
449</div>
450
451</body></html>