GetBudgetOpportunities Service Operation - Ad Insight
Gets the campaign budget opportunities of the specified campaign.
Request Elements
The GetBudgetOpportunitiesRequest 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
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 GetBudgetOpportunitiesResponse 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 |
|---|---|---|
| Opportunities | An array of BudgetOpportunity data objects that identify the campaigns whose clicks and impressions may increase if you were to apply the suggested budget. The list will not include opportunities for campaigns that are currently paused by the user. Currently up to 1,000 list items can be returned although the limit is subject to change. |
BudgetOpportunity 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">GetBudgetOpportunities</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>
<GetBudgetOpportunitiesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<CampaignId i:nil="false">ValueHere</CampaignId>
</GetBudgetOpportunitiesRequest>
</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>
<GetBudgetOpportunitiesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Opportunities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BudgetOpportunity>
<BudgetPoints d4p1:nil="false">
<BudgetPoint>
<BudgetAmount>ValueHere</BudgetAmount>
<BudgetPointType>ValueHere</BudgetPointType>
<EstimatedWeeklyClicks>ValueHere</EstimatedWeeklyClicks>
<EstimatedWeeklyCost>ValueHere</EstimatedWeeklyCost>
<EstimatedWeeklyImpressions>ValueHere</EstimatedWeeklyImpressions>
</BudgetPoint>
</BudgetPoints>
<BudgetType>ValueHere</BudgetType>
<CampaignId>ValueHere</CampaignId>
<CurrentBudget>ValueHere</CurrentBudget>
<IncreaseInClicks>ValueHere</IncreaseInClicks>
<IncreaseInImpressions>ValueHere</IncreaseInImpressions>
<PercentageIncreaseInClicks>ValueHere</PercentageIncreaseInClicks>
<PercentageIncreaseInImpressions>ValueHere</PercentageIncreaseInImpressions>
<RecommendedBudget>ValueHere</RecommendedBudget>
</BudgetOpportunity>
</Opportunities>
</GetBudgetOpportunitiesResponse>
</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<GetBudgetOpportunitiesResponse> GetBudgetOpportunitiesAsync(
long? campaignId)
{
var request = new GetBudgetOpportunitiesRequest
{
CampaignId = campaignId
};
return (await AdInsightService.CallAsync((s, r) => s.GetBudgetOpportunitiesAsync(r), request));
}
static GetBudgetOpportunitiesResponse getBudgetOpportunities(
java.lang.Long campaignId) throws RemoteException, Exception
{
GetBudgetOpportunitiesRequest request = new GetBudgetOpportunitiesRequest();
request.setCampaignId(campaignId);
return AdInsightService.getService().getBudgetOpportunities(request);
}
static function GetBudgetOpportunities(
$campaignId)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBudgetOpportunitiesRequest();
$request->CampaignId = $campaignId;
return $GLOBALS['AdInsightProxy']->GetService()->GetBudgetOpportunities($request);
}
response=adinsight_service.GetBudgetOpportunities(
CampaignId=CampaignId)
Requirements
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for