list method

Future<PlaylistItemListResponse> list(List<String> part, { List<String>? id, int? maxResults, String? onBehalfOfContentOwner, String? pageToken, String? playlistId, String? videoId, String? $fields, })

Retrieves a list of resources, possibly filtered.

Request parameters:

part - The part parameter specifies a comma-separated list of one or more playlistItem 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 playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part=snippet, the API response will contain all of those properties.

id - null

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

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.

playlistId - Return the playlist items within the given playlist.

videoId - Return the playlist items associated with the given video ID.

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

Completes with a PlaylistItemListResponse.

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<PlaylistItemListResponse> list(
  core.List<core.String> part, {
  core.List<core.String>? id,
  core.int? maxResults,
  core.String? onBehalfOfContentOwner,
  core.String? pageToken,
  core.String? playlistId,
  core.String? videoId,
  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 (id != null) 'id': id,
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (onBehalfOfContentOwner != null)
      'onBehalfOfContentOwner': [onBehalfOfContentOwner],
    if (pageToken != null) 'pageToken': [pageToken],
    if (playlistId != null) 'playlistId': [playlistId],
    if (videoId != null) 'videoId': [videoId],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'youtube/v3/playlistItems';

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