| 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 | |
| 75 | <h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.superChatEvents.html">superChatEvents</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 78 | <code><a href="#list">list(part, hl=None, maxResults=None, pageToken=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 79 | <p class="firstline">Lists Super Chat events for a channel.</p> |
| 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 | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 85 | <code class="details" id="list">list(part, hl=None, maxResults=None, pageToken=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 86 | <pre>Lists Super Chat events for a channel. |
| 87 | |
| 88 | Args: |
| 89 | part: string, The part parameter specifies the superChatEvent resource parts that the API response will include. Supported values are id and snippet. (required) |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 90 | hl: string, The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. |
| 91 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 92 | If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 93 | maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 94 | pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 95 | |
| 96 | Returns: |
| 97 | An object of the form: |
| 98 | |
| 99 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 100 | "etag": "A String", # Etag of this resource. |
| 101 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| 102 | "items": [ # A list of Super Chat purchases that match the request criteria. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 103 | { # A superChatEvent resource represents a Super Chat purchase on a YouTube channel. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 104 | "etag": "A String", # Etag of this resource. |
| 105 | "id": "A String", # The ID that YouTube assigns to uniquely identify the Super Chat event. |
| 106 | "kind": "youtube#superChatEvent", # Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEvent". |
| 107 | "snippet": { # The snippet object contains basic details about the Super Chat event. |
| 108 | "amountMicros": "A String", # The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000. |
| 109 | "channelId": "A String", # Channel id where the event occurred. |
| 110 | "commentText": "A String", # The text contents of the comment left by the user. |
| 111 | "createdAt": "A String", # The date and time when the event occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 112 | "currency": "A String", # The currency in which the purchase was made. ISO 4217. |
| 113 | "displayString": "A String", # A rendered string that displays the purchase amount and currency (e.g., "$1.00"). The string is rendered for the given language. |
| 114 | "isSuperChatForGood": True or False, # True if this event is a Super Chat for Good purchase. |
| 115 | "isSuperStickerEvent": True or False, # True if this event is a Super Sticker event. |
| 116 | "messageType": 42, # The tier for the paid message, which is based on the amount of money spent to purchase the message. |
| 117 | "nonprofit": { # Nonprofit information. # If this event is a Super Chat for Good purchase, this field will contain information about the charity the purchase is donated to. |
| 118 | "nonprofitId": { # Id of the nonprofit. |
| 119 | "value": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | "nonprofitLegalName": "A String", # Legal name of the nonprofit. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | "superStickerMetadata": { # If this event is a Super Sticker event, this field will contain metadata about the Super Sticker. |
| 124 | "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it. |
| 125 | "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned. |
| 126 | "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. |
| 127 | }, |
| 128 | "supporterDetails": { # Details about the supporter. |
| 129 | "channelId": "A String", # The YouTube channel ID. |
| 130 | "channelUrl": "A String", # The channel's URL. |
| 131 | "displayName": "A String", # The channel's display name. |
| 132 | "profileImageUrl": "A String", # The channels's avatar URL. |
| 133 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 134 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 135 | }, |
| 136 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | "kind": "youtube#superChatEventListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEventListResponse". |
| 138 | "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. |
| 139 | "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. |
| 140 | "resultsPerPage": 42, # The number of results included in the API response. |
| 141 | "totalResults": 42, # The total number of results in the result set. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 142 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 143 | "tokenPagination": { # Stub token pagination template to suppress results. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 144 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 145 | "visitorId": "A String", # The visitorId identifies the visitor. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 146 | }</pre> |
| 147 | </div> |
| 148 | |
| 149 | <div class="method"> |
| 150 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 151 | <pre>Retrieves the next page of results. |
| 152 | |
| 153 | Args: |
| 154 | previous_request: The request for the previous page. (required) |
| 155 | previous_response: The response from the request for the previous page. (required) |
| 156 | |
| 157 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | 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] | 159 | page. Returns None if there are no more items in the collection. |
| 160 | </pre> |
| 161 | </div> |
| 162 | |
| 163 | </body></html> |