DeleteCampaignCriterions Service Operation - Campaign Management

Deletes one or more campaign criterions.

Request Elements

The DeleteCampaignCriterionsRequest 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
CampaignCriterionIds A list of unique system identifiers corresponding to the campaign criterions that you want to delete.

You can include up to 100 campaign criterion identifiers per request.
long array
CampaignId The identifier of the campaign that owns the criterions 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, day and time, device, gender, 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 GetCampaignCriterionsByIds you must request the specific type individually i.e., Age, DayTime, Device, Gender, Location, LocationIntent, and Radius.
CampaignCriterionType

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents a Microsoft Account user who has permissions to Microsoft Advertising accounts. string
CustomerAccountId The identifier of the account that owns 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. string
CustomerId The identifier of the customer that contains and owns the account. If you manage an account of another customer, you should use that customer ID instead of your own customer ID. This element is required for most service operations, and as a best practice you should always set it. string
DeveloperToken The developer token used to access the Bing Ads API. 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 DeleteCampaignCriterionsResponse 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
IsMigrated Indicates whether or not the campaign where you deleted target criterions previously shared target criterions with another campaign or ad group. In that case this operation migrates the shared target associations and assigns new campaign criterion IDs.

If this value is true and if you already have criterion IDs for targets such as age, day and time, device, gender, and location, then you should replace those IDs with all of the new IDs returned by the GetCampaignCriterionsByIds operation (specify TargetCriterions as the CriterionType). You only need to sync target criterion IDs, and this is not applicable for other criterion types such as webpage criterions.
boolean
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/v12">
    <Action mustUnderstand="1">DeleteCampaignCriterions</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>
    <DeleteCampaignCriterionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v12">
      <CampaignCriterionIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </CampaignCriterionIds>
      <CampaignId>ValueHere</CampaignId>
      <CriterionType>ValueHere</CriterionType>
    </DeleteCampaignCriterionsRequest>
  </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/v12">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <DeleteCampaignCriterionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v12">
      <IsMigrated>ValueHere</IsMigrated>
      <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:e310="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e310:KeyValuePairOfstringstring>
              <e310:key d4p1:nil="false">ValueHere</e310:key>
              <e310:value d4p1:nil="false">ValueHere</e310:value>
            </e310: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>
    </DeleteCampaignCriterionsResponse>
  </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<DeleteCampaignCriterionsResponse> DeleteCampaignCriterionsAsync(
	IList<long> campaignCriterionIds,
	long campaignId,
	CampaignCriterionType criterionType)
{
	var request = new DeleteCampaignCriterionsRequest
	{
		CampaignCriterionIds = campaignCriterionIds,
		CampaignId = campaignId,
		CriterionType = criterionType
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.DeleteCampaignCriterionsAsync(r), request));
}
static DeleteCampaignCriterionsResponse deleteCampaignCriterions(
	ArrayOflong campaignCriterionIds,
	java.lang.Long campaignId,
	ArrayList<CampaignCriterionType> criterionType) throws RemoteException, Exception
{
	DeleteCampaignCriterionsRequest request = new DeleteCampaignCriterionsRequest();

	request.setCampaignCriterionIds(campaignCriterionIds);
	request.setCampaignId(campaignId);
	request.setCriterionType(criterionType);

	return CampaignManagementService.getService().deleteCampaignCriterions(request);
}
static function DeleteCampaignCriterions(
	$campaignCriterionIds,
	$campaignId,
	$criterionType)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new DeleteCampaignCriterionsRequest();

	$request->CampaignCriterionIds = $campaignCriterionIds;
	$request->CampaignId = $campaignId;
	$request->CriterionType = $criterionType;

	return $GLOBALS['CampaignManagementProxy']->GetService()->DeleteCampaignCriterions($request);
}
response=campaignmanagement_service.DeleteCampaignCriterions(
	CampaignCriterionIds=CampaignCriterionIds,
	CampaignId=CampaignId,
	CriterionType=CriterionType)

Requirements

Service: CampaignManagementService.svc v12
Namespace: https://bingads.microsoft.com/CampaignManagement/v12