GetNegativeKeywordsByEntityIds Service Operation - Campaign Management

Gets the negative keywords that are only associated with the specified campaigns or ad groups.

Note

The operation does not return negative keywords of a shared list.

Request Elements

The GetNegativeKeywordsByEntityIdsRequest 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
EntityIds An array of entity identifiers to return the associated negative keywords.

The specified entities must all exist within the same parent entity, for example the ad group identifiers must all exist within the same campaign.

This array can contain a maximum of 1 element.
long array
EntityType The type of entity corresponding to the specified EntityIds element.

Possible values include AdGroup and Campaign.
string
ParentEntityId The identifier of the parent entity corresponding to the specified EntityIds element.

If the entity type is AdGroup, this element should be set to the campaign identifier that contains all of the specified ad groups.

If the entity type is Campaign, the service uses the CustomerAccountId header element and this element is ignored.
long

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 GetNegativeKeywordsByEntityIdsResponse 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
EntityNegativeKeywords An array of EntityNegativeKeyword objects that corresponds directly to the entity identifiers that you specified in the request. Items of the list may be returned as null. For each list index where negative keywords for an entity were not retrieved, the corresponding element will be null. EntityNegativeKeyword 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/v12">
    <Action mustUnderstand="1">GetNegativeKeywordsByEntityIds</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>
    <GetNegativeKeywordsByEntityIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v12">
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </EntityIds>
      <EntityType i:nil="false">ValueHere</EntityType>
      <ParentEntityId i:nil="false">ValueHere</ParentEntityId>
    </GetNegativeKeywordsByEntityIdsRequest>
  </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>
    <GetNegativeKeywordsByEntityIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v12">
      <EntityNegativeKeywords d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <EntityNegativeKeyword>
          <EntityId>ValueHere</EntityId>
          <EntityType d4p1:nil="false">ValueHere</EntityType>
          <NegativeKeywords d4p1:nil="false">
            <NegativeKeyword>
              <Id d4p1:nil="false">ValueHere</Id>
              <MatchType>ValueHere</MatchType>
              <Text d4p1:nil="false">ValueHere</Text>
            </NegativeKeyword>
          </NegativeKeywords>
        </EntityNegativeKeyword>
      </EntityNegativeKeywords>
      <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:e359="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e359:KeyValuePairOfstringstring>
              <e359:key d4p1:nil="false">ValueHere</e359:key>
              <e359:value d4p1:nil="false">ValueHere</e359:value>
            </e359: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>
    </GetNegativeKeywordsByEntityIdsResponse>
  </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<GetNegativeKeywordsByEntityIdsResponse> GetNegativeKeywordsByEntityIdsAsync(
	IList<long> entityIds,
	string entityType,
	long? parentEntityId)
{
	var request = new GetNegativeKeywordsByEntityIdsRequest
	{
		EntityIds = entityIds,
		EntityType = entityType,
		ParentEntityId = parentEntityId
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetNegativeKeywordsByEntityIdsAsync(r), request));
}
static GetNegativeKeywordsByEntityIdsResponse getNegativeKeywordsByEntityIds(
	ArrayOflong entityIds,
	java.lang.String entityType,
	java.lang.Long parentEntityId) throws RemoteException, Exception
{
	GetNegativeKeywordsByEntityIdsRequest request = new GetNegativeKeywordsByEntityIdsRequest();

	request.setEntityIds(entityIds);
	request.setEntityType(entityType);
	request.setParentEntityId(parentEntityId);

	return CampaignManagementService.getService().getNegativeKeywordsByEntityIds(request);
}
static function GetNegativeKeywordsByEntityIds(
	$entityIds,
	$entityType,
	$parentEntityId)
{

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

	$request = new GetNegativeKeywordsByEntityIdsRequest();

	$request->EntityIds = $entityIds;
	$request->EntityType = $entityType;
	$request->ParentEntityId = $parentEntityId;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetNegativeKeywordsByEntityIds($request);
}
response=campaignmanagement_service.GetNegativeKeywordsByEntityIds(
	EntityIds=EntityIds,
	EntityType=EntityType,
	ParentEntityId=ParentEntityId)

Requirements

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