Export (0) Print
Expand All
Expand Minimize

AddKeywords Service Operation

Adds one or more keywords to an ad group.

Request | Response

Error Codes

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

AddKeywordsRequest Message

Request Body

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

AdGroupId

The identifier of the ad group to add the keywords to.

long

Keywords

An array of Keyword objects to add to the specified ad group.

You can add a maximum of 1,000 keywords to an ad group in a single call. For a list of keyword limits per ad group and account, see Entity Hierarchy and Limits.

Keyword array

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">AddKeywords</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>
    <AddKeywordsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <AdGroupId></AdGroupId>
      <Keywords i:nil="false">
        <Keyword>
          <Bid i:nil="false">
            <Amount i:nil="false"></Amount>
          </Bid>
          <DestinationUrl i:nil="false"></DestinationUrl>
          <EditorialStatus i:nil="false"></EditorialStatus>
          <ForwardCompatibilityMap xmlns:e5="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e5:KeyValuePairOfstringstring>
              <e5:key i:nil="false"></e5:key>
              <e5:value i:nil="false"></e5:value>
            </e5:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id i:nil="false"></Id>
          <MatchType i:nil="false"></MatchType>
          <Param1 i:nil="false"></Param1>
          <Param2 i:nil="false"></Param2>
          <Param3 i:nil="false"></Param3>
          <Status i:nil="false"></Status>
          <Text i:nil="false"></Text>
        </Keyword>
      </Keywords>
    </AddKeywordsRequest>
  </s:Body>
</s:Envelope>

AddKeywordsResponse Message

Response Body

Element

Description

Data Type

KeywordIds

An list of long values that represents the keyword identifiers for the keywords that were added.

System_CLiX_note Note

Items of the list may be returned as null. For each list index where a keyword was not added, the corresponding element will be null.

long array

PartialErrors

An array of BatchError objects that contain details for any keywords that were not successfully added.

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>
    <AddKeywordsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <KeywordIds p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long></a1:long>
      </KeywordIds>
      <PartialErrors p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError p4:type="-- derived type will be specified 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>
          <!--These fields may be set if the i:type attribute is 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>
    </AddKeywordsResponse>
  </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:
© 2014 Microsoft