DeleteAdGroupCriterions Service Operation - Campaign Management
Deletes the specified ad group criterions.
Request Elements
The DeleteAdGroupCriterionsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AdGroupCriterionIds | A list of unique identifiers that identify the criterions to delete. You can include up to 1,000 ad group criterion identifiers per request. |
long array |
| AdGroupId | The identifier of the ad group that has the criterions you want to delete. | long |
| CriterionType | The type of criterion to delete, for example Webpage. You can specify only one criterion type value per call. To add, delete, or update target criterions i.e., age, company name, day and time, device, gender, industry, job function, location, location intent, and radius criterions, you must specify the CriterionType value as Targets. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these target criterions via GetAdGroupCriterionsByIds you must request the specific type individually i.e., Age, CompanyName, DayTime, Device, Gender, Industry, JobFunction, Location, LocationIntent, and Radius. To add, delete, or update audience criterions i.e., custom audiences, in-market audiences, and remarketing lists, you must specify the CriterionType value as Audience. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these audience criterions via GetAdGroupCriterionsByIds you must request the specific type individually i.e., CustomAudience, InMarketAudience, ProductAudience, and RemarketingList. You cannot delete a ProductPartition with this operation. Instead, you should use ApplyProductPartitionActions. |
AdGroupCriterionType |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The DeleteAdGroupCriterionsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| PartialErrors | An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. |
BatchError array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Action mustUnderstand="1">DeleteAdGroupCriterions</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<DeleteAdGroupCriterionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupCriterionIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AdGroupCriterionIds>
<AdGroupId>ValueHere</AdGroupId>
<CriterionType>ValueHere</CriterionType>
</DeleteAdGroupCriterionsRequest>
</s:Body>
</s:Envelope>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<DeleteAdGroupCriterionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<FieldPath d4p1:nil="false">ValueHere</FieldPath>
<ForwardCompatibilityMap xmlns:e153="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e153:KeyValuePairOfstringstring>
<e153:key d4p1:nil="false">ValueHere</e153:key>
<e153:value d4p1:nil="false">ValueHere</e153:value>
</e153:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Index>ValueHere</Index>
<Message d4p1:nil="false">ValueHere</Message>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to EditorialError-->
<Appealable d4p1:nil="false">ValueHere</Appealable>
<DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
<ReasonCode>ValueHere</ReasonCode>
</BatchError>
</PartialErrors>
</DeleteAdGroupCriterionsResponse>
</s:Body>
</s:Envelope>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<DeleteAdGroupCriterionsResponse> DeleteAdGroupCriterionsAsync(
IList<long> adGroupCriterionIds,
long adGroupId,
AdGroupCriterionType criterionType)
{
var request = new DeleteAdGroupCriterionsRequest
{
AdGroupCriterionIds = adGroupCriterionIds,
AdGroupId = adGroupId,
CriterionType = criterionType
};
return (await CampaignManagementService.CallAsync((s, r) => s.DeleteAdGroupCriterionsAsync(r), request));
}
static DeleteAdGroupCriterionsResponse deleteAdGroupCriterions(
ArrayOflong adGroupCriterionIds,
java.lang.Long adGroupId,
ArrayList<AdGroupCriterionType> criterionType) throws RemoteException, Exception
{
DeleteAdGroupCriterionsRequest request = new DeleteAdGroupCriterionsRequest();
request.setAdGroupCriterionIds(adGroupCriterionIds);
request.setAdGroupId(adGroupId);
request.setCriterionType(criterionType);
return CampaignManagementService.getService().deleteAdGroupCriterions(request);
}
static function DeleteAdGroupCriterions(
$adGroupCriterionIds,
$adGroupId,
$criterionType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new DeleteAdGroupCriterionsRequest();
$request->AdGroupCriterionIds = $adGroupCriterionIds;
$request->AdGroupId = $adGroupId;
$request->CriterionType = $criterionType;
return $GLOBALS['CampaignManagementProxy']->GetService()->DeleteAdGroupCriterions($request);
}
response=campaignmanagement_service.DeleteAdGroupCriterions(
AdGroupCriterionIds=AdGroupCriterionIds,
AdGroupId=AdGroupId,
CriterionType=CriterionType)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Request Url
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AdGroupCriterions
Request Elements
The DeleteAdGroupCriterionsRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AdGroupCriterionIds | A list of unique identifiers that identify the criterions to delete. You can include up to 1,000 ad group criterion identifiers per request. |
long array |
| AdGroupId | The identifier of the ad group that has the criterions you want to delete. | long |
| CriterionType | The type of criterion to delete, for example Webpage. You can specify only one criterion type value per call. To add, delete, or update target criterions i.e., age, company name, day and time, device, gender, industry, job function, location, location intent, and radius criterions, you must specify the CriterionType value as Targets. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these target criterions via GetAdGroupCriterionsByIds you must request the specific type individually i.e., Age, CompanyName, DayTime, Device, Gender, Industry, JobFunction, Location, LocationIntent, and Radius. To add, delete, or update audience criterions i.e., custom audiences, in-market audiences, and remarketing lists, you must specify the CriterionType value as Audience. You can add, delete, and update multiple target criterion types in the same operation. To retrieve these audience criterions via GetAdGroupCriterionsByIds you must request the specific type individually i.e., CustomAudience, InMarketAudience, ProductAudience, and RemarketingList. You cannot delete a ProductPartition with this operation. Instead, you should use ApplyProductPartitionActions. |
AdGroupCriterionType |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The DeleteAdGroupCriterionsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| PartialErrors | An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. |
BatchError array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"AdGroupCriterionIds": [
"LongValueHere"
],
"AdGroupId": "LongValueHere",
"CriterionType": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
Below is an example that is applicable if the type of BatchError is EditorialError.
{
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"FieldPath": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Index": IntValueHere,
"Message": "ValueHere",
"Type": "EditorialError",
"Appealable": "ValueHere",
"DisapprovedText": "ValueHere",
"Location": "ValueHere",
"PublisherCountry": "ValueHere",
"ReasonCode": IntValueHere
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<DeleteAdGroupCriterionsResponse> DeleteAdGroupCriterionsAsync(
IList<long> adGroupCriterionIds,
long adGroupId,
AdGroupCriterionType criterionType)
{
var request = new DeleteAdGroupCriterionsRequest
{
AdGroupCriterionIds = adGroupCriterionIds,
AdGroupId = adGroupId,
CriterionType = criterionType
};
return (await CampaignManagementService.CallAsync((s, r) => s.DeleteAdGroupCriterionsAsync(r), request));
}
static DeleteAdGroupCriterionsResponse deleteAdGroupCriterions(
ArrayOflong adGroupCriterionIds,
java.lang.Long adGroupId,
ArrayList<AdGroupCriterionType> criterionType) throws RemoteException, Exception
{
DeleteAdGroupCriterionsRequest request = new DeleteAdGroupCriterionsRequest();
request.setAdGroupCriterionIds(adGroupCriterionIds);
request.setAdGroupId(adGroupId);
request.setCriterionType(criterionType);
return CampaignManagementService.getService().deleteAdGroupCriterions(request);
}
static function DeleteAdGroupCriterions(
$adGroupCriterionIds,
$adGroupId,
$criterionType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new DeleteAdGroupCriterionsRequest();
$request->AdGroupCriterionIds = $adGroupCriterionIds;
$request->AdGroupId = $adGroupId;
$request->CriterionType = $criterionType;
return $GLOBALS['CampaignManagementProxy']->GetService()->DeleteAdGroupCriterions($request);
}
response=campaignmanagement_service.DeleteAdGroupCriterions(
AdGroupCriterionIds=AdGroupCriterionIds,
AdGroupId=AdGroupId,
CriterionType=CriterionType)