Skip to content

Latest commit

 

History

History
69 lines (58 loc) · 4.59 KB

budgetopportunity.md

File metadata and controls

69 lines (58 loc) · 4.59 KB
Raw
title ms.service ms.subservice ms.topic author ms.author description
BudgetOpportunity Data Object - Ad Insight
bing-ads
ad-insight-api
article
jonmeyers
jonmeyers
Defines an object that contains the suggested budget with estimated clicks and impressions opportunities.

BudgetOpportunity Data Object - Ad Insight

Defines an object that contains the suggested budget with estimated clicks and impressions opportunities. Additionally, the object contains a list of budget points with weekly impressions, clicks and cost estimates for the given budget amount.

Note

The budget opportunity is an estimate based on the last 15 days of performance data, and not a prediction or guarantee of future performance.

Syntax

<xs:complexType name="BudgetOpportunity" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Opportunity">
      <xs:sequence>
        <xs:element minOccurs="0" name="BudgetPoints" nillable="true" type="tns:ArrayOfBudgetPoint" />
        <xs:element minOccurs="0" name="BudgetType" type="tns:BudgetLimitType" />
        <xs:element minOccurs="0" name="CampaignId" type="xs:long" />
        <xs:element minOccurs="0" name="CurrentBudget" type="xs:double" />
        <xs:element minOccurs="0" name="IncreaseInClicks" type="xs:double" />
        <xs:element minOccurs="0" name="IncreaseInImpressions" type="xs:long" />
        <xs:element minOccurs="0" name="PercentageIncreaseInClicks" type="xs:int" />
        <xs:element minOccurs="0" name="PercentageIncreaseInImpressions" type="xs:int" />
        <xs:element minOccurs="0" name="RecommendedBudget" type="xs:double" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The BudgetOpportunity object has the following elements: BudgetPoints, BudgetType, CampaignId, CurrentBudget, IncreaseInClicks, IncreaseInImpressions, PercentageIncreaseInClicks, PercentageIncreaseInImpressions, RecommendedBudget.

Element Description Data Type
BudgetPoints The list of budget points with weekly impressions, clicks and cost estimates for the given budget amount. BudgetPoint array
BudgetType The type of budget that the campaign uses. BudgetLimitType
CampaignId The identifier of the campaign to which the suggested budget applies. long
CurrentBudget The campaign's current budget. double
IncreaseInClicks The estimated clicks opportunities corresponding to the suggested budget. double
IncreaseInImpressions The estimated impressions opportunities corresponding to the suggested budget. long
PercentageIncreaseInClicks The estimated percentage increase in clicks corresponding to the suggested budget. int
PercentageIncreaseInImpressions The estimated percentage increase in impressions corresponding to the suggested budget. int
RecommendedBudget The suggested budget based on the last 15 days of performance history for the corresponding campaign. double

The BudgetOpportunity object has Inherited Elements.

Inherited Elements

Inherited Elements from Opportunity

The BudgetOpportunity object derives from the Opportunity object, and inherits the following elements: OpportunityKey. The descriptions below are specific to BudgetOpportunity, and might not apply to other objects that inherit the same elements from the Opportunity object.

Element Description Data Type
OpportunityKey An identifier that uniquely identifies the opportunity. string

Requirements

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

Used By

GetBudgetOpportunities