list method

Future<ChannelListResponse> list(List<String> part, { String? categoryId, String? forHandle, String? forUsername, String? hl, List<String>? id, bool? managedByMe, int? maxResults, bool? mine, bool? mySubscribers, String? onBehalfOfContentOwner, String? pageToken, String? $fields, })

Retrieves a list of resources, possibly filtered.

Request parameters:

part - The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties.

categoryId - Return the channels within the specified guide category ID.

forHandle - Return the channel associated with a YouTube handle.

forUsername - Return the channel associated with a YouTube username.

hl - Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).

id - Return the channels with the specified IDs.

managedByMe - Return the channels managed by the authenticated user.

maxResults - The maxResults parameter specifies the maximum number of items that should be returned in the result set. Value must be between "0" and "50".

mine - Return the ids of channels owned by the authenticated user.

mySubscribers - Return the channels subscribed to the authenticated user

onBehalfOfContentOwner - Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

pageToken - 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.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ChannelListResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ChannelListResponse> list(
  core.List<core.String> part, {
  core.String? categoryId,
  core.String? forHandle,
  core.String? forUsername,
  core.String? hl,
  core.List<core.String>? id,
  core.bool? managedByMe,
  core.int? maxResults,
  core.bool? mine,
  core.bool? mySubscribers,
  core.String? onBehalfOfContentOwner,
  core.String? pageToken,
  core.String? $fields,
}) async {
  if (part.isEmpty) {
    throw core.ArgumentError('Parameter part cannot be empty.');
  }
  final queryParams_ = <core.String, core.List<core.String>>{
    'part': part,
    if (categoryId != null) 'categoryId': [categoryId],
    if (forHandle != null) 'forHandle': [forHandle],
    if (forUsername != null) 'forUsername': [forUsername],
    if (hl != null) 'hl': [hl],
    if (id != null) 'id': id,
    if (managedByMe != null) 'managedByMe': ['${managedByMe}'],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (mine != null) 'mine': ['${mine}'],
    if (mySubscribers != null) 'mySubscribers': ['${mySubscribers}'],
    if (onBehalfOfContentOwner != null)
      'onBehalfOfContentOwner': [onBehalfOfContentOwner],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'youtube/v3/channels';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ChannelListResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}