1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
#!/usr/bin/python
#
# Copyright 2009 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""Methods to access TrafficEstimatorService service."""
__author__ = 'api.sgrinberg@gmail.com (Stan Grinberg)'
from aw_api import SanityCheck as glob_sanity_check
from aw_api import SOAPPY
from aw_api import ZSI
from aw_api.Errors import ValidationError
from aw_api.WebService import WebService
class TrafficEstimatorService(object):
"""Wrapper for TrafficEstimatorService.
The Traffic Estimator Service provides operations for estimating keyword
traffic, campaign traffic, and ad group traffic.
"""
def __init__(self, headers, config, op_config, lock, logger):
"""Inits TrafficEstimatorService.
Args:
headers: dict dictionary object with populated authentication
credentials.
config: dict dictionary object with populated configuration values.
op_config: dict dictionary object with additional configuration values for
this operation.
lock: thread.lock the thread lock
logger: Logger the instance of Logger
"""
url = [op_config['server'], 'api/adwords', op_config['version'],
self.__class__.__name__]
if config['access']: url.insert(len(url) - 1, config['access'])
self.__service = WebService(headers, config, op_config, '/'.join(url), lock,
logger)
self.__config = config
self.__op_config = op_config
self.__name_space = 'https://adwords.google.com/api/adwords'
if self.__config['soap_lib'] == SOAPPY:
from aw_api.soappy_toolkit import SanityCheck
self.__web_services = None
elif self.__config['soap_lib'] == ZSI:
from aw_api import API_VERSIONS
from aw_api.zsi_toolkit import SanityCheck
if op_config['version'] in API_VERSIONS:
module = '%s_services' % self.__class__.__name__
try:
web_services = __import__('aw_api.zsi_toolkit.%s.%s'
% (op_config['version'], module), globals(),
locals(), [''])
except ImportError, e:
# If one of library's required modules is missing, re raise exception.
if str(e).find(module) < 0:
raise ImportError(e)
msg = ('The version \'%s\' is not compatible with \'%s\'.'
% (op_config['version'], self.__class__.__name__))
raise ValidationError(msg)
else:
msg = 'Invalid API version, not one of %s.' % str(list(API_VERSIONS))
raise ValidationError(msg)
self.__web_services = web_services
self.__loc = eval('web_services.%sLocator()' % self.__class__.__name__)
self.__sanity_check = SanityCheck
def CheckKeywordTraffic(self, requests):
"""Check a batch of keywords to see whether they will get any traffic.
Args:
requests: list requests for keyword traffic checks.
Ex:
requests = [
{
'keywordText': 'Flowers',
'keywordType': 'Broad',
'language': 'en'
}
]
Returns:
tuple response from the API method.
"""
glob_sanity_check.ValidateTypes(((requests, list),))
for item in requests:
self.__sanity_check.ValidateKeywordTrafficRequestV13(item)
method_name = 'checkKeywordTraffic'
if self.__config['soap_lib'] == SOAPPY:
return self.__service.CallMethod(method_name, (requests))
elif self.__config['soap_lib'] == ZSI:
web_services = self.__web_services
request = eval('web_services.%sRequest()' % method_name)
return self.__service.CallMethod(method_name, (({'requests': requests},)),
'TrafficEstimator', self.__loc, request)
def EstimateAdGroupList(self, requests):
"""Return traffic estimates for the requested set.
Set is of new or existing ad groups.
Args:
requests: list set of ad groups to estimate.
Ex:
requests = [
{
'id': '1234567890',
'keywordRequests': [
{
'id': '1234567890',
'maxCpc': '1000000',
'negative': 'False',
'text': 'Flowers',
'type': 'Broad'
}
],
'maxCpc': '1000000'
}
]
Returns:
tuple response from the API method.
"""
glob_sanity_check.ValidateTypes(((requests, list),))
method_name = 'estimateAdGroupList'
if self.__config['soap_lib'] == SOAPPY:
items = []
for item in requests:
items.append(self.__sanity_check.ValidateAdGroupRequestV13(item))
requests = self.__sanity_check.UnType(''.join(items))
name_space = '/'.join([self.__name_space, self.__op_config['version'],
self.__config['access']]).strip('/')
requests._setAttr('xmlns:impl', name_space)
requests._setAttr('xsi3:type', 'AdGroupRequests')
return self.__service.CallMethod(method_name, (requests))
elif self.__config['soap_lib'] == ZSI:
web_services = self.__web_services
for item in requests:
self.__sanity_check.ValidateAdGroupRequestV13(item)
request = eval('web_services.%sRequest()' % method_name)
return self.__service.CallMethod(method_name,
(({'adGroupRequests': requests},)),
'TrafficEstimator', self.__loc, request)
def EstimateCampaignList(self, requests):
"""Return traffic estimates for the requested set of campaigns.
Args:
requests: list set of campaigns to estimate.
Ex:
requests = [
{
'adGroupRequests': [
{
'id': '1234567890',
'keywordRequests': [
{
'id': '1234567890',
'maxCpc': '1000000',
'negative': 'False',
'text': 'Flowers',
'type': 'Broad'
}
],
'maxCpc': '1000000'
}
],
'geoTargeting': {
'cityTargets': ['New York, NY US'],
'countryTargets': ['US'],
'metroTargets': ['501'],
'proximityTargets': [
{
'latitudeMicroDegrees': '12345',
'longitudeMicroDegrees': '12345',
'radiusMeters': '5'
}
],
'regionsTargets': ['US-NY'],
'targetAll': 'False'
},
'id': '1234567890',
'languageTargeting': ['en'],
'networkTargeting': ['GoogleSearch', 'SearchNetwork']
}
]
Returns:
tuple response from the API method.
"""
glob_sanity_check.ValidateTypes(((requests, list),))
method_name = 'estimateCampaignList'
if self.__config['soap_lib'] == SOAPPY:
items = []
for item in requests:
items.append(self.__sanity_check.ValidateCampaignRequestV13(item))
requests = self.__sanity_check.UnType(''.join(items))
name_space = '/'.join([self.__name_space, self.__op_config['version'],
self.__config['access']]).strip('/')
requests._setAttr('xmlns:impl', name_space)
requests._setAttr('xsi3:type', 'CampaignRequests')
return self.__service.CallMethod(method_name, (requests))
elif self.__config['soap_lib'] == ZSI:
web_services = self.__web_services
for item in requests:
self.__sanity_check.ValidateCampaignRequestV13(item)
request = eval('web_services.%sRequest()' % method_name)
return self.__service.CallMethod(method_name,
(({'campaignRequests': requests},)),
'TrafficEstimator', self.__loc, request)
def EstimateKeywordList(self, requests):
"""Return traffic estimates for the requested set of new keywords.
Args:
requests: list set of keywords to estimate.
Ex:
requests = [
{
'id': '1234567890',
'maxCpc': '1000000',
'negative': 'False',
'text': 'Flowers',
'type': 'Broad'
}
]
Returns:
tuple response from the API method.
"""
glob_sanity_check.ValidateTypes(((requests, list),))
method_name = 'estimateKeywordList'
if self.__config['soap_lib'] == SOAPPY:
new_data = []
for item in requests:
new_data.append(self.__sanity_check.UnType(
self.__sanity_check.ValidateKeywordRequestV13(item)))
return self.__service.CallMethod(method_name, (new_data))
elif self.__config['soap_lib'] == ZSI:
web_services = self.__web_services
for item in requests:
self.__sanity_check.ValidateKeywordRequestV13(item)
request = eval('web_services.%sRequest()' % method_name)
return self.__service.CallMethod(method_name,
(({'keywordRequests': requests},)),
'TrafficEstimator', self.__loc, request)
|
