Wrapper class for the v13 TrafficEstimator service. This class is automatically generated.

Methods
C
E
N
Attributes
[R] api

Holds the AdWords::API object to which the wrapper belongs.

[R] module

Holds a shortcut to the parent module. Use this to avoid typing the full class name when creating classes belonging to this service, e.g.

 service_object.module::ClassName

instead of

 AdWords::V13::TrafficEstimatorService::ClassName

This will make it easier to migrate your code between API versions.

Class Public methods
new(driver, api)

Constructor for TrafficEstimatorServiceWrapper.

Args:

  • driver: SOAP::RPC::Driver object with the remote SOAP methods for this service

  • api: the AdWords::API object to which the wrapper belongs

    # File lib/adwords4r/v13/TrafficEstimatorServiceWrapper.rb, line 34
34:         def initialize(driver, api)
35:           @driver = driver
36:           @api = api
37:           @module = AdWords::V13::TrafficEstimatorService
38:         end
Instance Public methods
checkKeywordTraffic(requests)

Calls the checkKeywordTraffic method of the TrafficEstimator service. Check the online documentation for this method.

Args:

Returns:

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

    # File lib/adwords4r/v13/TrafficEstimatorServiceWrapper.rb, line 52
52:         def checkKeywordTraffic(requests)
53:           begin
54:             AdWords::Service.validate_param('requests',
55:                 requests, SOAP::SOAPArray)
56:             # Construct request object and make API call
57:             obj = AdWords::V13::TrafficEstimatorService::CheckKeywordTraffic.new(requests)
58:             return @driver.checkKeywordTraffic(obj)
59:           rescue SOAP::FaultError => fault
60:             raise(AdWords::Error::create_specific_api_error(fault),
61:                 "checkKeywordTraffic Call Failed: " + fault.faultstring.to_s, caller)
62:           end
63:         end
estimateAdGroupList(adGroupRequests)

Calls the estimateAdGroupList method of the TrafficEstimator service. Check the online documentation for this method.

Args:

Returns:

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

    # File lib/adwords4r/v13/TrafficEstimatorServiceWrapper.rb, line 77
77:         def estimateAdGroupList(adGroupRequests)
78:           begin
79:             AdWords::Service.validate_param('adGroupRequests',
80:                 adGroupRequests, SOAP::SOAPArray)
81:             # Construct request object and make API call
82:             obj = AdWords::V13::TrafficEstimatorService::EstimateAdGroupList.new(adGroupRequests)
83:             return @driver.estimateAdGroupList(obj)
84:           rescue SOAP::FaultError => fault
85:             raise(AdWords::Error::create_specific_api_error(fault),
86:                 "estimateAdGroupList Call Failed: " + fault.faultstring.to_s, caller)
87:           end
88:         end
estimateCampaignList(campaignRequests)

Calls the estimateCampaignList method of the TrafficEstimator service. Check the online documentation for this method.

Args:

Returns:

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

     # File lib/adwords4r/v13/TrafficEstimatorServiceWrapper.rb, line 102
102:         def estimateCampaignList(campaignRequests)
103:           begin
104:             AdWords::Service.validate_param('campaignRequests',
105:                 campaignRequests, SOAP::SOAPArray)
106:             # Construct request object and make API call
107:             obj = AdWords::V13::TrafficEstimatorService::EstimateCampaignList.new(campaignRequests)
108:             return @driver.estimateCampaignList(obj)
109:           rescue SOAP::FaultError => fault
110:             raise(AdWords::Error::create_specific_api_error(fault),
111:                 "estimateCampaignList Call Failed: " + fault.faultstring.to_s, caller)
112:           end
113:         end
estimateKeywordList(keywordRequests)

Calls the estimateKeywordList method of the TrafficEstimator service. Check the online documentation for this method.

Args:

Returns:

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

     # File lib/adwords4r/v13/TrafficEstimatorServiceWrapper.rb, line 127
127:         def estimateKeywordList(keywordRequests)
128:           begin
129:             AdWords::Service.validate_param('keywordRequests',
130:                 keywordRequests, SOAP::SOAPArray)
131:             # Construct request object and make API call
132:             obj = AdWords::V13::TrafficEstimatorService::EstimateKeywordList.new(keywordRequests)
133:             return @driver.estimateKeywordList(obj)
134:           rescue SOAP::FaultError => fault
135:             raise(AdWords::Error::create_specific_api_error(fault),
136:                 "estimateKeywordList Call Failed: " + fault.faultstring.to_s, caller)
137:           end
138:         end