CampaignBudgetRecommendation Data Object - Ad Insight

Defines the CampaignBudgetRecommendation data object.

Syntax

XML

<xs:complexType name="CampaignBudgetRecommendation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:RecommendationBase">
      <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="CurrentBudget" type="xs:double" />
        <xs:element minOccurs="0" name="RecommendedBudget" type="xs:double" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

JSON

{
  "AccountId": "LongValueHere",
  "AccountName": "ValueHere",
  "AdGroupId": "LongValueHere",
  "AdGroupName": "ValueHere",
  "CampaignId": "LongValueHere",
  "CampaignName": "ValueHere",
  "CurrentClicks": "LongValueHere",
  "CurrentConversions": "LongValueHere",
  "CurrentCost": DoubleValueHere,
  "CurrentImpressions": "LongValueHere",
  "Dismissed": "ValueHere",
  "EstimatedIncreaseInClicks": "LongValueHere",
  "EstimatedIncreaseInConversions": "LongValueHere",
  "EstimatedIncreaseInCost": DoubleValueHere,
  "EstimatedIncreaseInImpressions": "LongValueHere",
  "RecommendationHash": "ValueHere",
  "RecommendationId": "ValueHere",
  "RecommendationType": "ValueHere",
  "Type": "CampaignBudgetRecommendation",
  "BudgetPoints": [
    {
      "BudgetAmount": DoubleValueHere,
      "BudgetPointType": "ValueHere",
      "EstimatedWeeklyClicks": DoubleValueHere,
      "EstimatedWeeklyCost": DoubleValueHere,
      "EstimatedWeeklyImpressions": DoubleValueHere
    }
  ],
  "BudgetType": "ValueHere",
  "CurrentBudget": DoubleValueHere,
  "RecommendedBudget": DoubleValueHere
}

Elements

The CampaignBudgetRecommendation object has the following elements: BudgetPoints, BudgetType, CurrentBudget, RecommendedBudget.

Element	Description	Data Type
BudgetPoints	The list of budget points with weekly impressions, clicks and cost estimates for the given budget amount. Output only.	BudgetPoint array
BudgetType	The type of budget that the campaign uses. Output only.	BudgetLimitType
CurrentBudget	The current budget amount. Output only.	double
RecommendedBudget	The recommended budget amount based on the last 15 days of performance history for the corresponding campaign. Output only.	double

The CampaignBudgetRecommendation object has Inherited Elements.

Inherited Elements

Inherited Elements from RecommendationBase

The CampaignBudgetRecommendation object derives from the RecommendationBase object, and inherits the following elements: AccountId, AccountName, AdGroupId, AdGroupName, CampaignId, CampaignName, CurrentClicks, CurrentConversions, CurrentCost, CurrentImpressions, Dismissed, EstimatedIncreaseInClicks, EstimatedIncreaseInConversions, EstimatedIncreaseInCost, EstimatedIncreaseInImpressions, RecommendationHash, RecommendationId, RecommendationType, Type. The descriptions below are specific to CampaignBudgetRecommendation, and might not apply to other objects that inherit the same elements from the RecommendationBase object.

Element	Description	Data Type
AccountId	The identifier of the account. Output only.	long
AccountName	The name of the account. Output only.	string
AdGroupId	The ad group ID targeted by this recommendation. This will be set only when the recommendation affects a single ad group. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD.	long
AdGroupName	The name of the ad group. Output only.	string
CampaignId	The campaign ID targeted by this recommendation. Output only. This field will be set for the following recommendation types: KEYWORD, RESPONSIVE_SEARCH_AD	long
CampaignName	The name of the campaign. Output only.	string
CurrentClicks	Actual clicks of the ad group in the past 7 days. Output only.	long
CurrentConversions	Actual conversions of the ad group in the past 7 days. Output only.	long
CurrentCost	Actual spending of the ad group in the past 7 days, in the currency of this account.	double
CurrentImpressions	Actual impressions of the ad group in the past 7 days.	long
Dismissed	Whether the recommendation is dismissed or not. Output only.	boolean
EstimatedIncreaseInClicks	The estimated click opportunities corresponding to the suggested ad.	long
EstimatedIncreaseInConversions	The estimated impression opportunities corresponding to the suggested ad.	long
EstimatedIncreaseInCost	The estimated increase in spend corresponding to the suggested ad.	double
EstimatedIncreaseInImpressions	The estimated impressions opportunities corresponding to the suggested ad.	long
RecommendationHash	The hash of the recommendation.	string
RecommendationId	The identifier of the recommendation.	string
RecommendationType	The type of recommendation. Note: We currently support CAMPAIGN_BUDGET, KEYWORD, and RESPONSIVE_SEARCH_AD. RecommendationType is output only.	string
Type	The RecommendationType value set has the following values: CampaignBudgetRecommendation, KeywordRecommendation, ResponsiveSearchAdRecommendation.	RecommendationType

Requirements

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