blob: f7559e9f8bd6b8ddd9fd5f66025a32d1f44e49fd [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
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 Kim65020912020-05-20 12:08:20 -070078 <code><a href="#list">list(part, hl=None, maxResults=None, pageToken=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040079<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 Kim65020912020-05-20 12:08:20 -070085 <code class="details" id="list">list(part, hl=None, maxResults=None, pageToken=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040086 <pre>Lists Super Chat events for a channel.
87
88Args:
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 Cheemalapatic30d2b52017-03-13 12:12:03 -040090 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 Kim65020912020-05-20 12:08:20 -070092If localized resource details are available in that language, the resource&#x27;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&#x27;s default language.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040093 maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
Bu Sun Kim65020912020-05-20 12:08:20 -070094 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 Cheemalapatic30d2b52017-03-13 12:12:03 -040095
96Returns:
97 An object of the form:
98
99 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700100 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
101 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
102 &quot;items&quot;: [ # A list of Super Chat purchases that match the request criteria.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400103 { # A superChatEvent resource represents a Super Chat purchase on a YouTube channel.
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
105 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the Super Chat event.
106 &quot;kind&quot;: &quot;youtube#superChatEvent&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#superChatEvent&quot;.
107 &quot;snippet&quot;: { # The snippet object contains basic details about the Super Chat event.
108 &quot;amountMicros&quot;: &quot;A String&quot;, # The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000.
109 &quot;channelId&quot;: &quot;A String&quot;, # Channel id where the event occurred.
110 &quot;commentText&quot;: &quot;A String&quot;, # The text contents of the comment left by the user.
111 &quot;createdAt&quot;: &quot;A String&quot;, # The date and time when the event occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
112 &quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made. ISO 4217.
113 &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.
114 &quot;isSuperChatForGood&quot;: True or False, # True if this event is a Super Chat for Good purchase.
115 &quot;isSuperStickerEvent&quot;: True or False, # True if this event is a Super Sticker event.
116 &quot;messageType&quot;: 42, # The tier for the paid message, which is based on the amount of money spent to purchase the message.
117 &quot;nonprofit&quot;: { # 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 &quot;nonprofitId&quot;: { # Id of the nonprofit.
119 &quot;value&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700121 &quot;nonprofitLegalName&quot;: &quot;A String&quot;, # Legal name of the nonprofit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700122 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 &quot;superStickerMetadata&quot;: { # If this event is a Super Sticker event, this field will contain metadata about the Super Sticker.
124 &quot;altText&quot;: &quot;A String&quot;, # Internationalized alt text that describes the sticker image and any animation associated with it.
125 &quot;altTextLanguage&quot;: &quot;A String&quot;, # Specifies the localization language in which the alt text is returned.
126 &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.
127 },
128 &quot;supporterDetails&quot;: { # Details about the supporter.
129 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
130 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
131 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
132 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
133 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400134 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400135 },
136 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700137 &quot;kind&quot;: &quot;youtube#superChatEventListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#superChatEventListResponse&quot;.
138 &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.
139 &quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
140 &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
141 &quot;totalResults&quot;: 42, # The total number of results in the result set.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400142 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700143 &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400144 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700145 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400146 }</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
153Args:
154 previous_request: The request for the previous page. (required)
155 previous_response: The response from the request for the previous page. (required)
156
157Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400159 page. Returns None if there are no more items in the collection.
160 </pre>
161</div>
162
163</body></html>