Export (0) Print
Expand All

GetBidLandscapeByAdGroupIds Service Operation

Given a list of existing ad groups, this operation returns for each a list of suggested bids and estimated performance statistics. You can use the landscape view of multiple bid points with estimated traffic for the same ad group to help make decisions about how to adjust your ad group level default 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.

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.

System_CLiX_note Note

Currently bid landscape is only available in the United States. It is not recommended to use this service operation for accounts in other markets.

Request | Response

Error Codes

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

GetBidLandscapeByAdGroupIdsRequest Message

Request Body

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

AdGroupBidLandscapeInputs

An array of ad group identifiers with corresponding bid landscape type input. A list of suggested bid values with estimated performance statistics will be returned for each input.

You may specify a maximum of 1,000 input elements.

AdGroupBidLandscapeInput array

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">GetBidLandscapeByAdGroupIds</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>
    <GetBidLandscapeByAdGroupIdsRequest xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
      <AdGroupBidLandscapeInputs xmlns:e1="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.CampaignManagement.Api.DataContracts" i:nil="false">
        <e1:AdGroupBidLandscapeInput>
          <e1:AdGroupBidLandscapeType></e1:AdGroupBidLandscapeType>
          <e1:AdGroupId></e1:AdGroupId>
        </e1:AdGroupBidLandscapeInput>
      </AdGroupBidLandscapeInputs>
    </GetBidLandscapeByAdGroupIdsRequest>
  </s:Body>
</s:Envelope>

GetBidLandscapeByAdGroupIdsResponse Message

Response Body

Element

Description

Data Type

BidLandscape

An array of AdGroupBidLandscape objects. The array contains a AdGroupBidLandscape corresponding to each ad group and bid landscape type input specified in the request. Duplicate input are allowed in the same call and will return the same results.

If the specified input is invalid or has no associated data results, all elements within the AdGroupBidLandscape will be nil except the AdGroupId which reflects the ad group identifier specified in the request.

If there is data available for the ad group, the AdGroupBidLandscape object will provide a list of suggested bids and estimated performance statistics.

AdGroupBidLandscape 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>
    <GetBidLandscapeByAdGroupIdsResponse xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
      <BidLandscape xmlns:e2="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.CampaignManagement.Api.DataContracts" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e2:AdGroupBidLandscape>
          <e2:AdGroupId></e2:AdGroupId>
          <e2:AdGroupBidLandscapeType></e2:AdGroupBidLandscapeType>
          <e2:StartDate p5:nil="false">
            <e2:Day></e2:Day>
            <e2:Month></e2:Month>
            <e2:Year></e2:Year>
          </e2:StartDate>
          <e2:EndDate p5:nil="false">
            <e2:Day></e2:Day>
            <e2:Month></e2:Month>
            <e2:Year></e2:Year>
          </e2:EndDate>
          <e2:BidLandscapePoints p5:nil="false">
            <e2:BidLandscapePoint>
              <e2:Bid></e2:Bid>
              <e2:Clicks p5:nil="false"></e2:Clicks>
              <e2:Impressions></e2:Impressions>
              <e2:TopImpressions p5:nil="false"></e2:TopImpressions>
              <e2:Currency></e2:Currency>
              <e2:Cost p5:nil="false"></e2:Cost>
              <e2:MarginalCPC p5:nil="false"></e2:MarginalCPC>
            </e2:BidLandscapePoint>
          </e2:BidLandscapePoints>
        </e2:AdGroupBidLandscape>
      </BidLandscape>
    </GetBidLandscapeByAdGroupIdsResponse>
  </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