Export (0) Print
Expand All

GetEstimatedBidByKeywords Service Operation

Gets the estimated bid value of one or more keywords that could result in an ad appearing in the targeted position in the search results.

System_CLiX_note Note

The estimates are not a prediction or guarantee of future performance.

Request | Response

Error Codes | Remarks

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

GetEstimatedBidByKeywordsRequest Message

Request Body

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

AdGroupId

The identifier of the ad group whose performance data is used to help determine how well the keyword might perform in the context of the ad group. Specifying an ad group helps improve the accuracy of the suggested bid.

If you specify an ad group, you must specify the campaign that it belongs to.

long

No

CampaignId

The identifier of the campaign that owns the ad group specified in AdGroupId. If you do not specify an ad group, the campaign’s performance data is used to help determine how well the keyword might perform in the context of the campaign.

System_CLiX_note Note

Specifying a campaign and ad group helps improve the accuracy of the suggested bid. If neither AdGroupId or CampaignId are specified, the operation uses the specified CustomerAccountId header element to help determine how well the keyword might perform in the context of the account.

long

No

Currency

The monetary unit to use to calculate the cost estimates and suggested bid value.

If not set, the service determines the currency from the account specified in the CustomerAccountId header element. If neither Currency or CustomerAccountId is set, the service uses USDollar.

Currency

No

GetBidsAtLevel

Determines whether to return estimates for keyword level bids, ad group level bids, or both.

  • Set GetBidsAtLevel to 0 to get an array of KeywordEstimatedBid.

  • Set GetBidsAtLevel to 2 to get one AdGroupEstimatedBid.

  • Set GetBidsAtLevel to 3 to get an array of KeywordEstimatedBid and one AdGroupEstimatedBid.

If you do not set GetBidsAtLevel, the default is to return only an array of KeywordEstimatedBid, or the equivalent of setting GetBidsAtLevel to 0.

If you set GetBidsAtLevel to any other value the service will return Code 3501 with ErrorCode CampaignServiceBidLevelInvalid.

int

No

Keywords

A list of KeywordAndMatchType objects for which you want to get suggested bid values. You may specify a maximum of 1,000 keywords, and each keyword can contain a maximum of 100 characters.

KeywordAndMatchType array

Yes

Language

The language used to help determine the country to use as the source of data for estimating the bids, if the PublisherCountries element is not specified.

System_CLiX_note Note

The language must be supported in each of the countries in the PublisherCountries element.

For possible values and information about the relationship between languages and countries, see Ad Languages.

The default value is determined by the PublisherCountries element and the location targets associated with the specified AdGroupId and CampaignId. For more information, see the Remarks section below.

string

No

PublisherCountries

The country codes of the countries to use as the source of data for estimating the bids.

System_CLiX_note Note

All of the countries must support the language specified in the Language element.

You may specify one or more country codes. For possible values, see Geographical Location Codes.

The default value is determined by the Language element and the location targets associated with the specified AdGroupId and CampaignId. For more information, see the Remarks section below.

string array

No

TargetPositionForAds

The position where you want your ads to appear in the search results.

The default value is MainLine1.

TargetAdPosition

No

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">GetEstimatedBidByKeywords</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>
    <GetEstimatedBidByKeywordsRequest xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
      <Keywords xmlns:e4="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.CampaignManagement.Api.DataContracts" i:nil="false">
        <e4:KeywordAndMatchType>
          <e4:KeywordText i:nil="false"></e4:KeywordText>
          <e4:MatchTypes i:nil="false">
            <MatchType></MatchType>
          </e4:MatchTypes>
        </e4:KeywordAndMatchType>
      </Keywords>
      <TargetPositionForAds></TargetPositionForAds>
      <Language i:nil="false"></Language>
      <PublisherCountries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string></a1:string>
      </PublisherCountries>
      <Currency i:nil="false"></Currency>
      <CampaignId i:nil="false"></CampaignId>
      <AdgroupId i:nil="false"></AdgroupId>
      <GetBidsAtLevel i:nil="false"></GetBidsAtLevel>
    </GetEstimatedBidByKeywordsRequest>
  </s:Body>
</s:Envelope>

