Fixes issue #'s 6 & 9

Author: msaniscalchi

ChangeLog

@@ -1,3 +1,12 @@
+1.0.5 - 05/07/2014
+* Fixed an issue where PQL fields weren't encoding properly / not handling None
+  responses correctly. This resolves issue #9.
+* Fixed an issue where the AdWords ReportDownloader would fail when downloading
+  gzipped reports. Now better documents the need to use binary files in this
+  case. This resolves issue #6.
+* Fixed an artifact from issue #5, ReportDownloader now sets https_proxy before
+  retrieving the WSDL.
+
 1.0.4 - 04/22/2014
 * Fixed a bug where https_proxy wasn't set for retrieving the API WSDL. This
   resolves issue #5.

examples/dfp/v201403/report_service/run_delivery_report.py

@@ -63,21 +63,21 @@ def main(client, order_id):
     report_job_id = report_downloader.WaitForReport(report_job)
   except errors.DfpReportError, e:
     print 'Failed to generate report. Error was: %s' % e
-  else:
-    # Change to your preferred export format.
-    export_format = 'CSV_DUMP'
 
-    report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
+  # Change to your preferred export format.
+  export_format = 'CSV_DUMP'
 
-    # Download report data.
-    report_downloader.DownloadReportToFile(
-        report_job_id, export_format, report_file)
+  report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
 
-    report_file.close()
+  # Download report data.
+  report_downloader.DownloadReportToFile(
+      report_job_id, export_format, report_file)
 
-    # Display results.
-    print 'Report job with id \'%s\' downloaded to:\n%s' % (
-        report_job['id'], report_file.name)
+  report_file.close()
+
+  # Display results.
+  print 'Report job with id \'%s\' downloaded to:\n%s' % (
+      report_job_id, report_file.name)
 
 if __name__ == '__main__':
   # Initialize client object.

examples/dfp/v201403/report_service/run_inventory_report.py

@@ -69,21 +69,21 @@ def main(client):
     report_job_id = report_downloader.WaitForReport(report_job)
   except errors.DfpReportError, e:
     print 'Failed to generate report. Error was: %s' % e
-  else:
-    # Change to your preferred export format.
-    export_format = 'CSV_DUMP'
 
-    report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
+  # Change to your preferred export format.
+  export_format = 'CSV_DUMP'
 
-    # Download report data.
-    report_downloader.DownloadReportToFile(
-        report_job_id, export_format, report_file)
+  report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
 
-    report_file.close()
+  # Download report data.
+  report_downloader.DownloadReportToFile(
+      report_job_id, export_format, report_file)
 
-    # Display results.
-    print 'Report job with id \'%s\' downloaded to:\n%s' % (
-        report_job['id'], report_file.name)
+  report_file.close()
+
+  # Display results.
+  print 'Report job with id \'%s\' downloaded to:\n%s' % (
+      report_job_id, report_file.name)
 
 if __name__ == '__main__':
   # Initialize client object.

examples/dfp/v201403/report_service/run_merged_delivery_report.py

@@ -48,21 +48,21 @@ def main(client):
     report_job_id = report_downloader.WaitForReport(report_job)
   except errors.DfpReportError, e:
     print 'Failed to generate report. Error was: %s' % e
-  else:
-    # Change to your preferred export format.
-    export_format = 'CSV_DUMP'
 
-    report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
+  # Change to your preferred export format.
+  export_format = 'CSV_DUMP'
 
-    # Download report data.
-    report_downloader.DownloadReportToFile(
-        report_job_id, export_format, report_file)
+  report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
 
-    report_file.close()
+  # Download report data.
+  report_downloader.DownloadReportToFile(
+      report_job_id, export_format, report_file)
 
-    # Display results.
-    print 'Report job with id \'%s\' downloaded to:\n%s' % (
-        report_job['id'], report_file.name)
+  report_file.close()
+
+  # Display results.
+  print 'Report job with id \'%s\' downloaded to:\n%s' % (
+      report_job_id, report_file.name)
 
 if __name__ == '__main__':
   # Initialize client object.

examples/dfp/v201403/report_service/run_reach_report.py

@@ -43,21 +43,21 @@ def main(client):
     report_job_id = report_downloader.WaitForReport(report_job)
   except errors.DfpReportError, e:
     print 'Failed to generate report. Error was: %s' % e
-  else:
-    # Change to your preferred export format.
-    export_format = 'CSV_DUMP'
 
-    report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
+  # Change to your preferred export format.
+  export_format = 'CSV_DUMP'
 
-    # Download report data.
-    report_downloader.DownloadReportToFile(
-        report_job_id, export_format, report_file)
+  report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
 
-    report_file.close()
+  # Download report data.
+  report_downloader.DownloadReportToFile(
+      report_job_id, export_format, report_file)
 
