delete method
Deletes a creative.
Returns error code NOT_FOUND
if the creative does not exist. The
creative should be archived first, i.e. set entity_status to
ENTITY_STATUS_ARCHIVED
, before it can be deleted. A ["Standard" user
role](//support.google.com/displayvideo/answer/2723011) or greater for
the parent advertiser or partner is required to make this request.
Request parameters:
advertiserId
- The ID of the advertiser this creative belongs to.
Value must have pattern ^\[^/\]+$
.
creativeId
- The ID of the creative to be deleted.
Value must have pattern ^\[^/\]+$
.
$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 advertiserId,
core.String creativeId, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/advertisers/' +
core.Uri.encodeFull('$advertiserId') +
'/creatives/' +
core.Uri.encodeFull('$creativeId');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}