Retrieves a list of members that match the request criteria for a channel.
list_next(previous_request, previous_response)
Retrieves the next page of results.
list(part, pageToken=None, maxResults=None, filterByMemberChannelId=None, hasAccessToLevel=None, mode=None, x__xgafv=None)
Retrieves a list of members that match the request criteria for a channel.
Args:
part: string, The <code><strong>part</strong></code> parameter specifies the
<code>member</code> resource parts that the API response will include. Set
the parameter value to <code>snippet</code>. (required) (repeated)
pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific
page in the result set that should be returned. In an API response, the
<code>nextPageToken</code> and <code>prevPageToken</code> properties
identify other pages that could be retrieved.
maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the
maximum number of items that should be returned in the result set.
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.
mode: string, Parameter that specifies which channel members to return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "youtube#memberListResponse", # Identifies what kind of resource this is. Value: the fixed string
# <code>"youtube#memberListResponse"</code>.
"visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
"tokenPagination": { # Stub token pagination template to suppress results.
},
"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.
},
"nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
# parameter to retrieve the next page in the result set.
"eventId": "A String", # Serialized EventId of the request which produced this response.
"etag": "A String", # Etag of this resource.
"items": [ # A list of members that match the request criteria.
{ # A <code><strong>member</strong></code> 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
# <code>"youtube#member"</code>.
"snippet": { # The <code>snippet</code> object contains basic details about the member.
"creatorChannelId": "A String", # The id of the channel that's offering memberships.
"membershipsDetails": { # Details about the user's membership.
"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.
"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).
"memberSince": "A String", # The date and time when the user became a continuous member across all
# levels.
},
"membershipsDurationAtLevels": [ # Data about memberships duration on particular pricing levels.
{
"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).
"level": "A String", # Pricing level ID.
},
],
"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.
},
"memberDetails": { # Details about the member.
"profileImageUrl": "A String", # The channels's avatar URL.
"channelUrl": "A String", # The channel's URL.
"displayName": "A String", # The channel's display name.
"channelId": "A String", # The YouTube channel ID.
},
},
},
],
}
list_next(previous_request, previous_response)
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.