summaryrefslogtreecommitdiffstats
path: root/aw_api/ReportService.py
blob: 419c3c788f9a75f168766c562619d5a6451363ae (plain) (blame)
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
#!/usr/bin/python
# -*- coding: UTF-8 -*-
#
# 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 ReportService service."""

__author__ = 'api.sgrinberg@gmail.com (Stan Grinberg)'

import gzip
import time
import urllib
# Is this running on Google's App Engine?
try:
  import google.appengine
  from _xmlplus.dom import minidom
except:
  from xml.dom import minidom
import StringIO

from aw_api import SanityCheck as glob_sanity_check
from aw_api import SOAPPY
from aw_api import ZSI
from aw_api import Utils
from aw_api.Errors import Error
from aw_api.Errors import ValidationError
from aw_api.WebService import WebService


class ReportService(object):

  """Wrapper for ReportService.

  The Report Service allows you to request a report about the performance of
  your AdWords campaigns.
  """

  def __init__(self, headers, config, op_config, lock, logger):
    """Inits ReportService.

    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
    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 DeleteReport(self, report_job_id):
    """Delete a report job along with the report it produced, if any.

    Args:
      report_job_id: str ID of the report job.

        Ex:
          report_job_id = '1234567890'
    """
    glob_sanity_check.ValidateTypes(((report_job_id, (str, unicode)),))

    method_name = 'deleteReport'
    if self.__config['soap_lib'] == SOAPPY:
      report_job_id = self.__sanity_check.UnType(report_job_id)
      self.__service.CallMethod(method_name, (report_job_id))
    elif self.__config['soap_lib'] == ZSI:
      web_services = self.__web_services
      request = eval('web_services.%sRequest()' % method_name)
      self.__service.CallMethod(method_name,
                                (({'reportJobId': report_job_id},)),
                                'Report', self.__loc, request)

  def GetAllJobs(self):
    """Return an array consisting of all jobs the user has scheduled.

    Returns:
      tuple response from the API method.
    """
    method_name = 'getAllJobs'
    if self.__config['soap_lib'] == SOAPPY:
      return self.__service.CallMethod(method_name, ())
    elif self.__config['soap_lib'] == ZSI:
      web_services = self.__web_services
      request = eval('web_services.%sRequest()' % method_name)
      return self.__service.CallMethod(method_name, (), 'Report', self.__loc,
                                       request)

  def GetGzipReportDownloadUrl(self, report_job_id):
    """Return a URL for a compressed report.

    URL from which a compressed report with the given job ID can be downloaded
    (in Gzip format).

    Args:
      report_job_id: str ID of the report job.

        Ex:
          report_job_id = '1234567890'

    Returns:
      tuple response from the API method.
    """
    glob_sanity_check.ValidateTypes(((report_job_id, (str, unicode)),))

    method_name = 'getGzipReportDownloadUrl'
    if self.__config['soap_lib'] == SOAPPY:
      report_job_id = self.__sanity_check.UnType(report_job_id)
      return self.__service.CallMethod(method_name, (report_job_id))
    elif self.__config['soap_lib'] == ZSI:
      web_services = self.__web_services
      request = eval('web_services.%sRequest()' % method_name)
      return self.__service.CallMethod(method_name,
                                       (({'reportJobId': report_job_id},)),
                                       'Report', self.__loc, request)

  def GetReportDownloadUrl(self, report_job_id):
    """Return a URL for a report.

    URL from which the report with the given job ID can be downloaded.

    Args:
      report_job_id: str ID of the report job.

        Ex:
          report_job_id = '1234567890'

    Returns:
      tuple response from the API method.
    """
    glob_sanity_check.ValidateTypes(((report_job_id, (str, unicode)),))

    method_name = 'getReportDownloadUrl'
    if self.__config['soap_lib'] == SOAPPY:
      report_job_id = self.__sanity_check.UnType(report_job_id)
      return self.__service.CallMethod(method_name, (report_job_id))
    elif self.__config['soap_lib'] == ZSI:
      web_services = self.__web_services
      request = eval('web_services.%sRequest()' % method_name)
      return self.__service.CallMethod(method_name,
                                       (({'reportJobId': report_job_id},)),
                                       'Report', self.__loc, request)

  def GetReportJobStatus(self, report_job_id):
    """Return the status of the report job with the given report job ID.

    Args:
      report_job_id: str ID of the report job.

        Ex:
          report_job_id = '1234567890'

    Returns:
      tuple response from the API method.
    """
    glob_sanity_check.ValidateTypes(((report_job_id, (str, unicode)),))

    method_name = 'getReportJobStatus'
    if self.__config['soap_lib'] == SOAPPY:
      report_job_id = self.__sanity_check.UnType(report_job_id)
      return self.__service.CallMethod(method_name, (report_job_id))
    elif self.__config['soap_lib'] == ZSI:
      web_services = self.__web_services
      request = eval('web_services.%sRequest()' % method_name)
      return self.__service.CallMethod(method_name,
                                       (({'reportJobId': report_job_id},)),
                                       'Report', self.__loc, request)

  def ScheduleDefinedReportJob(self, job):
    """Schedule a defined report job for execution.

    Args:
      job: dict report job object that defines the options for the report.

        Ex:
          job = {
            'adWordsType': 'SearchOnly',
            'aggregationTypes': ['Daily'],
            'campaigns': ['1234567890'],
            'campaignStatuses': ['Active', 'Paused'],
            'clientEmails': ['johndoe@example.com'],
            'crossClient': 'False',
            'endDay': '2007-11-30',
            'includeZeroImpression': 'False',
            'name': 'Test Report',
            'selectedColumns': ['Campaign', 'CampaignId', 'CPC', 'CTR'],
            'selectedReportType': 'Campaign',
            'startDay': '2007-11-01',
          }

    Returns:
      tuple response from the API method.
    """
    glob_sanity_check.ValidateTypes(((job, dict),))

    method_name = 'scheduleReportJob'
    if self.__config['soap_lib'] == SOAPPY:
      name_space = '/'.join([self.__name_space, self.__op_config['version'],
                             self.__config['access']]).strip('/')
      job = self.__sanity_check.ValidateDefinedReportJobV13(job, name_space)
      return self.__service.CallMethod(method_name, (job))
    elif self.__config['soap_lib'] == ZSI:
      web_services = self.__web_services
      job = self.__sanity_check.ValidateDefinedReportJobV13(job, web_services)
      request = eval('web_services.%sRequest()' % method_name)
      return self.__service.CallMethod(method_name, (({'job': job},)),
                                       'Report', self.__loc, request)

  def ValidateReportJob(self, job):
    """This method takes a ReportJob and runs the validation logic against it.

    Args:
      job: dict report job object that defines the options for the report.

        Ex:
          job = {
            'adWordsType': 'SearchOnly',
            'aggregationTypes': ['Daily'],
            'campaigns': ['1234567890'],
            'campaignStatuses': ['Active', 'Paused'],
            'clientEmails': ['johndoe@example.com'],
            'crossClient': 'False',
            'endDay': '2007-11-30',
            'includeZeroImpression': 'False',
            'name': 'Test Report',
            'selectedColumns': ['Campaign', 'CampaignId', 'CPC', 'CTR'],
            'selectedReportType': 'Campaign',
            'startDay': '2007-11-01',
          }
    """
    glob_sanity_check.ValidateTypes(((job, dict),))

    method_name = 'validateReportJob'
    if self.__config['soap_lib'] == SOAPPY:
      name_space = '/'.join([self.__name_space, self.__op_config['version'],
                             self.__config['access']]).strip('/')
      job = self.__sanity_check.ValidateDefinedReportJobV13(job, name_space)
      self.__service.CallMethod(method_name, (job))
    elif self.__config['soap_lib'] == ZSI:
      web_services = self.__web_services
      job = self.__sanity_check.ValidateDefinedReportJobV13(job, web_services)
      request = eval('web_services.%sRequest()' % method_name)
      self.__service.CallMethod(method_name, (({'job': job},)), 'Report',
                                self.__loc, request)

  def DownloadXmlReport(self, report_job_id):
    """Download and return report data in XML format.

    Args:
      report_job_id: str ID of the report job.

        Ex:
          report_job_id = '1234567890'

    Returns:
      str report data or None if report failed.
    """
    glob_sanity_check.ValidateTypes(((report_job_id, (str, unicode)),))

    # Wait for report to finish.
    status = self.GetReportJobStatus(report_job_id)[0]
    while status != 'Completed' and status != 'Failed':
      if Utils.BoolTypeConvert(self.__config['debug']):
        print 'Report job status: %s' % status
      time.sleep(30)
      status = self.GetReportJobStatus(report_job_id)[0]

    if status == 'Failed':
      if Utils.BoolTypeConvert(self.__config['debug']):
        print 'Report process failed'
        return None

    if Utils.BoolTypeConvert(self.__config['debug']):
      print 'Report has completed successfully'

    # Download report.
    report_url = self.GetGzipReportDownloadUrl(report_job_id)[0]

    # Convert report into readable XML format.
    report_xml = urllib.urlopen(report_url).read()
    report_xml = gzip.GzipFile(fileobj=StringIO.StringIO(report_xml)).read()

    return report_xml

  def DownloadCsvReport(self, report_job_id, report_xml=''):
    """Download and return report data in CSV format.

    Args:
      report_job_id: str ID of the report job.
      report_xml: str Report in XML format. Used for testing and debugging.

        Ex:
          report_job_id = '1234567890'
          report_xml = '<report><table><columns>...</columns></table></report>'

    Returns:
      str report data if all data is in ASCII.
      unicode report data if report contains non-ASCII characters.
      None if report failed.
    """
    # Get XML report data.
    if not report_xml:
      report_xml = self.DownloadXmlReport(report_job_id)
    if report_xml is None:
      return None

    # Prepare XML for DOM construction.
    #
    # Report consists of two parts: table and totals. Table contains column
    # names and rows of data. The outgoing CSV will contain only columns and
    # data rows. The totals are not included, but can be easily calculated
    # from the CSV data.
    report_xml = report_xml.replace('<?xml version="1.0" standalone="yes"?>',
                                    '')

    items = []
    try:
      # Construct DOM object.
      dom = minidom.parseString(report_xml)

      # Get data columns.
      columns = []
      column_dom = dom.getElementsByTagName('column')
      for column_item in column_dom:
        if column_item.hasAttributes():
          columns.append(column_item.attributes.item(0).value)

      # Get data rows.
      rows = []
      row_dom = dom.getElementsByTagName('row')
      for row_item in row_dom:
        if row_item.hasAttributes():
          attrs = row_item.attributes
          row = {}
          for index in range(attrs.length):
            row[attrs.item(index).name] = attrs.item(index).value
          rows.append(row)

      # Combine columns and rows into CSV format.
      for column in columns:
        items.append('%s,' % column)
      items = [''.join(items).rstrip(','), '\n']
      for row in rows:
        sub_items = []
        for column in columns:
          sub_items.append('%s,' % row[column])
        items.append('%s\n' %  ''.join(sub_items).rstrip(','))
    except:
      msg = ('Unable to parse report\'s data. Please, file a bug at '
             'http://code.google.com/p/google-api-adwords-python-lib/'
             'issues/list.')
      raise Error(msg)

    # A workaround for reports that include non-ASCII characters (i.e. ø).
    try:
      report_csv = str(''.join(items))
    except (UnicodeEncodeError, Exception):
      report_csv = unicode(''.join(items))
    return report_csv