list method
Retrieves a list of resources, possibly filtered.
Request parameters:
part
- The part parameter specifies a comma-separated list of one or
more channelSection resource properties that the API response will
include. The part names that you can include in the parameter value are
id, snippet, and contentDetails. If the parameter identifies a property
that contains child properties, the child properties will be included in
the response. For example, in a channelSection resource, the snippet
property contains other properties, such as a display title for the
channelSection. If you set part=snippet, the API response will also
contain all of those nested properties.
channelId
- Return the ChannelSections owned by the specified channel
ID.
hl
- Return content in specified language
id
- Return the ChannelSections with the given IDs for Stubby or Apiary.
mine
- Return the ChannelSections owned by 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.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ChannelSectionListResponse.
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<ChannelSectionListResponse> list(
core.List<core.String> part, {
core.String? channelId,
core.String? hl,
core.List<core.String>? id,
core.bool? mine,
core.String? onBehalfOfContentOwner,
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 (channelId != null) 'channelId': [channelId],
if (hl != null) 'hl': [hl],
if (id != null) 'id': id,
if (mine != null) 'mine': ['${mine}'],
if (onBehalfOfContentOwner != null)
'onBehalfOfContentOwner': [onBehalfOfContentOwner],
if ($fields != null) 'fields': [$fields],
};
const url_ = 'youtube/v3/channelSections';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ChannelSectionListResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}