| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Kim | d059ad8 | 2020-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 Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-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 Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 82 | <p class="firstline">Deletes a chat message.</p> |
| 83 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-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 Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 86 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(liveChatId, part, profileImageSize=None, hl=None, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 88 | <p class="firstline">Retrieves a list of resources, possibly filtered.</p> |
| Jon Wayne Parrott | 36e41bc | 2016-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 Frenkel | 3e17f89 | 2020-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 Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 99 | <code class="details" id="delete">delete(id, x__xgafv=None)</code> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 100 | <pre>Deletes a chat message. |
| 101 | |
| 102 | Args: |
| Bu Sun Kim | d059ad8 | 2020-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 Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 108 | </pre> |
| 109 | </div> |
| 110 | |
| 111 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-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 Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 114 | |
| 115 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 117 | body: object, The request body. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 118 | The object takes the form of: |
| 119 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 120 | { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | "etag": "A String", # Etag of this resource. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 122 | "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". |
| 123 | "snippet": { # The snippet object contains basic details about the message. |
| 124 | "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. |
| 125 | "userComment": "A String", # The comment added by the user to this fan funding event. |
| 126 | "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. |
| 127 | "currency": "A String", # The currency in which the fund was made. |
| 128 | "amountMicros": "A String", # The amount of the fund. |
| 129 | }, |
| 130 | "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. |
| 131 | "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'. |
| 132 | "messageText": "A String", # The user's message. |
| 133 | }, |
| 134 | "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'. |
| 135 | "currency": "A String", # The currency in which the purchase was made. |
| 136 | "superStickerMetadata": { # Information about the Super Sticker. |
| 137 | "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. |
| 138 | "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it. |
| 139 | "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned. |
| 140 | }, |
| 141 | "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. |
| 142 | "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). |
| 143 | "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. |
| 144 | }, |
| 145 | "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 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 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 146 | "userBannedDetails": { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 147 | "bannedUserDetails": { # The details of the user that was banned. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 148 | "channelId": "A String", # The YouTube channel ID. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 149 | "channelUrl": "A String", # The channel's URL. |
| 150 | "displayName": "A String", # The channel's display name. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 151 | "profileImageUrl": "A String", # The channels's avatar URL. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 152 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 153 | "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 154 | "banType": "A String", # The type of ban. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 155 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 156 | "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'. |
| 157 | "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). |
| 158 | "currency": "A String", # The currency in which the purchase was made. |
| 159 | "userComment": "A String", # The comment added by the user to this Super Chat event. |
| 160 | "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. |
| 161 | "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. |
| 162 | }, |
| 163 | "liveChatId": "A String", |
| 164 | "messageDeletedDetails": { |
| 165 | "deletedMessageId": "A String", |
| 166 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 167 | "messageRetractedDetails": { |
| 168 | "retractedMessageId": "A String", |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 169 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 170 | "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 format. |
| 171 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 172 | "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users. |
| 173 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 174 | "authorDetails": { # The authorDetails object contains basic details about the user that posted this message. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 175 | "channelUrl": "A String", # The channel's URL. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 176 | "displayName": "A String", # The channel's display name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 177 | "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat. |
| 178 | "isVerified": True or False, # Whether the author's identity has been verified by YouTube. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 179 | "profileImageUrl": "A String", # The channels's avatar URL. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 180 | "isChatModerator": True or False, # Whether the author is a moderator of the live chat. |
| 181 | "isChatOwner": True or False, # Whether the author is the owner of the live chat. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 182 | "channelId": "A String", # The YouTube channel ID. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 183 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 184 | "id": "A String", # The ID that YouTube assigns to uniquely identify the message. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 185 | } |
| 186 | |
| Bu Sun Kim | d059ad8 | 2020-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 Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 191 | |
| 192 | Returns: |
| 193 | An object of the form: |
| 194 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 195 | { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 196 | "etag": "A String", # Etag of this resource. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 197 | "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". |
| 198 | "snippet": { # The snippet object contains basic details about the message. |
| 199 | "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. |
| 200 | "userComment": "A String", # The comment added by the user to this fan funding event. |
| 201 | "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. |
| 202 | "currency": "A String", # The currency in which the fund was made. |
| 203 | "amountMicros": "A String", # The amount of the fund. |
| 204 | }, |
| 205 | "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. |
| 206 | "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'. |
| 207 | "messageText": "A String", # The user's message. |
| 208 | }, |
| 209 | "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'. |
| 210 | "currency": "A String", # The currency in which the purchase was made. |
| 211 | "superStickerMetadata": { # Information about the Super Sticker. |
| 212 | "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. |
| 213 | "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it. |
| 214 | "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned. |
| 215 | }, |
| 216 | "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. |
| 217 | "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). |
| 218 | "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. |
| 219 | }, |
| 220 | "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 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 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 221 | "userBannedDetails": { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 222 | "bannedUserDetails": { # The details of the user that was banned. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 223 | "channelId": "A String", # The YouTube channel ID. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 224 | "channelUrl": "A String", # The channel's URL. |
| 225 | "displayName": "A String", # The channel's display name. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 226 | "profileImageUrl": "A String", # The channels's avatar URL. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 227 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 228 | "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 229 | "banType": "A String", # The type of ban. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 230 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 231 | "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'. |
| 232 | "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). |
| 233 | "currency": "A String", # The currency in which the purchase was made. |
| 234 | "userComment": "A String", # The comment added by the user to this Super Chat event. |
| 235 | "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. |
| 236 | "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. |
| 237 | }, |
| 238 | "liveChatId": "A String", |
| 239 | "messageDeletedDetails": { |
| 240 | "deletedMessageId": "A String", |
| 241 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 242 | "messageRetractedDetails": { |
| 243 | "retractedMessageId": "A String", |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 244 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 245 | "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 format. |
| 246 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 247 | "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users. |
| 248 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 249 | "authorDetails": { # The authorDetails object contains basic details about the user that posted this message. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 250 | "channelUrl": "A String", # The channel's URL. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 251 | "displayName": "A String", # The channel's display name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 252 | "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat. |
| 253 | "isVerified": True or False, # Whether the author's identity has been verified by YouTube. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 254 | "profileImageUrl": "A String", # The channels's avatar URL. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 255 | "isChatModerator": True or False, # Whether the author is a moderator of the live chat. |
| 256 | "isChatOwner": True or False, # Whether the author is the owner of the live chat. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 257 | "channelId": "A String", # The YouTube channel ID. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 258 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 259 | "id": "A String", # The ID that YouTube assigns to uniquely identify the message. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 260 | }</pre> |
| 261 | </div> |
| 262 | |
| 263 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 264 | <code class="details" id="list">list(liveChatId, part, profileImageSize=None, hl=None, pageToken=None, maxResults=None, x__xgafv=None)</code> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 265 | <pre>Retrieves a list of resources, possibly filtered. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 266 | |
| 267 | Args: |
| Bu Sun Kim | d059ad8 | 2020-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 Frenkel | 3e17f89 | 2020-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) |
| 270 | profileImageSize: integer, Specifies the size of the profile image that should be returned for each user. |
| 271 | hl: string, Specifies the localization language in which the system messages should be returned. |
| 272 | 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. |
| 273 | maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| Bu Sun Kim | d059ad8 | 2020-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 Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 278 | |
| 279 | Returns: |
| 280 | An object of the form: |
| 281 | |
| 282 | { |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 283 | "tokenPagination": { # Stub token pagination template to suppress results. |
| 284 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 285 | "items": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 286 | { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 287 | "etag": "A String", # Etag of this resource. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 288 | "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". |
| 289 | "snippet": { # The snippet object contains basic details about the message. |
| 290 | "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. |
| 291 | "userComment": "A String", # The comment added by the user to this fan funding event. |
| 292 | "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. |
| 293 | "currency": "A String", # The currency in which the fund was made. |
| 294 | "amountMicros": "A String", # The amount of the fund. |
| 295 | }, |
| 296 | "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. |
| 297 | "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'. |
| 298 | "messageText": "A String", # The user's message. |
| 299 | }, |
| 300 | "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'. |
| 301 | "currency": "A String", # The currency in which the purchase was made. |
| 302 | "superStickerMetadata": { # Information about the Super Sticker. |
| 303 | "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. |
| 304 | "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it. |
| 305 | "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned. |
| 306 | }, |
| 307 | "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. |
| 308 | "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). |
| 309 | "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. |
| 310 | }, |
| 311 | "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 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 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 312 | "userBannedDetails": { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 313 | "bannedUserDetails": { # The details of the user that was banned. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 314 | "channelId": "A String", # The YouTube channel ID. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 315 | "channelUrl": "A String", # The channel's URL. |
| 316 | "displayName": "A String", # The channel's display name. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 317 | "profileImageUrl": "A String", # The channels's avatar URL. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 318 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 319 | "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 320 | "banType": "A String", # The type of ban. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 321 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 322 | "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'. |
| 323 | "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75). |
| 324 | "currency": "A String", # The currency in which the purchase was made. |
| 325 | "userComment": "A String", # The comment added by the user to this Super Chat event. |
| 326 | "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. |
| 327 | "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. |
| 328 | }, |
| 329 | "liveChatId": "A String", |
| 330 | "messageDeletedDetails": { |
| 331 | "deletedMessageId": "A String", |
| 332 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 333 | "messageRetractedDetails": { |
| 334 | "retractedMessageId": "A String", |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 335 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 336 | "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 format. |
| 337 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 338 | "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users. |
| 339 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 340 | "authorDetails": { # The authorDetails object contains basic details about the user that posted this message. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 341 | "channelUrl": "A String", # The channel's URL. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 342 | "displayName": "A String", # The channel's display name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 343 | "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat. |
| 344 | "isVerified": True or False, # Whether the author's identity has been verified by YouTube. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 345 | "profileImageUrl": "A String", # The channels's avatar URL. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 346 | "isChatModerator": True or False, # Whether the author is a moderator of the live chat. |
| 347 | "isChatOwner": True or False, # Whether the author is the owner of the live chat. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 348 | "channelId": "A String", # The YouTube channel ID. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 349 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 350 | "id": "A String", # The ID that YouTube assigns to uniquely identify the message. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 351 | }, |
| 352 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 353 | "etag": "A String", # Etag of this resource. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 354 | "kind": "youtube#liveChatMessageListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse". |
| 355 | "nextPageToken": "A String", |
| 356 | "pollingIntervalMillis": 42, # The amount of time the client should wait before polling again. |
| 357 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 358 | "resultsPerPage": 42, # The number of results included in the API response. |
| 359 | "totalResults": 42, # The total number of results in the result set. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 360 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 361 | "visitorId": "A String", # The visitorId identifies the visitor. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 362 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 363 | "offlineAt": "A String", # The date and time when the underlying stream went offline. The value is specified in ISO 8601 format. |
| Jon Wayne Parrott | 36e41bc | 2016-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 | |
| 371 | Args: |
| 372 | previous_request: The request for the previous page. (required) |
| 373 | previous_response: The response from the request for the previous page. (required) |
| 374 | |
| 375 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | A request object that you can call 'execute()' on to request the next |
| Jon Wayne Parrott | 36e41bc | 2016-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> |