DeleteTargetsFromLibrary REST Template
Deletes one or more target groups from the target library.
/customer/target?$field=ids
Query Parameters
- field
The ids value is a constant string that indicates that the DELETE method is deleting target groups. The body of the request includes the list of identifiers of the target groups that you want to delete.
Request Components
The following specifies the HTTP method, supported content types, and base URI to use in your request.
HTTP method: DELETE
Supported content types: XML and JSON
To use JSON, the following applies:
Your request URL must include the “format=json” query string.
The key names that you use for the JSON members are the same as the elements of the XML objects shown in the examples below.
Production base URI: https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementServiceREST.svc
Sandbox base URI: Not available.
If the web browser or firewall does not support the DELETE method, use the POST method and include an X-HTTP-Method-Override header. Set the X-HTTP-Method-Override header value to DELETE.
Request Headers
The following are the headers to include in your request.
Header | Description |
|---|---|
ApplicationToken | The application access token. This header is not used. |
CustomerAccountId | The account identifier. For more information, see Account and Customer Identifiers. |
CustomerId | The customer identifier. For more information, see Account and Customer Identifiers. |
DeveloperToken | The developer access token. |
Password | The user’s logon password. |
UserName | The user’s logon user name. |
Request Body
The following XML fragment shows the elements to use to delete target groups from the target library. For a description of each element and the header elements that your request must include, see DeleteTargetsFromLibraryRequest Message Object.
<DeleteTargetsFromLibraryRequest xmlns="http://schemas.datacontract.org/2004/07/HostedService.CampaignManagementService.Rest" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<TargetIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:long></d4p1:long>
</TargetIds>
</DeleteTargetsFromLibraryRequest>
Response Body
The response does not include a body. For a description of the TrackingId header element that the response includes, see DeleteTargtsFromLibraryResponse Message Object.
Faults
If an error occurs, the service returns one of the following HTTP error codes.
Code | Description |
|---|---|
400 | Bad request, which indicates that the request data contains an error. The response will contain either an ApiFaultDetail or AdApiFaultDetail object that identifies the error. For a list of possible error codes, see Campaign Management Error Codes and Common Error Codes. |
401 | Not authorized. |
404 | Not found. |
405 | Method not allowed, which indicates that the URI template is not correct. |
500 | Server error. |