-    # Display results.
-    print 'Report job with id \'%s\' downloaded to:\n%s' % (
-        report_job_id, report_file.name)
+  report_file.close()
+
+  # Display results.
+  print 'Report job with id \'%s\' downloaded to:\n%s' % (
+      report_job_id, report_file.name)
 
 
 if __name__ == '__main__':

examples/dfp/v201403/report_service/run_report_with_custom_fields.py

@@ -85,21 +85,21 @@ def main(client, order_id):
     report_job_id = report_downloader.WaitForReport(report_job)
   except errors.DfpReportError, e:
     print 'Failed to generate report. Error was: %s' % e
-  else:
-    # Change to your preferred export format.
-    export_format = 'CSV_DUMP'
 
-    report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
+  # Change to your preferred export format.
+  export_format = 'CSV_DUMP'
 
-    # Download report data.
-    report_downloader.DownloadReportToFile(
-        report_job_id, export_format, report_file)
+  report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
 
-    report_file.close()
+  # Download report data.
+  report_downloader.DownloadReportToFile(
+      report_job_id, export_format, report_file)
 
-    # Display results.
-    print 'Report job with id \'%s\' downloaded to:\n%s' % (
-        report_job['id'], report_file.name)
+  report_file.close()
+
+  # Display results.
+  print 'Report job with id \'%s\' downloaded to:\n%s' % (
+      report_job_id, report_file.name)
 
 if __name__ == '__main__':
   # Initialize client object.

examples/dfp/v201403/report_service/run_sales_report.py

@@ -45,21 +45,21 @@ def main(client):
     report_job_id = report_downloader.WaitForReport(report_job)
   except errors.DfpReportError, e:
     print 'Failed to generate report. Error was: %s' % e
-  else:
-    # Change to your preferred export format.
-    export_format = 'CSV_DUMP'
 
-    report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
+  # Change to your preferred export format.
+  export_format = 'CSV_DUMP'
 
-    # Download report data.
-    report_downloader.DownloadReportToFile(
-        report_job_id, export_format, report_file)
+  report_file = tempfile.NamedTemporaryFile(suffix='.csv.gz', delete=False)
 
-    report_file.close()
+  # Download report data.
+  report_downloader.DownloadReportToFile(
+      report_job_id, export_format, report_file)
 
-    # Display results.
-    print 'Report job with id \'%s\' downloaded to:\n%s' % (
-        report_job['id'], report_file.name)
+  report_file.close()
+
+  # Display results.
+  print 'Report job with id \'%s\' downloaded to:\n%s' % (
+      report_job_id, report_file.name)
 
 if __name__ == '__main__':
   # Initialize client object.

googleads/adwords.py

@@ -319,11 +319,16 @@ def __init__(self, adwords_client, version=sorted(_SERVICE_MAP.keys())[-1],
     self._end_point = self._END_POINT_FORMAT % (server, version)
     self._header_handler = _AdWordsHeaderHandler(adwords_client, version)
 
+    proxy_option = None
+    if self._adwords_client.https_proxy:
+      proxy_option = {'https': self._adwords_client.https_proxy}
+
     schema_url = self._SCHEMA_FORMAT % (server, version)
     schema = suds.client.Client(
         schema_url,
         doctor=suds.xsd.doctor.ImportDoctor(suds.xsd.doctor.Import(
-            self._namespace, schema_url))).wsdl.schema
+            self._namespace, schema_url)),
+        proxy=proxy_option).wsdl.schema
     self._report_definition_type = schema.elements[
         (self._REPORT_DEFINITION_NAME, self._namespace)]
     self._marshaller = suds.mx.literal.Literal(schema)
