type CampaignEstimateRequest (v201809)

Service
TrafficEstimatorService
Dependencies
TrafficEstimatorSelector
▼
CampaignEstimateRequest
▼
cm:Criterion cm:Money cm:NetworkSetting
Inheritance
EstimateRequest
▼
AdGroupEstimateRequest CampaignEstimateRequest KeywordEstimateRequest

Represents a campaign that will be estimated.

Returns traffic estimates for the requested set of campaigns. The campaigns can be all new or all existing, or a mixture of new and existing. Only existing campaigns may contain estimates for existing ad groups.

For existing campaigns, the campaign and optionally the ad group will be used as context to produce more accurate estimates. Traffic estimates may only be requested on keywords, so regardless of whether campaign and ad group IDs are provided or left blank, at least one keyword is required to estimate traffic.

To make a keyword estimates request in which estimates do not consider existing account information (e.g. historical ad group performance), set campaignId to null.

Namespace
https://adwords.google.com/api/adwords/o/v201809

Field
EstimateRequest (inherited)

EstimateRequest.Type

xsd:string

Indicates that this instance is a subtype of EstimateRequest. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

CampaignEstimateRequest

campaignId

xsd:long

The campaignId of an existing campaign or null.

Refer to the CampaignEstimateRequest documentation for detailed usage.

adGroupEstimateRequests

AdGroupEstimateRequest[]

The list of ad groups to estimate. This field is required and should not be null. At least one ad group is required.

New campaigns may only contain new ad groups. If an AdGroupEstimateRequest has an adGroupId but the campaign is new, the API will return an error.

This field must not contain null elements.

criteria

  1. cm:Criterion[]
    1. Keyword
    2. Language
    3. Location
    4. MobileAppCategory
    5. MobileApplication
    6. Placement
    7. Platform
    8. CriterionUserInterest
    9. CriterionUserList
    10. Vertical

A list of Criterions to be used for this Campaign. Criteria provide information about geographical and language targeting.

Values in this field override the current targets in the Campaign specified by campaignId by the following mechanism:

This field accepts two types of Criterions: Location, which should contain all geographic targeting and Language, which should contain all language targeting. If Locations are passed in, all geographic targeting in the campaign will be overridden. If any Languages are passed in, all language targeting in the campaign will be overridden.

If multiple Locations are specified, the traffic estimate will be the sum of the estimates for each targeted area. This means that if criteria are chosen which overlap each other (for example, targeting both a country and a city within that country), the traffic estimate will be be larger than if no overlap were present - i. e., the overlap region will be double-counted in the estimate.

If no criteria are specified and this is for a new campaign then it will default to all languages in all countries and territories, and Google search.

If no criteria are specified and this is for an existing campaign then the current targeting on that campaign will be used.

While there's no solid limit on number of criteria, TrafficEstimatorService may return error with TOO_MANY_TARGETS if the request contains too many criteria across all CampaignEstimateRequests in a TrafficEstimatorSelector.

Supported Criteria : Language and Location.

This field must contain distinct elements.
This field must not contain null elements.

networkSetting

cm:NetworkSetting

A NetworkSetting to be used for this Campaign. The value of this field overrides the current targets in the Campaign specified by campaignId.

For non Google partner accounts, only NetworkSetting.targetGoogleSearch and NetworkSetting.targetSearchNetwork are supported, they may be combined to sum the estimates.

For some Google partner accounts, in addition NetworkSetting.getTargetPartnerSearchNetwork is supported.

If all request network settings and Campaign's network settings are empty, the default is NetworkSetting.targetGoogleSearch.

dailyBudget

cm:Money

Daily campaign budget to use in traffic estimation. If not specified, the daily budget is unlimited.