DeleteSharedEntityAssociations Service Operation - Campaign Management
Deletes the negative keyword list to campaign associations, or website exclusion list to ad account associations.
Tip
For an overview, see the Negative Keywords and Negative Sites technical guides.
Important
Only the users of the manager account (customer) that owns a website exclusion list (PlacementExclusionList) can update or delete the list, add or delete list items, and associate the list with ad accounts. If your ad account is associated with a website exclusion list that you do not own, you can disassociate the list from your account, but the list and list items are read-only. The owner of the list is determined by the association's SharedEntityCustomerId element.
If you have access to multiple manager accounts in an account hierarchy, the operation's results can vary depending on the CustomerId request header element that you set.
Request Elements
The DeleteSharedEntityAssociationsRequest 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 |
|---|---|---|
| Associations | The list of negative keyword list to campaign associations, or website exclusion list to ad account associations. This array can contain a maximum of 10,000 elements. |
SharedEntityAssociation array |
| SharedEntityScope | Indicates whether the shared entity is available at the ad account (Account) or manager account (Customer) level. This element is optional and defaults to Account scope. The ad account scope is only applicable for negative keyword list to campaign associations. Set this element to Customer to delete website exclusion list to ad account associations in your manager account (customer) shared library. |
EntityScope |
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 DeleteSharedEntityAssociationsResponse 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 associations that were not successfully deleted. The list of errors corresponds directly to the list of associations in the request. Items of the list may be returned as null. For each list index where an association was successfully deleted, the corresponding error element will be null. Ideally all associations are deleted successfully and all elements in this list are null. |
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">DeleteSharedEntityAssociations</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>
<DeleteSharedEntityAssociationsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Associations i:nil="false">
<SharedEntityAssociation>
<EntityId>ValueHere</EntityId>
<EntityType i:nil="false">ValueHere</EntityType>
<SharedEntityCustomerId i:nil="false">ValueHere</SharedEntityCustomerId>
<SharedEntityId>ValueHere</SharedEntityId>
<SharedEntityType i:nil="false">ValueHere</SharedEntityType>
</SharedEntityAssociation>
</Associations>
<SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
</DeleteSharedEntityAssociationsRequest>
</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>
<DeleteSharedEntityAssociationsResponse 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:e98="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e98:KeyValuePairOfstringstring>
<e98:key d4p1:nil="false">ValueHere</e98:key>
<e98:value d4p1:nil="false">ValueHere</e98:value>
</e98: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>
</DeleteSharedEntityAssociationsResponse>
</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<DeleteSharedEntityAssociationsResponse> DeleteSharedEntityAssociationsAsync(
IList<SharedEntityAssociation> associations,
EntityScope? sharedEntityScope)
{
var request = new DeleteSharedEntityAssociationsRequest
{
Associations = associations,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.DeleteSharedEntityAssociationsAsync(r), request));
}
static DeleteSharedEntityAssociationsResponse deleteSharedEntityAssociations(
ArrayOfSharedEntityAssociation associations,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
DeleteSharedEntityAssociationsRequest request = new DeleteSharedEntityAssociationsRequest();
request.setAssociations(associations);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().deleteSharedEntityAssociations(request);
}
static function DeleteSharedEntityAssociations(
$associations,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new DeleteSharedEntityAssociationsRequest();
$request->Associations = $associations;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->DeleteSharedEntityAssociations($request);
}
response=campaignmanagement_service.DeleteSharedEntityAssociations(
Associations=Associations,
SharedEntityScope=SharedEntityScope)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for