YouTube Data API . members

list(part=*, pageToken=None, filterByMemberChannelId=None, maxResults=None, hasAccessToLevel=None, mode=None)

Lists members 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)
  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.
  filterByMemberChannelId: string, The filterByMemberChannelId parameter represents a comma separated list of channel IDs. Only data about members that are part of this list will be included in the response. It can be used to efficiently check whether specific users are entitled to perks offered via third parties.
  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
  hasAccessToLevel: string, The hasAccessToLevel parameter specifies, when set, the ID of a pricing level that members from the results set should have access to. When not set, all members will be considered, regardless of their active pricing level.
  mode: string, The mode parameter specifies which channel members to return.
    Allowed values
      all_current - Return all current members, from newest to oldest.
      updates - Return only members that joined after the first call with this mode was made.

Returns:
  An object of the form:

    {
    "eventId": "A String", # Serialized EventId of the request which produced this response.
    "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.
    "kind": "youtube#memberListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#memberListResponse".
    "visitorId": "A String", # The visitorId identifies the visitor.
    "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.
        "snippet": { # The snippet object contains basic details about the member.
          "membershipsDetails": { # Details about the user's membership.
            "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.
              {
                "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).
                "memberSince": "A String", # The date and time when the user became a continuous member for the given level.
                "level": "A String", # Pricing level id.
              },
            ],
            "highestAccessibleLevelDisplayName": "A String", # Display name of the highest level that the user has access to at the moment.
            "highestAccessibleLevel": "A String", # Id of the highest level that the user has access to at the moment.
            "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",
            ],
          },
          "creatorChannelId": "A String", # The id of the channel that's offering memberships.
          "memberDetails": { # Details about the member.
            "channelId": "A String", # The YouTube channel ID.
            "displayName": "A String", # The channel's display name.
            "profileImageUrl": "A String", # The channels's avatar URL.
            "channelUrl": "A String", # The channel's URL.
          },
        },
        "kind": "youtube#member", # Identifies what kind of resource this is. Value: the fixed string "youtube#member".
        "etag": "A String", # Etag of this resource.
      },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "etag": "A String", # Etag of this resource.
    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
      "totalResults": 42, # The total number of results in the result set.
      "resultsPerPage": 42, # The number of results included in the API response.
    },
  }

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.