Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

SetNegativeKeywordsToAdGroups Service Operation

Sets the negative keywords of the specified ad groups.

System_CLiX_note Note

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

Request | Response

Error Codes

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

SetNegativeKeywordsToAdGroupsRequest Message

Request Body

The SetNegativeKeywordsToAdGroupsRequest 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

AdGroupNegativeKeywords

An array of AdGroupNegativeKeywords objects that identify the ad groups to update with the specified negative keywords.

The array can contain a maximum of 25 objects. The maximum number of negative keywords that you can add in a single call is 250,000.

The maximum number of negative keywords that you can include in each AdGroupNegativeKeywords object is 20,000; however, not all of the 25 AdGroupNegativeKeywords objects can contain the maximum 20,000 negative keywords because you would exceed the 250,000 limit per call. You could submit 12 AdGroupNegativeKeywords objects with 20,000 negative keywords and 1 AdGroupNegativeKeywords with 10,000 negative keywords. Alternatively you could submit 25 AdGroupNegativeKeywords each with up to 10,000 negative keywords.

AdGroupNegativeKeywords array

CampaignId

The identifier of the campaign that contains the ad groups.

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">SetNegativeKeywordsToAdGroups</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>
    <SetNegativeKeywordsToAdGroupsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <CampaignId></CampaignId>
      <AdGroupNegativeKeywords i:nil="false">
        <AdGroupNegativeKeywords>
          <AdGroupId></AdGroupId>
          <NegativeKeywords i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string></a1:string>
          </NegativeKeywords>
        </AdGroupNegativeKeywords>
      </AdGroupNegativeKeywords>
    </SetNegativeKeywordsToAdGroupsRequest>
  </s:Body>
</s:Envelope>

SetNegativeKeywordsToAdGroupsResponse Message

Response Body

The response does not contain additional body elements.

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>
    <SetNegativeKeywordsToAdGroupsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9" />
  </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