title | ms.service | ms.subservice | ms.topic | author | ms.author | description | dev_langs | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
SetSharedEntityAssociations Service Operation - Campaign Management |
bing-ads |
campaign-management-api |
article |
jonmeyers |
jonmeyers |
Sets the negative keyword list to campaign associations, or website exclusion list to ad account associations. |
|
Sets 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.
The SetSharedEntityAssociationsRequest 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.
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 set website exclusion list to ad account associations in your manager account (customer) shared library. |
EntityScope |
[!INCLUDErequest-header]
The SetSharedEntityAssociationsResponse 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.
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 |
[!INCLUDEresponse-header]
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">SetSharedEntityAssociations</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>
<SetSharedEntityAssociationsRequest 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>
</SetSharedEntityAssociationsRequest>
</s:Body>
</s:Envelope>
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>
<SetSharedEntityAssociationsResponse 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:e177="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e177:KeyValuePairOfstringstring>
<e177:key d4p1:nil="false">ValueHere</e177:key>
<e177:value d4p1:nil="false">ValueHere</e177:value>
</e177: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>
</SetSharedEntityAssociationsResponse>
</s:Body>
</s:Envelope>
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<SetSharedEntityAssociationsResponse> SetSharedEntityAssociationsAsync(
IList<SharedEntityAssociation> associations,
EntityScope? sharedEntityScope)
{
var request = new SetSharedEntityAssociationsRequest
{
Associations = associations,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.SetSharedEntityAssociationsAsync(r), request));
}
static SetSharedEntityAssociationsResponse setSharedEntityAssociations(
ArrayOfSharedEntityAssociation associations,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
SetSharedEntityAssociationsRequest request = new SetSharedEntityAssociationsRequest();
request.setAssociations(associations);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().setSharedEntityAssociations(request);
}
static function SetSharedEntityAssociations(
$associations,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new SetSharedEntityAssociationsRequest();
$request->Associations = $associations;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->SetSharedEntityAssociations($request);
}
response=campaignmanagement_service.SetSharedEntityAssociations(
Associations=Associations,
SharedEntityScope=SharedEntityScope)
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13