patch method

Future<Channel> patch(Channel request, String advertiserId, String channelId, { String? partnerId, String? updateMask, String? $fields, })

Updates a channel.

Returns the updated channel if successful.

request - The metadata request object.

Request parameters:

advertiserId - The ID of the advertiser that owns the created channel. Value must have pattern ^\[^/\]+$.

channelId - Output only. The unique ID of the channel. Assigned by the system.

partnerId - The ID of the partner that owns the created channel.

updateMask - Required. The mask to control which fields to update.

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

Completes with a Channel.

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<Channel> patch(
  Channel request,
  core.String advertiserId,
  core.String channelId, {
  core.String? partnerId,
  core.String? updateMask,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (partnerId != null) 'partnerId': [partnerId],
    if (updateMask != null) 'updateMask': [updateMask],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v3/advertisers/' +
      core.Uri.encodeFull('$advertiserId') +
      '/channels/' +
      commons.escapeVariable('$channelId');

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