| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [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.superChatEvents.html">superChatEvents</a></h1> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 78 | <code><a href="#list">list(part, hl=None, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Retrieves a list of resources, possibly filtered.</p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 80 | <p class="toc_element"> |
| 81 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 85 | <code class="details" id="list">list(part, hl=None, pageToken=None, maxResults=None, x__xgafv=None)</code> |
| 86 | <pre>Retrieves a list of resources, possibly filtered. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 87 | |
| 88 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 89 | part: string, The <code><strong>part</strong></code> parameter specifies the |
| 90 | <code>superChatEvent</code> resource parts that the API response will |
| 91 | include. Supported values are <code>id</code> and <code>snippet</code>. (required) (repeated) |
| 92 | hl: string, Return rendered funding amounts in specified language. |
| 93 | pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| 94 | page in the result set that should be returned. In an API response, the |
| 95 | <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| 96 | identify other pages that could be retrieved. |
| 97 | maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| 98 | maximum number of items that should be returned in the result set. |
| 99 | x__xgafv: string, V1 error format. |
| 100 | Allowed values |
| 101 | 1 - v1 error format |
| 102 | 2 - v2 error format |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 103 | |
| 104 | Returns: |
| 105 | An object of the form: |
| 106 | |
| 107 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 108 | "kind": "youtube#superChatEventListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| 109 | # <code>"youtube#superChatEventListResponse"</code>. |
| 110 | "tokenPagination": { # Stub token pagination template to suppress results. |
| 111 | }, |
| 112 | "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
| 113 | "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| 114 | # parameter to retrieve the next page in the result set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 115 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| 116 | "items": [ # A list of Super Chat purchases that match the request criteria. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 117 | { # A `__superChatEvent__` resource represents a Super Chat purchase on a YouTube |
| 118 | # channel. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 119 | "id": "A String", # The ID that YouTube assigns to uniquely identify the Super Chat event. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 120 | "kind": "youtube#superChatEvent", # Identifies what kind of resource this is. Value: the fixed string |
| 121 | # `"youtube#superChatEvent"`. |
| 122 | "etag": "A String", # Etag of this resource. |
| 123 | "snippet": { # The `snippet` object contains basic details about the Super Chat event. |
| 124 | "messageType": 42, # The tier for the paid message, which is based on the amount of money spent |
| 125 | # to purchase the message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "commentText": "A String", # The text contents of the comment left by the user. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 127 | "displayString": "A String", # A rendered string that displays the purchase amount and currency |
| 128 | # (e.g., "$1.00"). The string is rendered for the given language. |
| 129 | "createdAt": "A String", # The date and time when the event occurred. The value is |
| 130 | # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 131 | # format. |
| 132 | "channelId": "A String", # Channel id where the event occurred. |
| 133 | "amountMicros": "A String", # The purchase amount, in micros of the purchase currency. e.g., 1 is |
| 134 | # represented as 1000000. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 135 | "supporterDetails": { # Details about the supporter. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 136 | "profileImageUrl": "A String", # The channels's avatar URL. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | "channelUrl": "A String", # The channel's URL. |
| 138 | "displayName": "A String", # The channel's display name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 139 | "channelId": "A String", # The YouTube channel ID. |
| 140 | }, |
| 141 | "currency": "A String", # The currency in which the purchase was made. ISO 4217. |
| 142 | "isSuperStickerEvent": True or False, # True if this event is a Super Sticker event. |
| 143 | "superStickerMetadata": { # If this event is a Super Sticker event, this field will contain metadata |
| 144 | # about the Super Sticker. |
| 145 | "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned. |
| 146 | "altText": "A String", # Internationalized alt text that describes the sticker image and any |
| 147 | # animation associated with it. |
| 148 | "stickerId": "A String", # Unique identifier of the Super Sticker. This is a shorter form of the |
| 149 | # alt_text that includes pack name and a recognizable characteristic of the |
| 150 | # sticker. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 151 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 152 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 153 | }, |
| 154 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 155 | "etag": "A String", # Etag of this resource. |
| 156 | "pageInfo": { # Paging details for lists of resources, including total number of items |
| 157 | # available and number of resources returned in a single page. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | "resultsPerPage": 42, # The number of results included in the API response. |
| 159 | "totalResults": 42, # The total number of results in the result set. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 160 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 161 | }</pre> |
| 162 | </div> |
| 163 | |
| 164 | <div class="method"> |
| 165 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 166 | <pre>Retrieves the next page of results. |
| 167 | |
| 168 | Args: |
| 169 | previous_request: The request for the previous page. (required) |
| 170 | previous_response: The response from the request for the previous page. (required) |
| 171 | |
| 172 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 173 | A request object that you can call 'execute()' on to request the next |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 174 | page. Returns None if there are no more items in the collection. |
| 175 | </pre> |
| 176 | </div> |
| 177 | |
| 178 | </body></html> |