MembersApi
extends AbstractApi
in package
This file is generated from spec/discovery.json (YouTube Data API v3, revision 20260924) by tools/generate.php. Do not edit it by hand - run `composer spec:build` instead.
A channel's members, which the API also calls sponsors.
Reach it as $youtube->members. Every method takes the parameters Google
documents, by the same names: use named arguments for the optional ones.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- list() : PromiseInterface<string|int, MemberListResponse>
- Retrieves a list of members that match the request criteria for a channel.
- call() : PromiseInterface<string|int, mixed>
- streamed() : PromiseInterface<string|int, ResponseStream>
- Opens a server-streamed call and reads its body as it arrives.
Properties
$youtube read-only
protected
YouTube
$youtube
Methods
__construct()
public
__construct(YouTube $youtube) : mixed
Parameters
- $youtube : YouTube
list()
Retrieves a list of members that match the request criteria for a channel.
public
list(array<int, string>|string $part[, string|null $filterByMemberChannelId = null ][, string|null $hasAccessToLevel = null ][, int|null $maxResults = null ][, string|null $mode = null ][, string|null $pageToken = null ]) : PromiseInterface<string|int, MemberListResponse>
Costs 2 units of quota, by estimate: the quota calculator says 1 and the method's own page says 2.
Parameters
- $part : array<int, string>|string
-
The part parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet.
- $filterByMemberChannelId : string|null = null
-
Comma separated list of channel IDs. Only data about members that are part of this list will be included in the response.
- $hasAccessToLevel : string|null = null
-
Filter members in the results set to the ones that have access to a level.
- $maxResults : int|null = null
-
The maxResults parameter specifies the maximum number of items that should be returned in the result set. From 0 to 1000. YouTube assumes
5when it is left out. - $mode : string|null = null
-
Parameter that specifies which channel members to return. One of
listMembersModeUnknown,updates,all_current. YouTube assumesall_currentwhen it is left out. - $pageToken : string|null = null
-
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.
Tags
Return values
PromiseInterface<string|int, MemberListResponse>call()
protected
call(string $endpoint, string $method, string $path[, array<string, mixed> $query = [] ][, array<string, mixed>|JsonSerializable|null $body = null ][, string|null $returns = null ][, ?Media $media = null ][, ?string $uploadPath = null ][, bool $download = false ]) : PromiseInterface<string|int, mixed>
Parameters
- $endpoint : string
-
The API method, e.g.
liveChatMessages.list. - $method : string
- $path : string
- $query : array<string, mixed> = []
- $body : array<string, mixed>|JsonSerializable|null = null
- $returns : string|null = null
-
The type token the result hydrates as; null leaves it raw.
- $media : ?Media = null
- $uploadPath : ?string = null
- $download : bool = false
Return values
PromiseInterface<string|int, mixed>streamed()
Opens a server-streamed call and reads its body as it arrives.
protected
streamed(string $endpoint, string $path, array<string, mixed> $query, string $returns) : PromiseInterface<string|int, ResponseStream>
Parameters
- $endpoint : string
- $path : string
- $query : array<string, mixed>
- $returns : string
-
The type token each element hydrates as.