Export (0) Print
Expand All
Expand Minimize

GetNegativeKeywordsByEntityIds Service Operation

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

System_CLiX_note Note

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

Request | Response

Error Codes

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

GetNegativeKeywordsByEntityIdsRequest Message

Request Body

The GetNegativeKeywordsByEntityIdsRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

Element

Description

Data Type

EntityIds

An array of entity identifiers to return the associated negative keywords.

System_CLiX_note Note

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 25 elements.

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

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

CustomerAccountId

The identifier of the account that owns the entities in the request.

string

CustomerId

The identifier of the customer that owns the account.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.

<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/v9">
    <Action mustUnderstand="1">GetNegativeKeywordsByEntityIds</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <CustomerAccountId i:nil="false"></CustomerAccountId>
    <CustomerId i:nil="false"></CustomerId>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <GetNegativeKeywordsByEntityIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </EntityIds>
      <EntityType i:nil="false"></EntityType>
      <ParentEntityId i:nil="false"></ParentEntityId>
    </GetNegativeKeywordsByEntityIdsRequest>
  </s:Body>
</s:Envelope>

GetNegativeKeywordsByEntityIdsResponse Message

Response Body

Element

Description

Data Type

EntityNegativeKeywords

An array of negative keyword with associated entity such as a campaign or ad group.

EntityNegativeKeyword array

PartialErrors

An array of BatchError objects that contain details for any negative keywords that were not successfully returned from the corresponding entity.

BatchError array

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains details about the API call.

string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetNegativeKeywordsByEntityIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <EntityNegativeKeywords p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <EntityNegativeKeyword>
          <EntityId></EntityId>
          <EntityType p4:nil="false"></EntityType>
          <NegativeKeywords p4:nil="false">
            <NegativeKeyword>
              <Id p4:nil="false"></Id>
              <MatchType></MatchType>
              <Text p4:nil="false"></Text>
            </NegativeKeyword>
          </NegativeKeywords>
        </EntityNegativeKeyword>
      </EntityNegativeKeywords>
      <PartialErrors p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError p4:type="-- specify derived type here with the appropriate prefix --">
          <Code></Code>
          <Details p4:nil="false"></Details>
          <ErrorCode p4:nil="false"></ErrorCode>
          <Index></Index>
          <Message p4:nil="false"></Message>
          <Type p4:nil="false"></Type>
          <!--Keep these fields if you set the i:type attribute to EditorialError-->
          <Appealable p4:nil="false"></Appealable>
          <DisapprovedText p4:nil="false"></DisapprovedText>
          <Location p4:nil="false"></Location>
          <PublisherCountry p4:nil="false"></PublisherCountry>
          <ReasonCode></ReasonCode>
        </BatchError>
      </PartialErrors>
    </GetNegativeKeywordsByEntityIdsResponse>
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Campaign Management Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code

InvalidCredentials

Community Additions

ADD
Show:
© 2015 Microsoft