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.superChatEvents.html">superChatEvents</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="#list">list(part, hl=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Retrieves a list of resources, possibly filtered.</p> 83<p class="toc_element"> 84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 85<p class="firstline">Retrieves the next page of results.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="list">list(part, hl=None, maxResults=None, pageToken=None, x__xgafv=None)</code> 94 <pre>Retrieves a list of resources, possibly filtered. 95 96Args: 97 part: string, The *part* parameter specifies the superChatEvent resource parts that the API response will include. This parameter is currently not supported. (required) (repeated) 98 hl: string, Return rendered funding amounts in specified language. 99 maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. 100 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. 101 x__xgafv: string, V1 error format. 102 Allowed values 103 1 - v1 error format 104 2 - v2 error format 105 106Returns: 107 An object of the form: 108 109 { 110 "etag": "A String", # Etag of this resource. 111 "eventId": "A String", # Serialized EventId of the request which produced this response. 112 "items": [ # A list of Super Chat purchases that match the request criteria. 113 { # A `__superChatEvent__` resource represents a Super Chat purchase on a YouTube channel. 114 "etag": "A String", # Etag of this resource. 115 "id": "A String", # The ID that YouTube assigns to uniquely identify the Super Chat event. 116 "kind": "youtube#superChatEvent", # Identifies what kind of resource this is. Value: the fixed string `"youtube#superChatEvent"`. 117 "snippet": { # The `snippet` object contains basic details about the Super Chat event. 118 "amountMicros": "A String", # The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000. 119 "channelId": "A String", # Channel id where the event occurred. 120 "commentText": "A String", # The text contents of the comment left by the user. 121 "createdAt": "A String", # The date and time when the event occurred. 122 "currency": "A String", # The currency in which the purchase was made. ISO 4217. 123 "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. 124 "isSuperStickerEvent": True or False, # True if this event is a Super Sticker event. 125 "messageType": 42, # The tier for the paid message, which is based on the amount of money spent to purchase the message. 126 "superStickerMetadata": { # If this event is a Super Sticker event, this field will contain metadata about the Super Sticker. 127 "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it. 128 "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned. 129 "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. 130 }, 131 "supporterDetails": { # Details about the supporter. 132 "channelId": "A String", # The YouTube channel ID. 133 "channelUrl": "A String", # The channel's URL. 134 "displayName": "A String", # The channel's display name. 135 "profileImageUrl": "A String", # The channels's avatar URL. 136 }, 137 }, 138 }, 139 ], 140 "kind": "youtube#superChatEventListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEventListResponse". 141 "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. 142 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. 143 "resultsPerPage": 42, # The number of results included in the API response. 144 "totalResults": 42, # The total number of results in the result set. 145 }, 146 "tokenPagination": { # Stub token pagination template to suppress results. 147 }, 148 "visitorId": "A String", # The visitorId identifies the visitor. 149}</pre> 150</div> 151 152<div class="method"> 153 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 154 <pre>Retrieves the next page of results. 155 156Args: 157 previous_request: The request for the previous page. (required) 158 previous_response: The response from the request for the previous page. (required) 159 160Returns: 161 A request object that you can call 'execute()' on to request the next 162 page. Returns None if there are no more items in the collection. 163 </pre> 164</div> 165 166</body></html>