My favorites | English | Sign in

Documentation for the requested version is not available.Documentation for the requested diff is not available.

TrafficEstimatorService

Link to this version

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:

  1. 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.

  2. 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.

More Information

Requests

checkKeywordTraffic

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

requests KeywordTrafficRequest[]
A list of requests for keyword traffic checks.

Response

KeywordTraffic[] A list of KeywordTraffic estimates.

Values are:

  • HasTraffic - The Keyword is expected to receive traffic.
  • VeryLowTraffic - The keyword is not expected to receive any traffic.
  • Unknown - Could not determine traffic information due to unexpected circumstances.

Samples

Code sample not available.
 
56
57
58
59
60
61
62
63
64

      // Create keyword structure.
      KeywordTrafficRequest keyword = new KeywordTrafficRequest();
      keyword.setKeywordText("mars cruise");
      keyword.setKeywordType(KeywordType.Exact);
      keyword.setLanguage("en");

      // Check keyword traffic.
      KeywordTraffic[] estimates =
          service.checkKeywordTraffic(new KeywordTrafficRequest[] {keyword});

View full sample

Code sample not available.
 
52
53
54
55
56
57
58
59
60

        // Create keyword structure.
        KeywordTrafficRequest keyword = new KeywordTrafficRequest();
        keyword.keywordText = "mars cruise";
        keyword.keywordType = KeywordType.Exact;
        keyword.language = "en";

        // Check keyword traffic.
        KeywordTraffic[] estimates = service.checkKeywordTraffic(
          new KeywordTrafficRequest[] { keyword });

View full sample

Code sample not available.
 
60
61
62
63
64
65
66
67
68
69
70

# Create keyword structure.
my $keyword = {
  'keywordText' => 'mars cruise',
  'keywordType' => 'Exact',
  'language' => 'en'
};
my $keywords = SOAP::Data->name('requests' => [$keyword]);

# Check keyword traffic.
my $response = $service->call('checkKeywordTraffic' => $keywords, @headers);
my @estimates = ($response->result(), $response->paramsout());

View full sample

Code sample not available.
 
47
48
49
50
51
52
53
54
55

# Create keyword structure.
keyword = {
  'keywordText': 'mars cruise',
  'keywordType': SOAPpy.Types.untypedType('Exact'),
  'language': 'en'
}

# Check keyword traffic.
estimates = estimator_service.checkKeywordTraffic([keyword])

View full sample

Code sample not available.
 
63
64
65
66
67
68
69
70
71
72

# Create keyword structure.
keyword = {
  :keywordText => 'mars cruise',
  :keywordType => 'Exact',
  :language => 'en',
}

# Check keyword traffic.
estimates = estimator_service.checkKeywordTraffic([keyword]
  ).checkKeywordTrafficReturn

View full sample

Code sample not available.
 
46
47
48
49
50
51
52
53
54
55
56
57
58

# Create keyword structure.
$keyword =
  '<keywordText>mars cruise</keywordText>' .
  '<keywordType>Exact</keywordType>' .
  '<language>en</language>';

# Check keyword traffic.
$request_xml =
  '<checkKeywordTraffic>' .
  '<requests>' . $keyword . '</requests>' .
  '</checkKeywordTraffic>';
$estimates = $estimator_service->call('checkKeywordTraffic', $request_xml);
$estimates = $estimates['checkKeywordTrafficReturn'];

View full sample

Code sample not available.
 
12
13
14
15
16
17
18
19

    <!-- Checks a keyword to see whether it will get any traffic. -->
    <checkKeywordTraffic>
      <requests>
        <keywordText>mars cruise</keywordText>
        <keywordType>Exact</keywordType>
        <language>en</language>
      </requests>
    </checkKeywordTraffic>

View full sample

Select a programming language to view its sample

estimateAdGroupList

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

adGroupRequests AdGroupRequest[]
The set of ad groups to estimate.

Response

AdGroupEstimate[] The traffic estimates for the requested ad groups.

estimateCampaignList

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

campaignRequests CampaignRequest[]
the set of campaigns to estimate

Response

CampaignEstimate[] The traffic estimates for the requested campaigns.

estimateKeywordList

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

keywordRequests KeywordRequest[]
The set of keywords to estimate.

Response

KeywordEstimate[] The traffic estimates for the requested keywords.

Samples

Code sample not available.
 
56
57
58
59
60
61
62
63
64

      // Create keyword structure.
      KeywordRequest keyword = new KeywordRequest();
      keyword.setText("mars cruise");
      keyword.setMaxCpc(new Long(1000000));
      keyword.setType(KeywordType.Broad);

      // Estimate keyword traffic.
      KeywordEstimate[] estimates =
        service.estimateKeywordList(new KeywordRequest[] {keyword});

View full sample

Code sample not available.
 
52
53
54
55
56
57
58
59
60
61
62

        // Create keyword structure.
        KeywordRequest keyword = new KeywordRequest();
        keyword.text = "mars cruise";
        keyword.maxCpc = 1000000;
        keyword.maxCpcSpecified = true;
        keyword.type = KeywordType.Broad;
        keyword.typeSpecified = true;

        // Estimate keyword traffic.
        KeywordEstimate[] estimates =
            service.estimateKeywordList(new KeywordRequest[] { keyword });

View full sample

Code sample not available.
 
60
61
62
63
64
65
66
67
68
69
70

# Create keyword structure.
my $keyword = {
  'text' => 'mars cruise',
  'maxCpc' => 1000000,
  'type' => 'Broad',
};
my $keywords = SOAP::Data->name('keywordRequests' => [$keyword]);

# Estimate keyword traffic.
my $response = $service->call('estimateKeywordList' => $keywords, @headers);
my @estimates = ($response->result(), $response->paramsout());

View full sample

Code sample not available.
 
47
48
49
50
51
52
53
54
55

# Create keyword structure.
keyword = {
  'text': 'mars cruise',
  'maxCpc': SOAPpy.Types.untypedType('1000000'),
  'type': SOAPpy.Types.untypedType('Broad')
}

# Estimate keyword traffic.
estimates = estimator_service.estimateKeywordList([keyword])

View full sample

Code sample not available.
 
63
64
65
66
67
68
69
70
71
72

# Create keyword structure.
keyword = {
  :text => 'mars cruise',
  :maxCpc => 1000000,
  :type => 'Broad',
}

# Estimate keyword traffic.
estimates = estimator_service.estimateKeywordList([keyword]
  ).estimateKeywordListReturn

View full sample

Code sample not available.
 
46
47
48
49
50
51
52
53
54
55
56
57
58

# Create keyword structure.
$keyword =
  '<text>mars cruise</text>' .
  '<maxCpc>1000000</maxCpc>' .
  '<type>Broad</type>';

# Estimate keyword traffic.
$request_xml =
  '<estimateKeywordList>' .
  '<keywordRequests>' . $keyword . '</keywordRequests>' .
  '</estimateKeywordList>';
$estimates = $estimator_service->call('estimateKeywordList', $request_xml);
$estimates = $estimates['estimateKeywordListReturn'];

View full sample

Code sample not available.
 
12
13
14
15
16
17
18
19

    <!-- Retrieves traffic estimate for the requested keyword. -->
    <estimateKeywordList>
      <keywordRequests>
        <maxCpc>1000000</maxCpc>
        <text>mars cruise</text>
        <type>Broad</type>
      </keywordRequests>
    </estimateKeywordList>

View full sample

Select a programming language to view its sample