set method

Future<void> set(
  1. InvideoBranding request,
  2. String channelId, {
  3. String? onBehalfOfContentOwner,
  4. String? $fields,
  5. UploadOptions uploadOptions = commons.UploadOptions.defaultOptions,
  6. Media? uploadMedia,
})

Allows upload of watermark image and setting it for a channel.

request - The metadata request object.

Request parameters:

channelId - null

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.

uploadMedia - The media to upload.

uploadOptions - Options for the media upload. Streaming Media without the length being known ahead of time is only supported via resumable uploads.

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<void> set(
  InvideoBranding request,
  core.String channelId, {
  core.String? onBehalfOfContentOwner,
  core.String? $fields,
  commons.UploadOptions uploadOptions = commons.UploadOptions.defaultOptions,
  commons.Media? uploadMedia,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'channelId': [channelId],
    if (onBehalfOfContentOwner != null)
      'onBehalfOfContentOwner': [onBehalfOfContentOwner],
    if ($fields != null) 'fields': [$fields],
  };

  core.String url_;
  if (uploadMedia == null) {
    url_ = 'youtube/v3/watermarks/set';
  } else if (uploadOptions is commons.ResumableUploadOptions) {
    url_ = '/resumable/upload/youtube/v3/watermarks/set';
  } else {
    url_ = '/upload/youtube/v3/watermarks/set';
  }

  await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
    uploadMedia: uploadMedia,
    uploadOptions: uploadOptions,
    downloadOptions: null,
  );
}