GetEstimatedBidByKeywordsResponse Message

Response Body

Element

Description

Data Type

AdGroupEstimatedBid

Contains estimates of clicks, average cost per click (CPC), impressions, click-through rate (CTR), and total cost for the specified ad group if you would use the suggested bid.

AdGroupEstimatedBid

KeywordEstimatedBids

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

KeywordEstimatedBid 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>
    <GetEstimatedBidByKeywordsResponse xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
      <KeywordEstimatedBids xmlns:e5="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.CampaignManagement.Api.DataContracts" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e5:KeywordEstimatedBid>
          <e5:Keyword p5:nil="false"></e5:Keyword>
          <e5:EstimatedBids p5:nil="false">
            <e5:EstimatedBidAndTraffic>
              <e5:MatchType></e5:MatchType>
              <e5:MinClicksPerWeek p5:nil="false"></e5:MinClicksPerWeek>
              <e5:MaxClicksPerWeek p5:nil="false"></e5:MaxClicksPerWeek>
              <e5:AverageCPC p5:nil="false"></e5:AverageCPC>
              <e5:MinImpressionsPerWeek p5:nil="false"></e5:MinImpressionsPerWeek>
              <e5:MaxImpressionsPerWeek p5:nil="false"></e5:MaxImpressionsPerWeek>
              <e5:CTR p5:nil="false"></e5:CTR>
              <e5:MinTotalCostPerWeek p5:nil="false"></e5:MinTotalCostPerWeek>
              <e5:MaxTotalCostPerWeek p5:nil="false"></e5:MaxTotalCostPerWeek>
              <e5:Currency></e5:Currency>
              <e5:EstimatedMinBid></e5:EstimatedMinBid>
            </e5:EstimatedBidAndTraffic>
          </e5:EstimatedBids>
        </e5:KeywordEstimatedBid>
      </KeywordEstimatedBids>
      <AdGroupEstimatedBid xmlns:e6="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.CampaignManagement.Api.DataContracts" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e6:MinClicksPerWeek p5:nil="false"></e6:MinClicksPerWeek>
        <e6:MaxClicksPerWeek p5:nil="false"></e6:MaxClicksPerWeek>
        <e6:AverageCPC p5:nil="false"></e6:AverageCPC>
        <e6:MinImpressionsPerWeek p5:nil="false"></e6:MinImpressionsPerWeek>
        <e6:MaxImpressionsPerWeek p5:nil="false"></e6:MaxImpressionsPerWeek>
        <e6:CTR p5:nil="false"></e6:CTR>
        <e6:MinTotalCostPerWeek p5:nil="false"></e6:MinTotalCostPerWeek>
        <e6:MaxTotalCostPerWeek p5:nil="false"></e6:MaxTotalCostPerWeek>
        <e6:Currency></e6:Currency>
        <e6:EstimatedAdGroupBid></e6:EstimatedAdGroupBid>
      </AdGroupEstimatedBid>
    </GetEstimatedBidByKeywordsResponse>
  </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

Remarks

As a best practice for the most accurate bid estimates per country, you should specify only one country per service call. If no countries are specified or if multiple PublisherCountries are specified, then the service will use the first available set of the following properties to determine the country to use as the source of data for estimating the bids.

  • Multiple countries corresponding to this operation's specified PublisherCountries element.

  • The service will use the set of all supported countries for the specified Language, and join with common supported countries in the LocationTarget associated with the specified AdGroupId.

    System_CLiX_note Note

    If the target countries conflict with the specified Language, then the service will disregard the target countries and only use the set of all supported countries for the specified Language.

  • The service will use the set of all supported countries for the specified Language, and join with common supported countries in the LocationTarget associated with the specified CampaignId.

    System_CLiX_note Note

    If the target countries conflict with the specified Language, then the service will disregard the target countries and only use the set of all supported countries for the specified Language.

  • Language element of the AdGroup corresponding to this operation's specified AdGroupId element. The service will use the set of all supported countries for this language.

Given multiple countries from one of the property sets above, the service will then determine one country with the highest impression count to use as the source of data for estimating the bids. The response will not include details on the final filtered country.

Community Additions

ADD
Show:
© 2015 Microsoft