TrafficEstimatorService
Provides keyword traffic estimates (such as clicks per day and cost per click)
for new or existing keywords. You can specify whether the TrafficEstimator should
estimate the keyword by itself, or whether it should take ad group-level criteria
or campaign-level criteria into consideration when doing the estimation.
For example, you could get estimates for a keyword either with or without
campaign-wide geotargeting criteria being taken into consideration.
To use this service:
- Create one
KeywordRequest object for each keyword to be
estimated. Create AdGroupRequest and CampaignRequest objects
as required. Set the details of the entities that are to be estimated.
Whether or not an entity is new or exists already is
determined by the id of the entity. For example, to estimate keywords in a
new campaign, create a CampaignRequest data object,
and leave its id field empty. To estimate keywords in an existing campaign, set the id
of the CampaignRequest to the id of an existing campaign.
- Send an
estimateKeywordList, estimateAdGroupList or
estimateCampaignList request, as appropriate, to
the TrafficEstimatorService.
The response will be a set of KeywordEstimate, AdGroupEstimate
or CampaignEstimate data objects.
-- CampaignEstimate objects contain AdGroupEstimate objects
-- AdGroupEstimate objects contain KeywordEstimate objects.
-- KeywordEstimate objects contain the estimation data.
For more information about how to use the TrafficEstimatorService, see the overview section.
Requests
Check a batch of keywords to see whether they will get any traffic.
If a keyword is not expected to get any traffic, you more than likely
don't want to bother adding it.
Also, if a keyword is not expected to get any traffic, it is probably
not worth calling estimateKeywordList on it.
Parameters
| Parameter name | Parameter type | Parameter description |
|---|
| requests |
KeywordTrafficRequest[] |
A list of requests for keyword traffic checks. |
Response
| Response type | Response description |
|---|
KeywordTraffic[] |
A list of KeywordTraffic estimates.
Values are:
- HasTraffic
- VeryLowTraffic
- Unknown
|
Returns traffic estimates for the requested set of new or existing
ad groups.
All of the ad groups must be new or
all of the ad groups must be from the same campaign.
New ad groups are estimated as if they were
part of a new campaign with global targeting.
Only existing ad groups can contain estimates for existing keywords.
Parameters
| Parameter name | Parameter type | Parameter description |
|---|
| adGroupRequests |
AdGroupRequest[] |
The set of ad groups to estimate. |
Response
| Response type | Response description |
|---|
AdGroupEstimate[] |
The traffic estimates for the requested ad groups. |
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 can contain estimates for existing ad groups.
Parameters
| Parameter name | Parameter type | Parameter description |
|---|
| campaignRequests |
CampaignRequest[] |
the set of campaigns to estimate |
Response
| Response type | Response description |
|---|
CampaignEstimate[] |
The traffic estimates for the requested campaigns. |
Returns traffic estimates for the requested set of new keywords.
All of the keywords must be new.
Keywords are estimated as if they were part of a single new ad group
in a single new campaign with global targeting.
To get estimates for existing keywords, use the
estimateAdGroupList or estimateCampaignList requests.
Parameters
| Parameter name | Parameter type | Parameter description |
|---|
| keywordRequests |
KeywordRequest[] |
The set of keywords to estimate. |
Response
| Response type | Response description |
|---|
KeywordEstimate[] |
The traffic estimates for the requested keywords. |
API Reference
