GetNegativeSitesByAdGroupIds Service Operation - Campaign Management
Gets the negative sites URLs that are assigned directly to ad groups.
The operation does not return negative sites of a shared website exclusion list. See GetListItemsBySharedList for more information.
Tip
For an overview, see the Negative Sites technical guide.
Request Elements
The GetNegativeSitesByAdGroupIdsRequest 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
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 GetNegativeSitesByAdGroupIdsResponse 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 |
|---|---|---|
| AdGroupNegativeSites | An array of AdGroupNegativeSites that corresponds directly to the ad group identifiers that you specified in the request. Items of the list may be returned as null. For each list index where an AdGroupNegativeSites was not retrieved, the corresponding element will be null. | AdGroupNegativeSites array |
| 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">GetNegativeSitesByAdGroupIds</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>
<GetNegativeSitesByAdGroupIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignId>ValueHere</CampaignId>
<AdGroupIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AdGroupIds>
</GetNegativeSitesByAdGroupIdsRequest>
</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>
<GetNegativeSitesByAdGroupIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupNegativeSites d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AdGroupNegativeSites>
<AdGroupId>ValueHere</AdGroupId>
<NegativeSites d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</NegativeSites>
</AdGroupNegativeSites>
</AdGroupNegativeSites>
<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:e162="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e162:KeyValuePairOfstringstring>
<e162:key d4p1:nil="false">ValueHere</e162:key>
<e162:value d4p1:nil="false">ValueHere</e162:value>
</e162: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>
</GetNegativeSitesByAdGroupIdsResponse>
</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<GetNegativeSitesByAdGroupIdsResponse> GetNegativeSitesByAdGroupIdsAsync(
long campaignId,
IList<long> adGroupIds)
{
var request = new GetNegativeSitesByAdGroupIdsRequest
{
CampaignId = campaignId,
AdGroupIds = adGroupIds
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetNegativeSitesByAdGroupIdsAsync(r), request));
}
static GetNegativeSitesByAdGroupIdsResponse getNegativeSitesByAdGroupIds(
java.lang.Long campaignId,
ArrayOflong adGroupIds) throws RemoteException, Exception
{
GetNegativeSitesByAdGroupIdsRequest request = new GetNegativeSitesByAdGroupIdsRequest();
request.setCampaignId(campaignId);
request.setAdGroupIds(adGroupIds);
return CampaignManagementService.getService().getNegativeSitesByAdGroupIds(request);
}
static function GetNegativeSitesByAdGroupIds(
$campaignId,
$adGroupIds)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetNegativeSitesByAdGroupIdsRequest();
$request->CampaignId = $campaignId;
$request->AdGroupIds = $adGroupIds;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetNegativeSitesByAdGroupIds($request);
}
response=campaignmanagement_service.GetNegativeSitesByAdGroupIds(
CampaignId=CampaignId,
AdGroupIds=AdGroupIds)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13