@@ -340,16 +345,25 @@ def DownloadReport(self, report_definition, output=sys.stdout,
           that will be downloaded.
       [optional]
       output: A writable object where the contents of the report will be written
-          to.
+          to. If the report is gzip compressed, you need to specify an output
+          that can write binary data.
       return_money_in_micros: A boolean indicating whether money should be
           represented as micros in reports. If None is supplied the AdWords
           server will use its default value, which is currently True.
 
     Raises:
-      An AdWordsReportBadRequestError if the report download fails due to
-      improper input. If the request fails for any other reason (for example,
-      a network error), an AdWordsReportError will be raised instead.
+      AdWordsReportBadRequestError: if the report download fails due to
+          improper input.
+      GoogleAdsValueError: if the user-specified report format is incompatible
+          with the output.
+      AdWordsReportError: if the request fails for any other reason; e.g. a
+          network error.
     """
+    if (report_definition['downloadFormat'].startswith('GZIPPED_')
+        and getattr(output, 'mode', 'w') != 'wb'):
+      raise googleads.errors.GoogleAdsValueError('Need to specify a binary'
+                                                 ' output for GZIPPED formats.')
+
     self._DownloadReport(self._SerializeReportDefinition(report_definition),
                          output, return_money_in_micros)
 
@@ -367,16 +381,25 @@ def DownloadReportWithAwql(self, query, file_format, output=sys.stdout,
           https://developers.google.com/adwords/api/docs/guides/reporting
       [optional]
       output: A writable object where the contents of the report will be written
-          to.
+          to. If the report is gzip compressed, you need to specify an output
+          that can write binary data.
       return_money_in_micros: A boolean indicating whether money should be
           represented as micros in reports. If None is supplied the AdWords
           server will use its default value, which is currently True.
 
     Raises:
-      An AdWordsReportBadRequestError if the report download fails due to
-      improper input. If the request fails for any other reason (for example,
-      a network error), an AdWordsReportError will be raised instead.
+      AdWordsReportBadRequestError: if the report download fails due to
+          improper input.
+      GoogleAdsValueError: if the user-specified report format is incompatible
+          with the output.
+      AdWordsReportError: if the request fails for any other reason; e.g. a
+          network error.
     """
+    if (file_format.startswith('GZIPPED_')
+        and getattr(output, 'mode', 'w') != 'wb'):
+      raise googleads.errors.GoogleAdsValueError('Need to specify a binary'
+                                                 ' output for GZIPPED formats.')
+
     self._DownloadReport(self._SerializeAwql(query, file_format), output,
                          return_money_in_micros)
 
@@ -393,11 +416,12 @@ def _DownloadReport(self, post_body, output, return_money_in_micros):
           server will use its default value, which is currently True.
 
     Raises:
-      An AdWordsReportBadRequestError if the report download fails due to
-      improper input. If the HTTP request fails with any other status code, an
-      AdWordsReportError will be raised instead. In the event of certain other
-      failures, a urllib2.URLError (Python 2) or urllib.error.URLError
-      (Python 3) will be raised.
+      AdWordsReportBadRequestError: if the report download fails due to
+        improper input. In the event of certain other failures, a
+        urllib2.URLError (Python 2) or urllib.error.URLError (Python 3) will be
+        raised.
+      AdWordsReportError: if the request fails for any other reason; e.g. a
+          network error.
     """
     if sys.version_info[0] == 3:
       post_body = bytes(post_body, 'utf8')
@@ -414,7 +438,8 @@ def _DownloadReport(self, post_body, output, return_money_in_micros):
       while True:
         chunk = response.read(_CHUNK_SIZE)
         if not chunk: break
-        output.write(chunk.decode() if sys.version_info[0] == 3 else chunk)
+        output.write(chunk.decode() if sys.version_info[0] == 3
+                     and getattr(output, 'mode', 'w') == 'w' else chunk)
 
   def _SerializeAwql(self, query, file_format):
     """Serializes an AWQL query and file format for transport.

googleads/common.py

@@ -26,7 +26,7 @@
 import googleads.errors
 import googleads.oauth2
 
-VERSION = '1.0.4'
+VERSION = '1.0.5'
 _COMMON_LIB_SIG = 'googleads/%s' % VERSION
 _PYTHON_VERSION = 'Python/%d.%d' % (sys.version_info[0], sys.version_info[1])
 

googleads/dfp.py

@@ -375,18 +375,21 @@ def _ConvertValueForCsv(self, pql_value):
     """
     field = pql_value['value']
 
-    if pql_value['Value.Type'] == 'TextValue':
-      return field
-    elif pql_value['Value.Type'] == 'NumberValue':
-      return float(field) if '.' in field else int(field)
-    elif pql_value['Value.Type'] == 'DateTimeValue':
-      return self._ConvertDateTimeToOffset(field)
-    elif pql_value['Value.Type'] == 'DateValue':
-      return datetime.date(int(field['date']['year']),
-                           int(field['date']['month']),
-                           int(field['date']['day'])).isoformat()
+    if field:
+      if pql_value['Value.Type'] == 'TextValue':
+        return field.encode('UTF8')
+      elif pql_value['Value.Type'] == 'NumberValue':
+        return float(field) if '.' in field else int(field)
+      elif pql_value['Value.Type'] == 'DateTimeValue':
+        return self._ConvertDateTimeToOffset(field)
+      elif pql_value['Value.Type'] == 'DateValue':
+        return datetime.date(int(field['date']['year']),
+                             int(field['date']['month']),
+                             int(field['date']['day'])).isoformat()
+      else:
+        return field
     else:
-      return field
+      return '-'
 
   def _PageThroughPqlSet(self, pql_query, output_function, values):
     """Pages through a pql_query and performs an action (output_function).