GetKeywordsByIds Service Operation

 

Retrieves the specified keywords.

Request | Response

Error Codes

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

Request Body

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

ElementDescriptionData TypeRequired
AdGroupIdThe identifier of the ad group whose keywords you want to get.longRequired
KeywordIdsA maximum of 1,000 identifiers of the keywords to get.long arrayRequired
ReturnAdditionalFieldsThe list of additional elements that you want included within each returned Keyword object. This set of flags enables you to get the latest features using the current version of Bing Ads Campaign Management API, and in the next version the corresponding elements will be included by default.KeywordAdditionalFieldOptional

Request Headers

Set the required header elements for each service request. New customers are required to sign up for Bing Ads with a Microsoft Account, and to manage those accounts you must use OAuth. Existing users with legacy Bing Ads credentials may continue to specify the UserName and Password header elements. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account authentication. For more information, see Getting Started With the Bing Ads API.

OAuth Authentication

These request headers are required for Managing User Authentication with OAuth.

ElementDescriptionData Type
AuthenticationTokenThe OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account.string
CustomerAccountIdThe 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.

Note: Required for service operations related to ad extensions. As a best practice you should always specify this element for operations limited in scope to a single account per service call.
string
CustomerIdThe 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.

Note: Required for service operations related to targeting and editorial. As a best practice you should always specify this element.
string
DeveloperTokenThe client application's developer access token.string

Password Authentication

These request headers are required for legacy username and password authentication.

ElementDescriptionData Type
CustomerAccountIdThe 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.

Note: Required for service operations related to ad extensions. As a best practice you should always specify this element for operations limited in scope to a single account per service call.
string
CustomerIdThe 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.

Note: Required for service operations related to targeting and editorial. As a best practice you should always specify this element.
string
DeveloperTokenThe client application's developer access token.string
PasswordThe Bing Ads user's sign-in password.string
UserNameThe Bing Ads user's sign-in user name. You may not set this element to a Microsoft account or email address.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/v10">
    <Action mustUnderstand="1">GetKeywordsByIds</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>
    <GetKeywordsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <AdGroupId></AdGroupId>
      <KeywordIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </KeywordIds>
      <ReturnAdditionalFields i:nil="false"></ReturnAdditionalFields>
    </GetKeywordsByIdsRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
KeywordsAn array of Keyword objects that corresponds directly to the keyword identifiers that you specified in the request. Items of the list may be returned as null. For each list index where a keyword was not retrieved, the corresponding element will be null.Keyword array
PartialErrorsAn 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

ElementDescriptionData Type
TrackingIdThe 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/v10">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetKeywordsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <Keywords p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <Keyword>
          <Bid p4:nil="false">
            <Amount p4:nil="false"></Amount>
          </Bid>
          <BiddingScheme xmlns:e111="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false" p4:type="-- specify derived type here with the appropriate prefix --">
            <e111:Type p4:nil="false"></e111:Type>
            <!--Keep these fields if you set the i:type attribute to MaxClicksBiddingScheme-->
            <MaxCpc p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </MaxCpc>
            <!--Keep these fields if you set the i:type attribute to MaxConversionsBiddingScheme-->
            <MaxCpc p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </MaxCpc>
            <StartingBid p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </StartingBid>
            <!--Keep these fields if you set the i:type attribute to TargetCpaBiddingScheme-->
            <MaxCpc p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </MaxCpc>
            <StartingBid p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </StartingBid>
            <e111:TargetCpa p4:nil="false"></e111:TargetCpa>
            <!--Keep these fields if you set the i:type attribute to ManualCpcBiddingScheme-->
            <!--Keep these fields if you set the i:type attribute to EnhancedCpcBiddingScheme-->
            <!--Keep these fields if you set the i:type attribute to InheritFromParentBiddingScheme-->
          </BiddingScheme>
          <DestinationUrl p4:nil="false"></DestinationUrl>
          <EditorialStatus p4:nil="false"></EditorialStatus>
          <FinalAppUrls xmlns:e112="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
            <e112:AppUrl>
              <e112:OsType p4:nil="false"></e112:OsType>
              <e112:Url p4:nil="false"></e112:Url>
            </e112:AppUrl>
          </FinalAppUrls>
          <FinalMobileUrls p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string></a1:string>
          </FinalMobileUrls>
          <FinalUrls p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string></a1:string>
          </FinalUrls>
          <ForwardCompatibilityMap xmlns:e113="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e113:KeyValuePairOfstringstring>
              <e113:key p4:nil="false"></e113:key>
              <e113:value p4:nil="false"></e113:value>
            </e113:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id p4:nil="false"></Id>
          <MatchType p4:nil="false"></MatchType>
          <Param1 p4:nil="false"></Param1>
          <Param2 p4:nil="false"></Param2>
          <Param3 p4:nil="false"></Param3>
          <Status p4:nil="false"></Status>
          <Text p4:nil="false"></Text>
          <TrackingUrlTemplate p4:nil="false"></TrackingUrlTemplate>
          <UrlCustomParameters xmlns:e114="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
            <e114:Parameters p4:nil="false">
              <e114:CustomParameter>
                <e114:Key p4:nil="false"></e114:Key>
                <e114:Value p4:nil="false"></e114:Value>
              </e114:CustomParameter>
            </e114:Parameters>
          </UrlCustomParameters>
        </Keyword>
      </Keywords>
      <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>
          <FieldPath p4:nil="false"></FieldPath>
          <ForwardCompatibilityMap xmlns:e115="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e115:KeyValuePairOfstringstring>
              <e115:key p4:nil="false"></e115:key>
              <e115:value p4:nil="false"></e115:value>
            </e115:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <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>
    </GetKeywordsByIdsResponse>
  </s:Body>
</s:Envelope>

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

AddKeywordsDeleteKeywordsGetKeywordsByAdGroupIdGetKeywordsByEditorialStatusUpdateKeywords

Community Additions

ADD
Show: