replace method

Future<ReplaceSitesResponse> replace(ReplaceSitesRequest request, String advertiserId, String channelId, { String? $fields, })

Replaces all of the sites under a single channel.

The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. This method regularly experiences high latency. We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

request - The metadata request object.

Request parameters:

advertiserId - The ID of the advertiser that owns the parent channel.

channelId - Required. The ID of the parent channel whose sites will be replaced. Value must have pattern ^\[^/\]+$.

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

Completes with a ReplaceSitesResponse.

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

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

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