update method
- PlaylistItem request,
- List<
String> part, { - String? onBehalfOfContentOwner,
- String? $fields,
Updates an existing resource.
request
- The metadata request object.
Request parameters:
part
- The part parameter serves two purposes in this operation. It
identifies the properties that the write operation will set as well as the
properties that the API response will include. Note that this method will
override the existing values for all of the mutable properties that are
contained in any parts that the parameter value specifies. For example, a
playlist item can specify a start time and end time, which identify the
times portion of the video that should play when users watch the video in
the playlist. If your request is updating a playlist item that sets these
values, and the request's part parameter value includes the contentDetails
part, the playlist item's start and end times will be updated to whatever
value the request body specifies. If the request body does not specify
values, the existing start and end times will be removed and replaced with
the default settings.
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 PlaylistItem.
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<PlaylistItem> update(
PlaylistItem request,
core.List<core.String> part, {
core.String? onBehalfOfContentOwner,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
if (part.isEmpty) {
throw core.ArgumentError('Parameter part cannot be empty.');
}
final queryParams_ = <core.String, core.List<core.String>>{
'part': part,
if (onBehalfOfContentOwner != null)
'onBehalfOfContentOwner': [onBehalfOfContentOwner],
if ($fields != null) 'fields': [$fields],
};
const url_ = 'youtube/v3/playlistItems';
final response_ = await _requester.request(
url_,
'PUT',
body: body_,
queryParams: queryParams_,
);
return PlaylistItem.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}