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 75<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveChatMessages.html">liveChatMessages</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a chat message.</p> 83<p class="toc_element"> 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> 86<p class="toc_element"> 87 <code><a href="#list">list(liveChatId, part, hl=None, maxResults=None, pageToken=None, profileImageSize=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a list of resources, possibly filtered.</p> 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"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="delete">delete(id, x__xgafv=None)</code> 100 <pre>Deletes a chat message. 101 102Args: 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 108</pre> 109</div> 110 111<div class="method"> 112 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code> 113 <pre>Inserts a new resource into this collection. 114 115Args: 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) 117 body: object, The request body. 118 The object takes the form of: 119 120{ # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat. 121 "authorDetails": { # The authorDetails object contains basic details about the user that posted this message. 122 "channelId": "A String", # The YouTube channel ID. 123 "channelUrl": "A String", # The channel's URL. 124 "displayName": "A String", # The channel's display name. 125 "isChatModerator": True or False, # Whether the author is a moderator of the live chat. 126 "isChatOwner": True or False, # Whether the author is the owner of the live chat. 127 "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat. 128 "isVerified": True or False, # Whether the author's identity has been verified by YouTube. 129 "profileImageUrl": "A String", # The channels's avatar URL. 130 }, 131 "etag": "A String", # Etag of this resource. 132 "id": "A String", # The ID that YouTube assigns to uniquely identify the message. 133 "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". 134 "snippet": { # Next ID: 31 # The snippet object contains basic details about the message. 135 "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 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 136 "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. 137 "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. 138 "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. 139 "amountMicros": "A String", # The amount of the fund. 140 "currency": "A String", # The currency in which the fund was made. 141 "userComment": "A String", # The comment added by the user to this fan funding event. 142 }, 143 "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users. 144 "liveChatId": "A String", 145 "memberMilestoneChatDetails": { # Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'. 146 "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. 147 "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. 148 "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. 149 }, 150 "messageDeletedDetails": { 151 "deletedMessageId": "A String", 152 }, 153 "messageRetractedDetails": { 154 "retractedMessageId": "A String", 155 }, 156 "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". 157 "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. 158 "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. 159 }, 160 "publishedAt": "A String", # The date and time when the message was orignally published. 161 "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'. 162 "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. 163 "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). 164 "currency": "A String", # The currency in which the purchase was made. 165 "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. 166 "userComment": "A String", # The comment added by the user to this Super Chat event. 167 }, 168 "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'. 169 "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. 170 "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). 171 "currency": "A String", # The currency in which the purchase was made. 172 "superStickerMetadata": { # Information about the Super Sticker. 173 "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it. 174 "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned. 175 "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. 176 }, 177 "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. 178 }, 179 "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'. 180 "messageText": "A String", # The user's message. 181 }, 182 "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. 183 "userBannedDetails": { 184 "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary. 185 "banType": "A String", # The type of ban. 186 "bannedUserDetails": { # The details of the user that was banned. 187 "channelId": "A String", # The YouTube channel ID. 188 "channelUrl": "A String", # The channel's URL. 189 "displayName": "A String", # The channel's display name. 190 "profileImageUrl": "A String", # The channels's avatar URL. 191 }, 192 }, 193 }, 194} 195 196 x__xgafv: string, V1 error format. 197 Allowed values 198 1 - v1 error format 199 2 - v2 error format 200 201Returns: 202 An object of the form: 203 204 { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat. 205 "authorDetails": { # The authorDetails object contains basic details about the user that posted this message. 206 "channelId": "A String", # The YouTube channel ID. 207 "channelUrl": "A String", # The channel's URL. 208 "displayName": "A String", # The channel's display name. 209 "isChatModerator": True or False, # Whether the author is a moderator of the live chat. 210 "isChatOwner": True or False, # Whether the author is the owner of the live chat. 211 "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat. 212 "isVerified": True or False, # Whether the author's identity has been verified by YouTube. 213 "profileImageUrl": "A String", # The channels's avatar URL. 214 }, 215 "etag": "A String", # Etag of this resource. 216 "id": "A String", # The ID that YouTube assigns to uniquely identify the message. 217 "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". 218 "snippet": { # Next ID: 31 # The snippet object contains basic details about the message. 219 "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 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 220 "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. 221 "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. 222 "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. 223 "amountMicros": "A String", # The amount of the fund. 224 "currency": "A String", # The currency in which the fund was made. 225 "userComment": "A String", # The comment added by the user to this fan funding event. 226 }, 227 "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users. 228 "liveChatId": "A String", 229 "memberMilestoneChatDetails": { # Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'. 230 "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. 231 "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. 232 "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. 233 }, 234 "messageDeletedDetails": { 235 "deletedMessageId": "A String", 236 }, 237 "messageRetractedDetails": { 238 "retractedMessageId": "A String", 239 }, 240 "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". 241 "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. 242 "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. 243 }, 244 "publishedAt": "A String", # The date and time when the message was orignally published. 245 "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'. 246 "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. 247 "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). 248 "currency": "A String", # The currency in which the purchase was made. 249 "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. 250 "userComment": "A String", # The comment added by the user to this Super Chat event. 251 }, 252 "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'. 253 "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. 254 "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). 255 "currency": "A String", # The currency in which the purchase was made. 256 "superStickerMetadata": { # Information about the Super Sticker. 257 "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it. 258 "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned. 259 "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. 260 }, 261 "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. 262 }, 263 "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'. 264 "messageText": "A String", # The user's message. 265 }, 266 "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. 267 "userBannedDetails": { 268 "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary. 269 "banType": "A String", # The type of ban. 270 "bannedUserDetails": { # The details of the user that was banned. 271 "channelId": "A String", # The YouTube channel ID. 272 "channelUrl": "A String", # The channel's URL. 273 "displayName": "A String", # The channel's display name. 274 "profileImageUrl": "A String", # The channels's avatar URL. 275 }, 276 }, 277 }, 278}</pre> 279</div> 280 281<div class="method"> 282 <code class="details" id="list">list(liveChatId, part, hl=None, maxResults=None, pageToken=None, profileImageSize=None, x__xgafv=None)</code> 283 <pre>Retrieves a list of resources, possibly filtered. 284 285Args: 286 liveChatId: string, The id of the live chat for which comments should be returned. (required) 287 part: string, The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet. (required) (repeated) 288 hl: string, Specifies the localization language in which the system messages should be returned. 289 maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. 290 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. 291 profileImageSize: integer, Specifies the size of the profile image that should be returned for each user. 292 x__xgafv: string, V1 error format. 293 Allowed values 294 1 - v1 error format 295 2 - v2 error format 296 297Returns: 298 An object of the form: 299 300 { 301 "etag": "A String", # Etag of this resource. 302 "eventId": "A String", # Serialized EventId of the request which produced this response. 303 "items": [ 304 { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat. 305 "authorDetails": { # The authorDetails object contains basic details about the user that posted this message. 306 "channelId": "A String", # The YouTube channel ID. 307 "channelUrl": "A String", # The channel's URL. 308 "displayName": "A String", # The channel's display name. 309 "isChatModerator": True or False, # Whether the author is a moderator of the live chat. 310 "isChatOwner": True or False, # Whether the author is the owner of the live chat. 311 "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat. 312 "isVerified": True or False, # Whether the author's identity has been verified by YouTube. 313 "profileImageUrl": "A String", # The channels's avatar URL. 314 }, 315 "etag": "A String", # Etag of this resource. 316 "id": "A String", # The ID that YouTube assigns to uniquely identify the message. 317 "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". 318 "snippet": { # Next ID: 31 # The snippet object contains basic details about the message. 319 "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 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 320 "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. 321 "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. 322 "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. 323 "amountMicros": "A String", # The amount of the fund. 324 "currency": "A String", # The currency in which the fund was made. 325 "userComment": "A String", # The comment added by the user to this fan funding event. 326 }, 327 "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users. 328 "liveChatId": "A String", 329 "memberMilestoneChatDetails": { # Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'. 330 "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. 331 "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. 332 "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. 333 }, 334 "messageDeletedDetails": { 335 "deletedMessageId": "A String", 336 }, 337 "messageRetractedDetails": { 338 "retractedMessageId": "A String", 339 }, 340 "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". 341 "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. 342 "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. 343 }, 344 "publishedAt": "A String", # The date and time when the message was orignally published. 345 "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'. 346 "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. 347 "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). 348 "currency": "A String", # The currency in which the purchase was made. 349 "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. 350 "userComment": "A String", # The comment added by the user to this Super Chat event. 351 }, 352 "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'. 353 "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. 354 "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). 355 "currency": "A String", # The currency in which the purchase was made. 356 "superStickerMetadata": { # Information about the Super Sticker. 357 "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it. 358 "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned. 359 "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. 360 }, 361 "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. 362 }, 363 "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'. 364 "messageText": "A String", # The user's message. 365 }, 366 "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. 367 "userBannedDetails": { 368 "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary. 369 "banType": "A String", # The type of ban. 370 "bannedUserDetails": { # The details of the user that was banned. 371 "channelId": "A String", # The YouTube channel ID. 372 "channelUrl": "A String", # The channel's URL. 373 "displayName": "A String", # The channel's display name. 374 "profileImageUrl": "A String", # The channels's avatar URL. 375 }, 376 }, 377 }, 378 }, 379 ], 380 "kind": "youtube#liveChatMessageListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse". 381 "nextPageToken": "A String", 382 "offlineAt": "A String", # The date and time when the underlying stream went offline. 383 "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. 384 "resultsPerPage": 42, # The number of results included in the API response. 385 "totalResults": 42, # The total number of results in the result set. 386 }, 387 "pollingIntervalMillis": 42, # The amount of time the client should wait before polling again. 388 "tokenPagination": { # Stub token pagination template to suppress results. 389 }, 390 "visitorId": "A String", # The visitorId identifies the visitor. 391}</pre> 392</div> 393 394<div class="method"> 395 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 396 <pre>Retrieves the next page of results. 397 398Args: 399 previous_request: The request for the previous page. (required) 400 previous_response: The response from the request for the previous page. (required) 401 402Returns: 403 A request object that you can call 'execute()' on to request the next 404 page. Returns None if there are no more items in the collection. 405 </pre> 406</div> 407 408</body></html>