Export (0) Print
Expand All

GetBudgetLandscape Service Operation

Gets the campaign budget landscape and corresponding budget points for the specified campaign in an account. You may use the budget points to compare your current budget to any of the proposed budgets.

Request | Response

Error Codes

Service: OptimizerService.svc v9 | Namespace: https://bingads.microsoft.com/Optimizer/v9

GetBudgetLandscapeRequest Message

Request Body

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

AccountId

The identifier of the account for which you want to discover a list of campaign budget suggestions.

long

Yes

CampaignId

The identifier of the campaign for which you want to discover a list of campaign budget suggestions.

System_CLiX_note Note

If this element is not specified, the response will include budget landscapes for all campaigns in the specified account.

long

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/Optimizer/v9">
    <Action mustUnderstand="1">GetBudgetLandscape</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>
    <GetBudgetLandscapeRequest xmlns="https://bingads.microsoft.com/Optimizer/v9">
      <AccountId></AccountId>
      <CampaignId i:nil="false"></CampaignId>
    </GetBudgetLandscapeRequest>
  </s:Body>
</s:Envelope>

GetBudgetLandscapeResponse Message

Response Body

Element

Description

Data Type

CampaignBudgetLandscapes

A list of CampaignBudgetLandscape objects that identify one or more campaigns with suggested budget points.

CampaignBudgetLandscape array

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains details about 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/Optimizer/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetBudgetLandscapeResponse xmlns="https://bingads.microsoft.com/Optimizer/v9">
      <CampaignBudgetLandscapes xmlns:e2="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.Optimizer.Api.DataContracts.Entities" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e2:CampaignBudgetLandscape>
          <e2:BaseDate></e2:BaseDate>
          <e2:BudgetPoints p5:nil="false">
            <e2:BudgetPoint>
              <e2:BudgetAmount></e2:BudgetAmount>
              <e2:BudgetLandscapePoints p5:nil="false">
                <e2:BudgetLandscapePoint>
                  <e2:BudgetLandscapePointDate></e2:BudgetLandscapePointDate>
                  <e2:Clicks></e2:Clicks>
                  <e2:EstimatedClicks></e2:EstimatedClicks>
                  <e2:EstimatedImpressions></e2:EstimatedImpressions>
                  <e2:Impressions></e2:Impressions>
                </e2:BudgetLandscapePoint>
              </e2:BudgetLandscapePoints>
              <e2:BudgetPointType></e2:BudgetPointType>
              <e2:EstimatedAvgDailyClicks></e2:EstimatedAvgDailyClicks>
              <e2:EstimatedAvgDailyCost></e2:EstimatedAvgDailyCost>
              <e2:EstimatedAvgDailyImpressions></e2:EstimatedAvgDailyImpressions>
            </e2:BudgetPoint>
          </e2:BudgetPoints>
          <e2:CampaignId></e2:CampaignId>
        </e2:CampaignBudgetLandscape>
      </CampaignBudgetLandscapes>
    </GetBudgetLandscapeResponse>
  </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 Optimizer 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