CampaignRequest
Represents a campaign whose keywords are to be estimated.
To get traffic estimates for keywords in one or more ad groups of
a campaign, create a CampaignRequest object
for each campaign to be estimated. The keywords, ad groups and campaigns
can be new or can exist already.
See TrafficEstimatorService for details of how to submit
the request for estimation.
The results of the estimation are returned as CampaignEstimate
objects, which contain AdGroupEstimate objects, which in turn contain
KeywordEstimate objects.
Fields
| Field name | Field type | Field description |
|---|
adGroupRequests |
AdGroupRequest[] |
The adgroups to be estimated.
You must set at least one ad group whether the campaign exists already or
is new.
If the campaign is new, (that is, the id of the CampaignRequest
is not specified), you may only add new ad groups (that is,
AdGroupRequests whose ids are not specified). In this case, if you add an
AdGroupRequest that has a specified id, the request to get the
estimates results in an error.
If the campaign exists already (that is, the id of the
CampaignRequest is specified), you may add new ad groups and/or
ad groups that already exist in the campaign. If you add an ad group
that has an id but does not belong to the existing campaign, then the
request to get the estimates results in an error.
If the campaign exists and has more ad groups
than are listed, those extra ad groups are included in the estimation
process, but not in the estimation results. Otherwise, all ad groups are
included in both the estimation and results. |
geoTargeting |
GeoTarget |
The geographic targeting rules for this campaign. Optional - if omitted,
targeting will be inherited from the existing campaign if specified or else
global targeting will be used. |
id |
int |
The id of the campaign to be estimated. Optional - if omitted,
indicates a new campaign. |
languageTargeting |
LanguageTarget |
The languages targeted by this campaign.
The value is a two letter language code, such as
"en" for English or "fr" for French. |
networkTargeting |
NetworkTarget |
The advertising networks targeted by this campaign. |
API Reference
