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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<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.members.html">members</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, filterByMemberChannelId=None, hasAccessToLevel=None, maxResults=None, mode=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of members that match the request criteria for a channel.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</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, filterByMemberChannelId=None, hasAccessToLevel=None, maxResults=None, mode=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieves a list of members that match the request criteria for a channel.
Args:
part: string, The *part* parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet. (required) (repeated)
filterByMemberChannelId: string, Comma separated list of channel IDs. Only data about members that are part of this list will be included in the response.
hasAccessToLevel: string, Filter members in the results set to the ones that have access to a level.
maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
mode: string, Parameter that specifies which channel members to return.
Allowed values
listMembersModeUnknown -
updates - Return only members that joined after the first call with this mode was made.
all_current - Return all current members, from newest to oldest.
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 members that match the request criteria.
{ # A *member* resource represents a member for a YouTube channel. A member provides recurring monetary support to a creator and receives special benefits.
"etag": "A String", # Etag of this resource.
"kind": "youtube#member", # Identifies what kind of resource this is. Value: the fixed string "youtube#member".
"snippet": { # The snippet object contains basic details about the member.
"creatorChannelId": "A String", # The id of the channel that's offering memberships.
"memberDetails": { # Details about the member.
"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.
},
"membershipsDetails": { # Details about the user's membership.
"accessibleLevels": [ # Ids of all levels that the user has access to. This includes the currently active level and all other levels that are included because of a higher purchase.
"A String",
],
"highestAccessibleLevel": "A String", # Id of the highest level that the user has access to at the moment.
"highestAccessibleLevelDisplayName": "A String", # Display name for the highest level that the user has access to at the moment.
"membershipsDuration": { # Data about memberships duration without taking into consideration pricing levels.
"memberSince": "A String", # The date and time when the user became a continuous member across all levels.
"memberTotalDurationMonths": 42, # The cumulative time the user has been a member across all levels in complete months (the time is rounded down to the nearest integer).
},
"membershipsDurationAtLevels": [ # Data about memberships duration on particular pricing levels.
{
"level": "A String", # Pricing level ID.
"memberSince": "A String", # The date and time when the user became a continuous member for the given level.
"memberTotalDurationMonths": 42, # The cumulative time the user has been a member for the given level in complete months (the time is rounded down to the nearest integer).
},
],
},
},
},
],
"kind": "youtube#memberListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#memberListResponse".
"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()</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>
|
