bulkEdit method
Future<BulkEditSitesResponse>
bulkEdit(
- BulkEditSitesRequest request,
- String advertiserId,
- String channelId, {
- String? $fields,
Bulk edits sites under a single channel.
The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
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 to which the sites
belong.
Value must have pattern ^\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a BulkEditSitesResponse.
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<BulkEditSitesResponse> bulkEdit(
BulkEditSitesRequest 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:bulkEdit';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return BulkEditSitesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}