CampaignEstimator Data Object - Ad Insight

Contains campaign filter criteria and a nested list of ad group and keyword level filter criteria for traffic estimates.

Syntax

XML

<xs:complexType name="CampaignEstimator" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AdGroupEstimators" nillable="true" type="tns:ArrayOfAdGroupEstimator" />
    <xs:element minOccurs="0" name="CampaignId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Criteria" nillable="true" type="tns:ArrayOfCriterion" />
    <xs:element minOccurs="0" name="DailyBudget" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="NegativeKeywords" nillable="true" type="tns:ArrayOfNegativeKeyword" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "AdGroupEstimators": [
    {
      "AdGroupId": "LongValueHere",
      "KeywordEstimators": [
        {
          "Keyword": {
            "Id": "LongValueHere",
            "MatchType": "ValueHere",
            "Text": "ValueHere"
          },
          "MaxCpc": DoubleValueHere
        }
      ],
      "MaxCpc": DoubleValueHere
    }
  ],
  "CampaignId": "LongValueHere",
  "Criteria": [
    {
      "Type": "DeviceCriterion",
      "DeviceName": "ValueHere"
    }
  ],
  "DailyBudget": DoubleValueHere,
  "NegativeKeywords": [
    {
      "Id": "LongValueHere",
      "MatchType": "ValueHere",
      "Text": "ValueHere"
    }
  ]
}

Elements

The CampaignEstimator object has the following elements: AdGroupEstimators, CampaignId, Criteria, DailyBudget, NegativeKeywords.

Element	Description	Data Type
AdGroupEstimators	The list of ad group estimators with your ad group and keyword level filter criteria for traffic estimates.	AdGroupEstimator array
CampaignId	The campaign identifier. This element is reserved for future use. The returned estimates are not based on any specific campaign.	long
Criteria	The list of campaign level criteria for traffic estimates. Do not try to instantiate a Criterion. You can include one or more the following objects that derive from it: DeviceCriterion, LanguageCriterion, LocationCriterion, and NetworkCriterion. The location, language, and network criterions are required for traffic estimates.	Criterion array
DailyBudget	The daily budget filter criteria for all keyword traffic estimates in the campaign.	double
NegativeKeywords	The list of negative keyword filter criteria for all keyword traffic estimates in the campaign.	NegativeKeyword array

Requirements

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

Used By

GetKeywordTrafficEstimates