blob: 462650247d2d7714a588bbeec2a6f9b33363ec29 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001<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
Bu Sun Kimd059ad82020-07-22 17:02:09 -070075<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.superChatEvents.html">superChatEvents</a></h1>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080081 <code><a href="#list">list(part, hl=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070082<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040083<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080093 <code class="details" id="list">list(part, hl=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070094 <pre>Retrieves a list of resources, possibly filtered.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040095
96Args:
yoshi-code-bot04bafe12021-06-29 00:20:25 -070097 part: string, The *part* parameter specifies the superChatEvent resource parts that the API response will include. This parameter is currently not supported. (required) (repeated)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080098 hl: string, Return rendered funding amounts in specified language.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080099 maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800100 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400105
106Returns:
107 An object of the form:
108
109 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800110 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
111 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
112 &quot;items&quot;: [ # 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 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
115 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the Super Chat event.
116 &quot;kind&quot;: &quot;youtube#superChatEvent&quot;, # Identifies what kind of resource this is. Value: the fixed string `&quot;youtube#superChatEvent&quot;`.
117 &quot;snippet&quot;: { # The `snippet` object contains basic details about the Super Chat event.
118 &quot;amountMicros&quot;: &quot;A String&quot;, # The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000.
119 &quot;channelId&quot;: &quot;A String&quot;, # Channel id where the event occurred.
120 &quot;commentText&quot;: &quot;A String&quot;, # The text contents of the comment left by the user.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800121 &quot;createdAt&quot;: &quot;A String&quot;, # The date and time when the event occurred.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800122 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made. ISO 4217.
123 &quot;displayString&quot;: &quot;A String&quot;, # A rendered string that displays the purchase amount and currency (e.g., &quot;$1.00&quot;). The string is rendered for the given language.
124 &quot;isSuperStickerEvent&quot;: True or False, # True if this event is a Super Sticker event.
125 &quot;messageType&quot;: 42, # The tier for the paid message, which is based on the amount of money spent to purchase the message.
126 &quot;superStickerMetadata&quot;: { # If this event is a Super Sticker event, this field will contain metadata about the Super Sticker.
127 &quot;altText&quot;: &quot;A String&quot;, # Internationalized alt text that describes the sticker image and any animation associated with it.
128 &quot;altTextLanguage&quot;: &quot;A String&quot;, # Specifies the localization language in which the alt text is returned.
129 &quot;stickerId&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800130 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800131 &quot;supporterDetails&quot;: { # Details about the supporter.
132 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
133 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
134 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
135 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
136 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800137 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800138 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800139 ],
140 &quot;kind&quot;: &quot;youtube#superChatEventListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#superChatEventListResponse&quot;.
141 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
142 &quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
143 &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
144 &quot;totalResults&quot;: 42, # The total number of results in the result set.
145 },
146 &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
147 },
148 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
149}</pre>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400150</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700161 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400162 page. Returns None if there are no more items in the collection.
163 </pre>
164</div>
165
166</body></html>