1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.sponsors.html">sponsors</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(part, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of sponsors that match the request criteria for a channel.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(part, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieves a list of sponsors that match the request criteria for a channel.
Args:
part: string, The *part* parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet. (required) (repeated)
filter: string, Parameter that specifies which channel sponsors to return.
Allowed values
sponsorFilterUnknown -
newest - Return the most recent sponsors, from newest to oldest.
all - Return all sponsors, from newest to oldest.
maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # Etag of this resource.
"eventId": "A String", # Serialized EventId of the request which produced this response.
"items": [ # A list of sponsors that match the request criteria.
{ # A `__sponsor__` resource represents a sponsor for a YouTube channel. A sponsor provides recurring monetary support to a creator and receives special benefits.
"etag": "A String", # Etag of this resource.
"kind": "youtube#sponsor", # Identifies what kind of resource this is. Value: the fixed string `"youtube#sponsor"`.
"snippet": { # The `snippet` object contains basic details about the sponsor.
"channelId": "A String", # The id of the channel being sponsored.
"cumulativeDurationMonths": 42, # The cumulative time a user has been a sponsor in months.
"sponsorDetails": { # Details about the sponsor.
"channelId": "A String", # The YouTube channel ID.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"profileImageUrl": "A String", # The channels's avatar URL.
},
"sponsorSince": "A String", # The date and time when the user became a sponsor. The value is specified in ISO 8601 (`YYYY-MM-DDThh:mm:ss.sZ`) format.
},
},
],
"kind": "youtube#sponsorListResponse", # Identifies what kind of resource this is. Value: the fixed string `"youtube#sponsorListResponse".
"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.
"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
"resultsPerPage": 42, # The number of results included in the API response.
"totalResults": 42, # The total number of results in the result set.
},
"tokenPagination": { # Stub token pagination template to suppress results.
},
"visitorId": "A String", # The `visitorId` identifies the visitor.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
