GetEstimatedBidByKeywordIds Service Operation - Ad Insight

Article
03/20/2023

Gets the estimated bid value of one or more keywords - specified by keyword identifier - that could have resulted in an ad appearing in the targeted position in the search results 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.

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

Note

This operation is for search campaigns using the enhanced CPC bid strategy.

Request Elements

The GetEstimatedBidByKeywordIdsRequest 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.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
KeywordIds	An array of identifiers of the keywords for which you want to get the suggested bid values that could have resulted in your ad appearing in the targeted position in the search results. You may specify a maximum of 1,000 keywords.	long array
TargetPositionForAds	The position in which you want your ads to appear in the search results. The default value is MainLine1.	TargetAdPosition

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	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

Response Elements

The GetEstimatedBidByKeywordIdsResponse 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
KeywordEstimatedBids	An array of KeywordIdEstimatedBid data objects. The array contains a corresponding 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 KeywordIdEstimatedBid contains a keyword identifier and a KeywordEstimatedBid. If there is data available for the keyword, the KeywordEstimatedBid will provide a suggested bid value that could have resulted in an ad appearing in the targeted position of the search results. Otherwise, the KeywordEstimatedBid element will be set to null.	KeywordIdEstimatedBid 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="https://bingads.microsoft.com/AdInsight/v13">
    <Action mustUnderstand="1">GetEstimatedBidByKeywordIds</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>
    <GetEstimatedBidByKeywordIdsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </KeywordIds>
      <TargetPositionForAds>ValueHere</TargetPositionForAds>
    </GetEstimatedBidByKeywordIdsRequest>
  </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="https://bingads.microsoft.com/AdInsight/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetEstimatedBidByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedBids d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordIdEstimatedBid>
          <KeywordId>ValueHere</KeywordId>
          <KeywordEstimatedBid d4p1:nil="false">
            <Keyword d4p1:nil="false">ValueHere</Keyword>
            <EstimatedBids d4p1:nil="false">
              <EstimatedBidAndTraffic>
                <MinClicksPerWeek d4p1:nil="false">ValueHere</MinClicksPerWeek>
                <MaxClicksPerWeek d4p1:nil="false">ValueHere</MaxClicksPerWeek>
                <AverageCPC d4p1:nil="false">ValueHere</AverageCPC>
                <MinImpressionsPerWeek d4p1:nil="false">ValueHere</MinImpressionsPerWeek>
                <MaxImpressionsPerWeek d4p1:nil="false">ValueHere</MaxImpressionsPerWeek>
                <CTR d4p1:nil="false">ValueHere</CTR>
                <MinTotalCostPerWeek d4p1:nil="false">ValueHere</MinTotalCostPerWeek>
                <MaxTotalCostPerWeek d4p1:nil="false">ValueHere</MaxTotalCostPerWeek>
                <CurrencyCode>ValueHere</CurrencyCode>
                <MatchType>ValueHere</MatchType>
                <EstimatedMinBid>ValueHere</EstimatedMinBid>
              </EstimatedBidAndTraffic>
            </EstimatedBids>
          </KeywordEstimatedBid>
        </KeywordIdEstimatedBid>
      </KeywordEstimatedBids>
    </GetEstimatedBidByKeywordIdsResponse>
  </s:Body>
</s:Envelope>

Code Syntax

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

public async Task<GetEstimatedBidByKeywordIdsResponse> GetEstimatedBidByKeywordIdsAsync(
	IList<long> keywordIds,
	TargetAdPosition targetPositionForAds)
{
	var request = new GetEstimatedBidByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		TargetPositionForAds = targetPositionForAds
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetEstimatedBidByKeywordIdsAsync(r), request));
}

static GetEstimatedBidByKeywordIdsResponse getEstimatedBidByKeywordIds(
	ArrayOflong keywordIds,
	TargetAdPosition targetPositionForAds) throws RemoteException, Exception
{
	GetEstimatedBidByKeywordIdsRequest request = new GetEstimatedBidByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setTargetPositionForAds(targetPositionForAds);

	return AdInsightService.getService().getEstimatedBidByKeywordIds(request);
}

static function GetEstimatedBidByKeywordIds(
	$keywordIds,
	$targetPositionForAds)
{

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

	$request = new GetEstimatedBidByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->TargetPositionForAds = $targetPositionForAds;

	return $GLOBALS['AdInsightProxy']->GetService()->GetEstimatedBidByKeywordIds($request);
}

response=adinsight_service.GetEstimatedBidByKeywordIds(
	KeywordIds=KeywordIds,
	TargetPositionForAds=TargetPositionForAds)

Requirements

Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13