GetBidLandscapeByKeywordIds Service Operation - Ad Insight

Given a list of existing keywords, this operation returns for each a list of suggested bids and estimated performance statistics from 1 to 7 days. This operation is not based on target position, rather it returns multiple bid options that yield different estimated clicks, impressions, and cost. You can use the landscape view of multiple bid points with estimated traffic for the same keyword to help make decisions about how to adjust your keyword bid to optimize for clicks, impressions, and cost. For example you might use the resulting data to visualize a clicks to cost curve or a bid to impressions curve.

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 GetBidLandscapeByKeywordIdsRequest 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
IncludeCurrentBid	When set to false, the suggested bid values might not include the keyword's current bid. The default value is false. When set to true, one of the suggested bid values will be equal to the keyword's current bid.	boolean
KeywordIds	An array of identifiers of the keywords for which you want to get the list of suggested bid values with estimated performance statistics. You may specify a maximum of 1,000 keywords.	long array

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 GetBidLandscapeByKeywordIdsResponse 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
BidLandscape	An array of KeywordBidLandscape objects. The array contains a KeywordBidLandscape corresponding to each keyword specified in the request. Duplicate keyword identifiers are allowed in the same call and will return the same results. If the specified keyword identifier is invalid or has no associated data results, all elements within the KeywordBidLandscape will be nil except the KeywordId which reflects the keyword identifier specified in the request. If there is data available for the keyword, the KeywordBidLandscape object will provide a list of suggested bids and estimated performance statistics.	KeywordBidLandscape 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">GetBidLandscapeByKeywordIds</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>
    <GetBidLandscapeByKeywordIdsRequest 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>
      <IncludeCurrentBid i:nil="false">ValueHere</IncludeCurrentBid>
    </GetBidLandscapeByKeywordIdsRequest>
  </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>
    <GetBidLandscapeByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <BidLandscape d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordBidLandscape>
          <KeywordId>ValueHere</KeywordId>
          <StartDate d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </StartDate>
          <EndDate d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </EndDate>
          <BidLandscapePoints d4p1:nil="false">
            <BidLandscapePoint>
              <Bid>ValueHere</Bid>
              <Clicks d4p1:nil="false">ValueHere</Clicks>
              <Impressions>ValueHere</Impressions>
              <TopImpressions d4p1:nil="false">ValueHere</TopImpressions>
              <CurrencyCode>ValueHere</CurrencyCode>
              <Cost d4p1:nil="false">ValueHere</Cost>
              <MarginalCPC d4p1:nil="false">ValueHere</MarginalCPC>
            </BidLandscapePoint>
          </BidLandscapePoints>
        </KeywordBidLandscape>
      </BidLandscape>
    </GetBidLandscapeByKeywordIdsResponse>
  </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<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
	IList<long> keywordIds,
	bool? includeCurrentBid)
{
	var request = new GetBidLandscapeByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		IncludeCurrentBid = includeCurrentBid
	};

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

static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
	ArrayOflong keywordIds,
	boolean includeCurrentBid) throws RemoteException, Exception
{
	GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setIncludeCurrentBid(includeCurrentBid);

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

static function GetBidLandscapeByKeywordIds(
	$keywordIds,
	$includeCurrentBid)
{

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

	$request = new GetBidLandscapeByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->IncludeCurrentBid = $includeCurrentBid;

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

response=adinsight_service.GetBidLandscapeByKeywordIds(
	KeywordIds=KeywordIds,
	IncludeCurrentBid=IncludeCurrentBid)

Requirements

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

Request Url

Production URL

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/BidLandscape/QueryByKeywordIds

Sandbox URL

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/BidLandscape/QueryByKeywordIds

Request Elements

The GetBidLandscapeByKeywordIdsRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
IncludeCurrentBid	When set to false, the suggested bid values might not include the keyword's current bid. The default value is false. When set to true, one of the suggested bid values will be equal to the keyword's current bid.	boolean
KeywordIds	An array of identifiers of the keywords for which you want to get the list of suggested bid values with estimated performance statistics. You may specify a maximum of 1,000 keywords.	long array

Request Header Elements

Element	Description	Data Type
Authorization	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. 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 GetBidLandscapeByKeywordIdsResponse 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 JSON.

Response Body Elements

Element	Description	Data Type
BidLandscape	An array of KeywordBidLandscape objects. The array contains a KeywordBidLandscape corresponding to each keyword specified in the request. Duplicate keyword identifiers are allowed in the same call and will return the same results. If the specified keyword identifier is invalid or has no associated data results, all elements within the KeywordBidLandscape will be nil except the KeywordId which reflects the keyword identifier specified in the request. If there is data available for the keyword, the KeywordBidLandscape object will provide a list of suggested bids and estimated performance statistics.	KeywordBidLandscape 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 JSON

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

{
  "KeywordIds": [
    "LongValueHere"
  ],
  "IncludeCurrentBid": "ValueHere"
}

Response JSON

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

{
  "BidLandscape": [
    {
      "BidLandscapePoints": [
        {
          "Bid": DoubleValueHere,
          "Clicks": DoubleValueHere,
          "Cost": DoubleValueHere,
          "CurrencyCode": "ValueHere",
          "Impressions": "LongValueHere",
          "MarginalCPC": DoubleValueHere,
          "TopImpressions": "LongValueHere"
        }
      ],
      "EndDate": {
        "Day": IntValueHere,
        "Month": IntValueHere,
        "Year": IntValueHere
      },
      "KeywordId": "LongValueHere",
      "StartDate": {
        "Day": IntValueHere,
        "Month": IntValueHere,
        "Year": IntValueHere
      }
    }
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
	IList<long> keywordIds,
	bool? includeCurrentBid)
{
	var request = new GetBidLandscapeByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		IncludeCurrentBid = includeCurrentBid
	};

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

static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
	ArrayOflong keywordIds,
	boolean includeCurrentBid) throws RemoteException, Exception
{
	GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setIncludeCurrentBid(includeCurrentBid);

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

static function GetBidLandscapeByKeywordIds(
	$keywordIds,
	$includeCurrentBid)
{

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

	$request = new GetBidLandscapeByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->IncludeCurrentBid = $includeCurrentBid;

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

response=adinsight_service.GetBidLandscapeByKeywordIds(
	KeywordIds=KeywordIds,
	IncludeCurrentBid=IncludeCurrentBid)