delete method

Future<Empty> delete(String partnerId, String channelId, String urlOrAppId, { String? advertiserId, String? $fields, })

Deletes a site from a channel.

Request parameters:

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

channelId - Required. The ID of the parent channel to which the site belongs. Value must have pattern ^\[^/\]+$.

urlOrAppId - Required. The URL or app ID of the site to delete. Value must have pattern ^\[^/\]+$.

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

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

Completes with a Empty.

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<Empty> delete(
  core.String partnerId,
  core.String channelId,
  core.String urlOrAppId, {
  core.String? advertiserId,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (advertiserId != null) 'advertiserId': [advertiserId],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v3/partners/' +
      commons.escapeVariable('$partnerId') +
      '/channels/' +
      core.Uri.encodeFull('$channelId') +
      '/sites/' +
      core.Uri.encodeFull('$urlOrAppId');

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