GetEstimatedPositionByKeywordIds Service Operation - Ad Insight

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.

Note

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

Request Elements

The GetEstimatedPositionByKeywordIdsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Request Body Elements

Element Description Data Type
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
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

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts. string
CustomerAccountId The 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. string
CustomerId The 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. string
DeveloperToken The developer token used to access the Bing Ads API. string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Note

The CustomerAccountId and CustomerId are required for most service operations, and as a best practice you should always specify them in the request.

Response Elements

The GetEstimatedPositionByKeywordIdsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
KeywordEstimatedPositions A list of KeywordIdEstimatedPosition data 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.

Each KeywordIdEstimatedPosition contains a keyword identifier and a KeywordEstimatedPosition. If data is available for the keyword, the EstimatedPositionAndTraffic will provide the estimated position in the search results, based on the specified bid value. Otherwise, the EstimatedPositions element will be set to null.
KeywordIdEstimatedPosition array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="Microsoft.Advertiser.AdInsight.Api.Service.V12">
    <Action mustUnderstand="1">GetEstimatedPositionByKeywordIds</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetEstimatedPositionByKeywordIdsRequest xmlns="Microsoft.Advertiser.AdInsight.Api.Service.V12">
      <KeywordIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </KeywordIds>
      <MaxBid>ValueHere</MaxBid>
    </GetEstimatedPositionByKeywordIdsRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="Microsoft.Advertiser.AdInsight.Api.Service.V12">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetEstimatedPositionByKeywordIdsResponse xmlns="Microsoft.Advertiser.AdInsight.Api.Service.V12">
      <KeywordEstimatedPositions xmlns:e90="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.AdInsight.Api.DataContract.V12.Entity" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e90:KeywordIdEstimatedPosition>
          <e90:KeywordId>ValueHere</e90:KeywordId>
          <e90:KeywordEstimatedPosition d4p1:nil="false">
            <e90:Keyword d4p1:nil="false">ValueHere</e90:Keyword>
            <e90:EstimatedPositions d4p1:nil="false">
              <e90:EstimatedPositionAndTraffic>
                <e90:MatchType>ValueHere</e90:MatchType>
                <e90:MinClicksPerWeek>ValueHere</e90:MinClicksPerWeek>
                <e90:MaxClicksPerWeek>ValueHere</e90:MaxClicksPerWeek>
                <e90:AverageCPC>ValueHere</e90:AverageCPC>
                <e90:MinImpressionsPerWeek>ValueHere</e90:MinImpressionsPerWeek>
                <e90:MaxImpressionsPerWeek>ValueHere</e90:MaxImpressionsPerWeek>
                <e90:CTR>ValueHere</e90:CTR>
                <e90:MinTotalCostPerWeek>ValueHere</e90:MinTotalCostPerWeek>
                <e90:MaxTotalCostPerWeek>ValueHere</e90:MaxTotalCostPerWeek>
                <e90:CurrencyCode>ValueHere</e90:CurrencyCode>
                <e90:EstimatedAdPosition>ValueHere</e90:EstimatedAdPosition>
              </e90:EstimatedPositionAndTraffic>
            </e90:EstimatedPositions>
          </e90:KeywordEstimatedPosition>
        </e90:KeywordIdEstimatedPosition>
      </KeywordEstimatedPositions>
    </GetEstimatedPositionByKeywordIdsResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads Code Examples for more examples.

public async Task<GetEstimatedPositionByKeywordIdsResponse> GetEstimatedPositionByKeywordIdsAsync(
	IList<long> keywordIds,
	double maxBid)
{
	var request = new GetEstimatedPositionByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		MaxBid = maxBid
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetEstimatedPositionByKeywordIdsAsync(r), request));
}
static GetEstimatedPositionByKeywordIdsResponse getEstimatedPositionByKeywordIds(
	ArrayOflong keywordIds,
	double maxBid) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordIdsRequest request = new GetEstimatedPositionByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setMaxBid(maxBid);

	return AdInsightService.getService().getEstimatedPositionByKeywordIds(request);
}
static function GetEstimatedPositionByKeywordIds(
	$keywordIds,
	$maxBid)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetEstimatedPositionByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->MaxBid = $maxBid;

	return $GLOBALS['AdInsightProxy']->GetService()->GetEstimatedPositionByKeywordIds($request);
}
response=adinsight_service.GetEstimatedPositionByKeywordIds(
	KeywordIds=KeywordIds,
	MaxBid=MaxBid)

Requirements

Service: AdInsightService.svc v12
Namespace: Microsoft.Advertiser.AdInsight.Api.Service.V12