Export (0) Print
Expand All

GetEstimatedPositionByKeywordIds Service Operation

Gets the estimated position in the search results if the specified bid value had been used for the keywords in the last 7 days. In addition, the operation provides estimates of clicks, average cost per click (CPC), and impressions that the keywords could have generated with the estimated bid.

System_CLiX_note Note

The estimates are based on the last 7 days of performance data, and not a prediction or guarantee of future performance.

Request | Response

Error Codes

Service: AdIntelligenceService.svc v9 | Namespace: https://bingads.microsoft.com/AdIntelligence/v9

GetEstimatedPositionByKeywordIdsRequest Message

Request Body

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

Required

KeywordIds

An array of identifiers of the keywords for which you want to get the estimated position in the search results, based on the specified bid value. You may specify a maximum of 1,000 keyword identifiers.

long array

Yes

MaxBid

The maximum bid value to use to determine the estimated position in the search results.

You must specify the bid value in the currency of the account.

double

Yes

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/AdIntelligence/v9">
    <Action mustUnderstand="1">GetEstimatedPositionByKeywordIds</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>
    <GetEstimatedPositionByKeywordIdsRequest xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
      <KeywordIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </KeywordIds>
      <MaxBid></MaxBid>
    </GetEstimatedPositionByKeywordIdsRequest>
  </s:Body>
</s:Envelope>

GetEstimatedPositionByKeywordIdsResponse Message

Response Body

Element

Description

Data Type

KeywordEstimatedPositions

A list of KeywordIdEstimatedPosition objects. The array contains an item for each keyword specified in the request. If the keyword ID is not valid, the corresponding item in the array will be null.

If data is available for the keyword, the KeywordEstimatedPosition object will provide the estimated position in the search results, based on the specified bid value. Otherwise, the KeywordEstimatedPosition element will be set to null.

KeywordIdEstimatedPosition array

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains the details of 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/AdIntelligence/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetEstimatedPositionByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
      <KeywordEstimatedPositions xmlns:e7="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.CampaignManagement.Api.DataContracts" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e7:KeywordIdEstimatedPosition>
          <e7:KeywordId></e7:KeywordId>
          <e7:KeywordEstimatedPosition p5:nil="false">
            <e7:Keyword p5:nil="false"></e7:Keyword>
            <e7:EstimatedPositions p5:nil="false">
              <e7:EstimatedPositionAndTraffic>
                <e7:MatchType></e7:MatchType>
                <e7:MinClicksPerWeek></e7:MinClicksPerWeek>
                <e7:MaxClicksPerWeek></e7:MaxClicksPerWeek>
                <e7:AverageCPC></e7:AverageCPC>
                <e7:MinImpressionsPerWeek></e7:MinImpressionsPerWeek>
                <e7:MaxImpressionsPerWeek></e7:MaxImpressionsPerWeek>
                <e7:CTR></e7:CTR>
                <e7:MinTotalCostPerWeek></e7:MinTotalCostPerWeek>
                <e7:MaxTotalCostPerWeek></e7:MaxTotalCostPerWeek>
                <e7:Currency></e7:Currency>
                <e7:EstimatedAdPosition></e7:EstimatedAdPosition>
              </e7:EstimatedPositionAndTraffic>
            </e7:EstimatedPositions>
          </e7:KeywordEstimatedPosition>
        </e7:KeywordIdEstimatedPosition>
      </KeywordEstimatedPositions>
    </GetEstimatedPositionByKeywordIdsResponse>
  </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 Ad Intelligence 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