-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
youtube_v3.liveChatMessages.html
567 lines (536 loc) 路 45.8 KB
/
youtube_v3.liveChatMessages.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveChatMessages.html">liveChatMessages</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a chat message.</p>
<p class="toc_element">
<code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new resource into this collection.</p>
<p class="toc_element">
<code><a href="#list">list(liveChatId, part, hl=None, maxResults=None, pageToken=None, profileImageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(id, x__xgafv=None)</code>
<pre>Deletes a chat message.
Args:
id: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
<pre>Inserts a new resource into this collection.
Args:
part: string, The *part* parameter 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)
body: object, The request body.
The object takes the form of:
{ # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
"authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
"channelId": "A String", # The YouTube channel ID.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"isChatModerator": True or False, # Whether the author is a moderator of the live chat.
"isChatOwner": True or False, # Whether the author is the owner of the live chat.
"isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
"isVerified": True or False, # Whether the author's identity has been verified by YouTube.
"profileImageUrl": "A String", # The channels's avatar URL.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the message.
"kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
"snippet": { # Next ID: 34 # The snippet object contains basic details about the message.
"authorChannelId": "A String", # 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 memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership 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 superStickerEvent - the user that made the purchase pollEvent - the user that created the poll
"displayMessage": "A String", # 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.
"fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount of the fund.
"currency": "A String", # The currency in which the fund was made.
"userComment": "A String", # The comment added by the user to this fan funding event.
},
"giftMembershipReceivedDetails": { # Details about the Gift Membership Received event, this is only set if the type is 'giftMembershipReceivedEvent'.
"associatedMembershipGiftingMessageId": "A String", # The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is 'membershipGiftingEvent'.
"gifterChannelId": "A String", # The ID of the user that made the membership gifting purchase. This matches the `snippet.authorChannelId` of the associated membership gifting message.
"memberLevelName": "A String", # The name of the Level at which the viewer is a member. This matches the `snippet.membershipGiftingDetails.giftMembershipsLevelName` of the associated membership gifting message. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
"liveChatId": "A String",
"memberMilestoneChatDetails": { # Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'.
"memberLevelName": "A String", # The name of the Level at which the viever is a member. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
"memberMonth": 42, # The total amount of months (rounded up) the viewer has been a member that granted them this Member Milestone Chat. This is the same number of months as is being displayed to YouTube users.
"userComment": "A String", # The comment added by the member to this Member Milestone Chat. This field is empty for messages without a comment from the member.
},
"membershipGiftingDetails": { # Details about the Membership Gifting event, this is only set if the type is 'membershipGiftingEvent'.
"giftMembershipsCount": 42, # The number of gift memberships purchased by the user.
"giftMembershipsLevelName": "A String", # The name of the level of the gift memberships purchased by the user. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"messageDeletedDetails": {
"deletedMessageId": "A String",
},
"messageRetractedDetails": {
"retractedMessageId": "A String",
},
"newSponsorDetails": { # Details about the New Member Announcement event, this is only set if the type is 'newSponsorEvent'. Please note that "member" is the new term for "sponsor".
"isUpgrade": True or False, # If the viewer just had upgraded from a lower level. For viewers that were not members at the time of purchase, this field is false.
"memberLevelName": "A String", # The name of the Level that the viewer just had joined. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"pollDetails": { # Details about the poll event, this is only set if the type is 'pollEvent'.
"metadata": {
"options": [ # The options will be returned in the order that is displayed in 1P
{
"optionText": "A String",
"tally": "A String",
},
],
"questionText": "A String",
},
"status": "A String",
},
"publishedAt": "A String", # The date and time when the message was orignally published.
"superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
"currency": "A String", # The currency in which the purchase was made.
"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
"userComment": "A String", # The comment added by the user to this Super Chat event.
},
"superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
"currency": "A String", # The currency in which the purchase was made.
"superStickerMetadata": { # Information about the Super Sticker.
"altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it.
"altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
"stickerId": "A String", # 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.
},
"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
},
"textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
"messageText": "A String", # The user's message.
},
"type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
"userBannedDetails": {
"banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
"banType": "A String", # The type of ban.
"bannedUserDetails": { # The details of the user that was banned.
"channelId": "A String", # The YouTube channel ID.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"profileImageUrl": "A String", # The channels's avatar URL.
},
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
"authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
"channelId": "A String", # The YouTube channel ID.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"isChatModerator": True or False, # Whether the author is a moderator of the live chat.
"isChatOwner": True or False, # Whether the author is the owner of the live chat.
"isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
"isVerified": True or False, # Whether the author's identity has been verified by YouTube.
"profileImageUrl": "A String", # The channels's avatar URL.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the message.
"kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
"snippet": { # Next ID: 34 # The snippet object contains basic details about the message.
"authorChannelId": "A String", # 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 memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership 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 superStickerEvent - the user that made the purchase pollEvent - the user that created the poll
"displayMessage": "A String", # 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.
"fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount of the fund.
"currency": "A String", # The currency in which the fund was made.
"userComment": "A String", # The comment added by the user to this fan funding event.
},
"giftMembershipReceivedDetails": { # Details about the Gift Membership Received event, this is only set if the type is 'giftMembershipReceivedEvent'.
"associatedMembershipGiftingMessageId": "A String", # The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is 'membershipGiftingEvent'.
"gifterChannelId": "A String", # The ID of the user that made the membership gifting purchase. This matches the `snippet.authorChannelId` of the associated membership gifting message.
"memberLevelName": "A String", # The name of the Level at which the viewer is a member. This matches the `snippet.membershipGiftingDetails.giftMembershipsLevelName` of the associated membership gifting message. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
"liveChatId": "A String",
"memberMilestoneChatDetails": { # Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'.
"memberLevelName": "A String", # The name of the Level at which the viever is a member. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
"memberMonth": 42, # The total amount of months (rounded up) the viewer has been a member that granted them this Member Milestone Chat. This is the same number of months as is being displayed to YouTube users.
"userComment": "A String", # The comment added by the member to this Member Milestone Chat. This field is empty for messages without a comment from the member.
},
"membershipGiftingDetails": { # Details about the Membership Gifting event, this is only set if the type is 'membershipGiftingEvent'.
"giftMembershipsCount": 42, # The number of gift memberships purchased by the user.
"giftMembershipsLevelName": "A String", # The name of the level of the gift memberships purchased by the user. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"messageDeletedDetails": {
"deletedMessageId": "A String",
},
"messageRetractedDetails": {
"retractedMessageId": "A String",
},
"newSponsorDetails": { # Details about the New Member Announcement event, this is only set if the type is 'newSponsorEvent'. Please note that "member" is the new term for "sponsor".
"isUpgrade": True or False, # If the viewer just had upgraded from a lower level. For viewers that were not members at the time of purchase, this field is false.
"memberLevelName": "A String", # The name of the Level that the viewer just had joined. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"pollDetails": { # Details about the poll event, this is only set if the type is 'pollEvent'.
"metadata": {
"options": [ # The options will be returned in the order that is displayed in 1P
{
"optionText": "A String",
"tally": "A String",
},
],
"questionText": "A String",
},
"status": "A String",
},
"publishedAt": "A String", # The date and time when the message was orignally published.
"superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
"currency": "A String", # The currency in which the purchase was made.
"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
"userComment": "A String", # The comment added by the user to this Super Chat event.
},
"superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
"currency": "A String", # The currency in which the purchase was made.
"superStickerMetadata": { # Information about the Super Sticker.
"altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it.
"altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
"stickerId": "A String", # 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.
},
"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
},
"textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
"messageText": "A String", # The user's message.
},
"type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
"userBannedDetails": {
"banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
"banType": "A String", # The type of ban.
"bannedUserDetails": { # The details of the user that was banned.
"channelId": "A String", # The YouTube channel ID.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"profileImageUrl": "A String", # The channels's avatar URL.
},
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(liveChatId, part, hl=None, maxResults=None, pageToken=None, profileImageSize=None, x__xgafv=None)</code>
<pre>Retrieves a list of resources, possibly filtered.
Args:
liveChatId: string, The id of the live chat for which comments should be returned. (required)
part: string, The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet. (required) (repeated)
hl: string, Specifies the localization language in which the system messages should be returned.
maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.
profileImageSize: integer, Specifies the size of the profile image that should be returned for each user.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"activePollItem": { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat. # Set when there is an active poll.
"authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
"channelId": "A String", # The YouTube channel ID.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"isChatModerator": True or False, # Whether the author is a moderator of the live chat.
"isChatOwner": True or False, # Whether the author is the owner of the live chat.
"isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
"isVerified": True or False, # Whether the author's identity has been verified by YouTube.
"profileImageUrl": "A String", # The channels's avatar URL.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the message.
"kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
"snippet": { # Next ID: 34 # The snippet object contains basic details about the message.
"authorChannelId": "A String", # 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 memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership 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 superStickerEvent - the user that made the purchase pollEvent - the user that created the poll
"displayMessage": "A String", # 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.
"fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount of the fund.
"currency": "A String", # The currency in which the fund was made.
"userComment": "A String", # The comment added by the user to this fan funding event.
},
"giftMembershipReceivedDetails": { # Details about the Gift Membership Received event, this is only set if the type is 'giftMembershipReceivedEvent'.
"associatedMembershipGiftingMessageId": "A String", # The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is 'membershipGiftingEvent'.
"gifterChannelId": "A String", # The ID of the user that made the membership gifting purchase. This matches the `snippet.authorChannelId` of the associated membership gifting message.
"memberLevelName": "A String", # The name of the Level at which the viewer is a member. This matches the `snippet.membershipGiftingDetails.giftMembershipsLevelName` of the associated membership gifting message. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
"liveChatId": "A String",
"memberMilestoneChatDetails": { # Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'.
"memberLevelName": "A String", # The name of the Level at which the viever is a member. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
"memberMonth": 42, # The total amount of months (rounded up) the viewer has been a member that granted them this Member Milestone Chat. This is the same number of months as is being displayed to YouTube users.
"userComment": "A String", # The comment added by the member to this Member Milestone Chat. This field is empty for messages without a comment from the member.
},
"membershipGiftingDetails": { # Details about the Membership Gifting event, this is only set if the type is 'membershipGiftingEvent'.
"giftMembershipsCount": 42, # The number of gift memberships purchased by the user.
"giftMembershipsLevelName": "A String", # The name of the level of the gift memberships purchased by the user. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"messageDeletedDetails": {
"deletedMessageId": "A String",
},
"messageRetractedDetails": {
"retractedMessageId": "A String",
},
"newSponsorDetails": { # Details about the New Member Announcement event, this is only set if the type is 'newSponsorEvent'. Please note that "member" is the new term for "sponsor".
"isUpgrade": True or False, # If the viewer just had upgraded from a lower level. For viewers that were not members at the time of purchase, this field is false.
"memberLevelName": "A String", # The name of the Level that the viewer just had joined. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"pollDetails": { # Details about the poll event, this is only set if the type is 'pollEvent'.
"metadata": {
"options": [ # The options will be returned in the order that is displayed in 1P
{
"optionText": "A String",
"tally": "A String",
},
],
"questionText": "A String",
},
"status": "A String",
},
"publishedAt": "A String", # The date and time when the message was orignally published.
"superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
"currency": "A String", # The currency in which the purchase was made.
"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
"userComment": "A String", # The comment added by the user to this Super Chat event.
},
"superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
"currency": "A String", # The currency in which the purchase was made.
"superStickerMetadata": { # Information about the Super Sticker.
"altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it.
"altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
"stickerId": "A String", # 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.
},
"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
},
"textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
"messageText": "A String", # The user's message.
},
"type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
"userBannedDetails": {
"banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
"banType": "A String", # The type of ban.
"bannedUserDetails": { # The details of the user that was banned.
"channelId": "A String", # The YouTube channel ID.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"profileImageUrl": "A String", # The channels's avatar URL.
},
},
},
},
"etag": "A String", # Etag of this resource.
"eventId": "A String", # Serialized EventId of the request which produced this response.
"items": [
{ # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
"authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
"channelId": "A String", # The YouTube channel ID.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"isChatModerator": True or False, # Whether the author is a moderator of the live chat.
"isChatOwner": True or False, # Whether the author is the owner of the live chat.
"isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
"isVerified": True or False, # Whether the author's identity has been verified by YouTube.
"profileImageUrl": "A String", # The channels's avatar URL.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the message.
"kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
"snippet": { # Next ID: 34 # The snippet object contains basic details about the message.
"authorChannelId": "A String", # 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 memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership 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 superStickerEvent - the user that made the purchase pollEvent - the user that created the poll
"displayMessage": "A String", # 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.
"fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount of the fund.
"currency": "A String", # The currency in which the fund was made.
"userComment": "A String", # The comment added by the user to this fan funding event.
},
"giftMembershipReceivedDetails": { # Details about the Gift Membership Received event, this is only set if the type is 'giftMembershipReceivedEvent'.
"associatedMembershipGiftingMessageId": "A String", # The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is 'membershipGiftingEvent'.
"gifterChannelId": "A String", # The ID of the user that made the membership gifting purchase. This matches the `snippet.authorChannelId` of the associated membership gifting message.
"memberLevelName": "A String", # The name of the Level at which the viewer is a member. This matches the `snippet.membershipGiftingDetails.giftMembershipsLevelName` of the associated membership gifting message. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
"liveChatId": "A String",
"memberMilestoneChatDetails": { # Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'.
"memberLevelName": "A String", # The name of the Level at which the viever is a member. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
"memberMonth": 42, # The total amount of months (rounded up) the viewer has been a member that granted them this Member Milestone Chat. This is the same number of months as is being displayed to YouTube users.
"userComment": "A String", # The comment added by the member to this Member Milestone Chat. This field is empty for messages without a comment from the member.
},
"membershipGiftingDetails": { # Details about the Membership Gifting event, this is only set if the type is 'membershipGiftingEvent'.
"giftMembershipsCount": 42, # The number of gift memberships purchased by the user.
"giftMembershipsLevelName": "A String", # The name of the level of the gift memberships purchased by the user. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"messageDeletedDetails": {
"deletedMessageId": "A String",
},
"messageRetractedDetails": {
"retractedMessageId": "A String",
},
"newSponsorDetails": { # Details about the New Member Announcement event, this is only set if the type is 'newSponsorEvent'. Please note that "member" is the new term for "sponsor".
"isUpgrade": True or False, # If the viewer just had upgraded from a lower level. For viewers that were not members at the time of purchase, this field is false.
"memberLevelName": "A String", # The name of the Level that the viewer just had joined. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.
},
"pollDetails": { # Details about the poll event, this is only set if the type is 'pollEvent'.
"metadata": {
"options": [ # The options will be returned in the order that is displayed in 1P
{
"optionText": "A String",
"tally": "A String",
},
],
"questionText": "A String",
},
"status": "A String",
},
"publishedAt": "A String", # The date and time when the message was orignally published.
"superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
"currency": "A String", # The currency in which the purchase was made.
"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
"userComment": "A String", # The comment added by the user to this Super Chat event.
},
"superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
"amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
"amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
"currency": "A String", # The currency in which the purchase was made.
"superStickerMetadata": { # Information about the Super Sticker.
"altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it.
"altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
"stickerId": "A String", # 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.
},
"tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
},
"textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
"messageText": "A String", # The user's message.
},
"type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
"userBannedDetails": {
"banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
"banType": "A String", # The type of ban.
"bannedUserDetails": { # The details of the user that was banned.
"channelId": "A String", # The YouTube channel ID.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"profileImageUrl": "A String", # The channels's avatar URL.
},
},
},
},
],
"kind": "youtube#liveChatMessageListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse".
"nextPageToken": "A String",
"offlineAt": "A String", # The date and time when the underlying stream went offline.
"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.
"resultsPerPage": 42, # The number of results included in the API response.
"totalResults": 42, # The total number of results in the result set.
},
"pollingIntervalMillis": 42, # The amount of time the client should wait before polling again.
"tokenPagination": { # Stub token pagination template to suppress results.
},
"visitorId": "A String", # The visitorId identifies the visitor.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>