Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5ae088dc027b89517b896a89a0aeb2ca80f492cf / . / docs / dyn / youtube_v3.liveChatMessages.html
blob: 1452e35b024df1ccb7e558909c28d3bc942c7399 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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.liveChatMessages.html">liveChatMessages</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <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 -0700[diff] [blame]81 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]82<p class="firstline">Deletes a chat message.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Inserts a new resource into this collection.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]86<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]87 <code><a href="#list">list(liveChatId, part, maxResults=None, pageToken=None, profileImageSize=None, hl=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]88<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <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 -0700[diff] [blame]99 <code class="details" id="delete">delete(id, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]100 <pre>Deletes a chat message.
101
102Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]103 id: string, A parameter (required)
104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108</pre>
109</div>
110
111<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]112 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
113 <pre>Inserts a new resource into this collection.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114
115Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]116 part: string, The *part* parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]117 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]118 The object takes the form of:
119
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120{ # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]121 &quot;snippet&quot;: { # The snippet object contains basic details about the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]122 &quot;messageDeletedDetails&quot;: {
123 &quot;deletedMessageId&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]124 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]125 &quot;superStickerDetails&quot;: { # Details about the Super Sticker event, this is only set if the type is &#x27;superStickerEvent&#x27;.
126 &quot;amountMicros&quot;: &quot;A String&quot;, # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
127 &quot;tier&quot;: 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
128 &quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
129 &quot;superStickerMetadata&quot;: { # Information about the Super Sticker.
130 &quot;altTextLanguage&quot;: &quot;A String&quot;, # Specifies the localization language in which the alt text is returned.
131 &quot;altText&quot;: &quot;A String&quot;, # Internationalized alt text that describes the sticker image and any animation associated with it.
132 &quot;stickerId&quot;: &quot;A String&quot;, # Unique identifier of the Super Sticker. This is a shorter form of the alt_text that includes pack name and a recognizable characteristic of the sticker.
133 },
134 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made.
135 },
136 &quot;hasDisplayContent&quot;: True or False, # Whether the message has display content that should be displayed to users.
137 &quot;type&quot;: &quot;A String&quot;, # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
138 &quot;authorChannelId&quot;: &quot;A String&quot;, # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase
139 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the message was orignally published. The value is specified in ISO 8601 format.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]140 &quot;displayMessage&quot;: &quot;A String&quot;, # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]141 &quot;liveChatId&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142 &quot;textMessageDetails&quot;: { # Details about the text message, this is only set if the type is &#x27;textMessageEvent&#x27;.
143 &quot;messageText&quot;: &quot;A String&quot;, # The user&#x27;s message.
144 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]145 &quot;fanFundingEventDetails&quot;: { # Details about the funding event, this is only set if the type is &#x27;fanFundingEvent&#x27;.
146 &quot;userComment&quot;: &quot;A String&quot;, # The comment added by the user to this fan funding event.
147 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the fund was made.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]148 &quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]149 &quot;amountMicros&quot;: &quot;A String&quot;, # The amount of the fund.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]150 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]151 &quot;userBannedDetails&quot;: {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]152 &quot;banType&quot;: &quot;A String&quot;, # The type of ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]153 &quot;bannedUserDetails&quot;: { # The details of the user that was banned.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]154 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]155 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]156 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]157 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]158 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]159 &quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of the ban. This property is only present if the banType is temporary.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]160 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;messageRetractedDetails&quot;: {
162 &quot;retractedMessageId&quot;: &quot;A String&quot;,
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]164 &quot;superChatDetails&quot;: { # Details about the Super Chat event, this is only set if the type is &#x27;superChatEvent&#x27;.
165 &quot;tier&quot;: 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
166 &quot;userComment&quot;: &quot;A String&quot;, # The comment added by the user to this Super Chat event.
167 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made.
168 &quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
169 &quot;amountMicros&quot;: &quot;A String&quot;, # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
170 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]171 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]172 &quot;authorDetails&quot;: { # The authorDetails object contains basic details about the user that posted this message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]173 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]174 &quot;isVerified&quot;: True or False, # Whether the author&#x27;s identity has been verified by YouTube.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]175 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]176 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
177 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]178 &quot;isChatSponsor&quot;: True or False, # Whether the author is a sponsor of the live chat.
179 &quot;isChatOwner&quot;: True or False, # Whether the author is the owner of the live chat.
180 &quot;isChatModerator&quot;: True or False, # Whether the author is a moderator of the live chat.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]181 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]182 &quot;kind&quot;: &quot;youtube#liveChatMessage&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveChatMessage&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]183 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]184 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]185 }
186
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]191
192Returns:
193 An object of the form:
194
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]195 { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]196 &quot;snippet&quot;: { # The snippet object contains basic details about the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]197 &quot;messageDeletedDetails&quot;: {
198 &quot;deletedMessageId&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]199 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]200 &quot;superStickerDetails&quot;: { # Details about the Super Sticker event, this is only set if the type is &#x27;superStickerEvent&#x27;.
201 &quot;amountMicros&quot;: &quot;A String&quot;, # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
202 &quot;tier&quot;: 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
203 &quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
204 &quot;superStickerMetadata&quot;: { # Information about the Super Sticker.
205 &quot;altTextLanguage&quot;: &quot;A String&quot;, # Specifies the localization language in which the alt text is returned.
206 &quot;altText&quot;: &quot;A String&quot;, # Internationalized alt text that describes the sticker image and any animation associated with it.
207 &quot;stickerId&quot;: &quot;A String&quot;, # Unique identifier of the Super Sticker. This is a shorter form of the alt_text that includes pack name and a recognizable characteristic of the sticker.
208 },
209 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made.
210 },
211 &quot;hasDisplayContent&quot;: True or False, # Whether the message has display content that should be displayed to users.
212 &quot;type&quot;: &quot;A String&quot;, # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
213 &quot;authorChannelId&quot;: &quot;A String&quot;, # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase
214 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the message was orignally published. The value is specified in ISO 8601 format.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]215 &quot;displayMessage&quot;: &quot;A String&quot;, # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]216 &quot;liveChatId&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]217 &quot;textMessageDetails&quot;: { # Details about the text message, this is only set if the type is &#x27;textMessageEvent&#x27;.
218 &quot;messageText&quot;: &quot;A String&quot;, # The user&#x27;s message.
219 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]220 &quot;fanFundingEventDetails&quot;: { # Details about the funding event, this is only set if the type is &#x27;fanFundingEvent&#x27;.
221 &quot;userComment&quot;: &quot;A String&quot;, # The comment added by the user to this fan funding event.
222 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the fund was made.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]223 &quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]224 &quot;amountMicros&quot;: &quot;A String&quot;, # The amount of the fund.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]225 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]226 &quot;userBannedDetails&quot;: {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]227 &quot;banType&quot;: &quot;A String&quot;, # The type of ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]228 &quot;bannedUserDetails&quot;: { # The details of the user that was banned.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]229 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]230 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]231 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]232 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]233 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]234 &quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of the ban. This property is only present if the banType is temporary.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]235 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236 &quot;messageRetractedDetails&quot;: {
237 &quot;retractedMessageId&quot;: &quot;A String&quot;,
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]238 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]239 &quot;superChatDetails&quot;: { # Details about the Super Chat event, this is only set if the type is &#x27;superChatEvent&#x27;.
240 &quot;tier&quot;: 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
241 &quot;userComment&quot;: &quot;A String&quot;, # The comment added by the user to this Super Chat event.
242 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made.
243 &quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
244 &quot;amountMicros&quot;: &quot;A String&quot;, # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
245 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]246 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]247 &quot;authorDetails&quot;: { # The authorDetails object contains basic details about the user that posted this message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]248 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]249 &quot;isVerified&quot;: True or False, # Whether the author&#x27;s identity has been verified by YouTube.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]250 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]251 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
252 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]253 &quot;isChatSponsor&quot;: True or False, # Whether the author is a sponsor of the live chat.
254 &quot;isChatOwner&quot;: True or False, # Whether the author is the owner of the live chat.
255 &quot;isChatModerator&quot;: True or False, # Whether the author is a moderator of the live chat.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]257 &quot;kind&quot;: &quot;youtube#liveChatMessage&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveChatMessage&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]258 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]259 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]260 }</pre>
261</div>
262
263<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]264 <code class="details" id="list">list(liveChatId, part, maxResults=None, pageToken=None, profileImageSize=None, hl=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]265 <pre>Retrieves a list of resources, possibly filtered.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]266
267Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]268 liveChatId: string, The id of the live chat for which comments should be returned. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]269 part: string, The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet. (required) (repeated)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]270 maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
271 pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]272 profileImageSize: integer, Specifies the size of the profile image that should be returned for each user.
273 hl: string, Specifies the localization language in which the system messages should be returned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]274 x__xgafv: string, V1 error format.
275 Allowed values
276 1 - v1 error format
277 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]278
279Returns:
280 An object of the form:
281
282 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]283 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
284 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
285 &quot;kind&quot;: &quot;youtube#liveChatMessageListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveChatMessageListResponse&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]286 &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
287 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]288 &quot;offlineAt&quot;: &quot;A String&quot;, # The date and time when the underlying stream went offline. The value is specified in ISO 8601 format.
289 &quot;pollingIntervalMillis&quot;: 42, # The amount of time the client should wait before polling again.
290 &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.
291 &quot;totalResults&quot;: 42, # The total number of results in the result set.
292 &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
293 },
294 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
295 &quot;nextPageToken&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]296 &quot;items&quot;: [
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]297 { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]298 &quot;snippet&quot;: { # The snippet object contains basic details about the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]299 &quot;messageDeletedDetails&quot;: {
300 &quot;deletedMessageId&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]301 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]302 &quot;superStickerDetails&quot;: { # Details about the Super Sticker event, this is only set if the type is &#x27;superStickerEvent&#x27;.
303 &quot;amountMicros&quot;: &quot;A String&quot;, # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
304 &quot;tier&quot;: 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
305 &quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
306 &quot;superStickerMetadata&quot;: { # Information about the Super Sticker.
307 &quot;altTextLanguage&quot;: &quot;A String&quot;, # Specifies the localization language in which the alt text is returned.
308 &quot;altText&quot;: &quot;A String&quot;, # Internationalized alt text that describes the sticker image and any animation associated with it.
309 &quot;stickerId&quot;: &quot;A String&quot;, # Unique identifier of the Super Sticker. This is a shorter form of the alt_text that includes pack name and a recognizable characteristic of the sticker.
310 },
311 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made.
312 },
313 &quot;hasDisplayContent&quot;: True or False, # Whether the message has display content that should be displayed to users.
314 &quot;type&quot;: &quot;A String&quot;, # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
315 &quot;authorChannelId&quot;: &quot;A String&quot;, # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase
316 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the message was orignally published. The value is specified in ISO 8601 format.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]317 &quot;displayMessage&quot;: &quot;A String&quot;, # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]318 &quot;liveChatId&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]319 &quot;textMessageDetails&quot;: { # Details about the text message, this is only set if the type is &#x27;textMessageEvent&#x27;.
320 &quot;messageText&quot;: &quot;A String&quot;, # The user&#x27;s message.
321 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]322 &quot;fanFundingEventDetails&quot;: { # Details about the funding event, this is only set if the type is &#x27;fanFundingEvent&#x27;.
323 &quot;userComment&quot;: &quot;A String&quot;, # The comment added by the user to this fan funding event.
324 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the fund was made.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]325 &quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]326 &quot;amountMicros&quot;: &quot;A String&quot;, # The amount of the fund.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]327 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]328 &quot;userBannedDetails&quot;: {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]329 &quot;banType&quot;: &quot;A String&quot;, # The type of ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]330 &quot;bannedUserDetails&quot;: { # The details of the user that was banned.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]331 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]332 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]333 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]334 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]335 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]336 &quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of the ban. This property is only present if the banType is temporary.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]337 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338 &quot;messageRetractedDetails&quot;: {
339 &quot;retractedMessageId&quot;: &quot;A String&quot;,
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]340 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]341 &quot;superChatDetails&quot;: { # Details about the Super Chat event, this is only set if the type is &#x27;superChatEvent&#x27;.
342 &quot;tier&quot;: 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
343 &quot;userComment&quot;: &quot;A String&quot;, # The comment added by the user to this Super Chat event.
344 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made.
345 &quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
346 &quot;amountMicros&quot;: &quot;A String&quot;, # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
347 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]348 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]349 &quot;authorDetails&quot;: { # The authorDetails object contains basic details about the user that posted this message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]350 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]351 &quot;isVerified&quot;: True or False, # Whether the author&#x27;s identity has been verified by YouTube.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]352 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]353 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
354 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]355 &quot;isChatSponsor&quot;: True or False, # Whether the author is a sponsor of the live chat.
356 &quot;isChatOwner&quot;: True or False, # Whether the author is the owner of the live chat.
357 &quot;isChatModerator&quot;: True or False, # Whether the author is a moderator of the live chat.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]358 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]359 &quot;kind&quot;: &quot;youtube#liveChatMessage&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveChatMessage&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]360 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]361 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]362 },
363 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]364 }</pre>
365</div>
366
367<div class="method">
368 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
369 <pre>Retrieves the next page of results.
370
371Args:
372 previous_request: The request for the previous page. (required)
373 previous_response: The response from the request for the previous page. (required)
374
375Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]376 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]377 page. Returns None if there are no more items in the collection.
378 </pre>
379</div>
380
381</body></html>