upgrade to version 11.12.2

Author: qitia

HISTORY.rst

@@ -1,6 +1,11 @@
 .. :changelog:
 
 Release History
+-----------
+11.12.2(2018-05-15)
++++++++++++++++++++
+*To extend support for [Microsoft Audience Ads](https://docs.microsoft.com/en-us/bingads/guides/audience-ads), new bulk objects are added to the SDK for reading and writing Bulk file records e.g., BulkResponsiveAd and BulkResponsiveAdLabel. 
+*Added retries for the 117 throttling error if encountered while polling for the status of a bulk or reporting operation. 
 
 ---------------
 11.12.1(2018-04-12)

bingads/manifest.py

@@ -1,5 +1,5 @@
 import sys
-VERSION = '11.12.1'
+VERSION = '11.12.2'
 BULK_FORMAT_VERSION_5 = '5.0'
 BULK_FORMAT_VERSION_6 = '6.0'
 WORKING_NAME = 'BingAdsSDKPython'

bingads/util.py

@@ -1,5 +1,6 @@
 import time
 from bingads.exceptions import TimeoutException
+from suds.client import WebFault
 
 class _TimeHelper(object):
     """
@@ -44,4 +45,19 @@ def wait(self):
         if self._status_update_count >= _PollingBlocker.NUMBER_OF_INITIAL_STATUS_CHECKS:
             time.sleep(self._poll_interval_in_milliseconds / 1000.0)
         else:
-            time.sleep(_PollingBlocker.INITIAL_STATUS_CHECK_INTERVAL_IN_MS / 1000.0)
+            time.sleep(_PollingBlocker.INITIAL_STATUS_CHECK_INTERVAL_IN_MS / 1000.0)
+
+
+ratelimit_retry_duration=[15, 20, 25, 30]
+def errorcode_of_exception(ex):
+    if isinstance(ex, WebFault):
+        if hasattr(ex.fault, 'detail') \
+                and hasattr(ex.fault.detail, 'AdApiFaultDetail') \
+                and hasattr(ex.fault.detail.AdApiFaultDetail, 'Errors') \
+                and hasattr(ex.fault.detail.AdApiFaultDetail.Errors, 'AdApiError'):
+            ad_api_errors = ex.fault.detail.AdApiFaultDetail.Errors.AdApiError
+            if type(ad_api_errors) == list:
+                return ad_api_erros[0].Code
+            else:
+                return ad_api_errors.Code
+    return -1

bingads/v11/bulk/bulk_operation.py

@@ -12,7 +12,7 @@
 from .bulk_operation_status import *
 from .bulk_operation_progress_info import *
 from .exceptions import *
-from bingads.util import _PollingBlocker
+from bingads.util import _PollingBlocker, errorcode_of_exception, ratelimit_retry_duration
 from bingads.exceptions import *
 
 from bingads.service_client import ServiceClient
@@ -239,7 +239,7 @@ def get_status(self):
 
         if self.final_status is not None:
             return self.final_status
-        response = self._get_status_with_retry(3)
+        response = self._get_status_with_retry(4)
         headers=self.service_client.hp.get_headers(self.service_client.soap_client.service.GetBulkDownloadStatus)
         self.tracking_id = headers['TrackingId'] if 'TrackingId' in headers else None
         status = BulkOperationStatus(
@@ -265,9 +265,12 @@ def _get_status_with_retry(self, retry_times):
         while retry_times > 1:
             try:
                 return self.service_client.GetBulkDownloadStatus(RequestId=self.request_id)
-            except Exception:
+            except Exception as ex:
                 retry_times -= 1
-                time.sleep(1000)
+                if '117' == errorcode_of_exception(ex):
+                    time.sleep(ratelimit_retry_duration[3 - retry_times])
+                else:
+                    time.sleep(1)
         return self.service_client.GetBulkDownloadStatus(RequestId=self.request_id)
 
 
@@ -335,7 +338,7 @@ def get_status(self):
 
         if self.final_status is not None:
             return self.final_status
-        response = self._get_status_with_retry(3)
+        response = self._get_status_with_retry(4)
         headers=self.service_client.hp.get_headers(self.service_client.soap_client.service.GetBulkUploadStatus)
         self.tracking_id = headers['TrackingId'] if 'TrackingId' in headers else None
         status = BulkOperationStatus(
@@ -359,11 +362,15 @@ def get_status(self):
             self._final_status = status
         return status
 
+    
     def _get_status_with_retry(self, retry_times):
         while retry_times > 1:
             try:
                 return self.service_client.GetBulkUploadStatus(RequestId=self.request_id)
-            except Exception:
+            except Exception as ex:
                 retry_times -= 1
-                time.sleep(1000)
+                if '117' == errorcode_of_exception(ex):
+                    time.sleep(ratelimit_retry_duration[3 - retry_times])
+                else:
+                    time.sleep(1)
         return self.service_client.GetBulkUploadStatus(RequestId=self.request_id)

bingads/v11/bulk/entities/ad_extensions/bulk_site_links_ad_extensions.py

@@ -127,7 +127,7 @@ def order(self, value):
     def site_link(self):
         """ The sitelink.
 
-        See SiteLink at: https://msdn.microsoft.com/en-US/library/jj134381.aspx
+        See SiteLink at: https://docs.microsoft.com/en-us/bingads/campaign-management-service/sitelink?view=bingads-11
         """
 
         return self._site_link

bingads/v11/bulk/entities/audiences/__init__.py

@@ -10,3 +10,6 @@
 from .bulk_in_market_audience import *
 from .bulk_ad_group_in_market_audience_association import *
 from .bulk_ad_group_negative_in_market_audience_association import *
+from .bulk_ad_group_product_audience_association import *
+from .bulk_ad_group_negative_product_audience_association import *
+from .bulk_product_audience import *

bingads/v11/bulk/entities/audiences/bulk_ad_group_negative_product_audience_association.py

@@ -0,0 +1,136 @@
+from bingads.v11.bulk.entities import *
+from bingads.service_client import _CAMPAIGN_OBJECT_FACTORY_V11
+from bingads.v11.internal.bulk.entities.single_record_bulk_entity import _SingleRecordBulkEntity
+from bingads.v11.internal.bulk.mappings import _SimpleBulkMapping
+from bingads.v11.internal.bulk.string_table import _StringTable
+from bingads.v11.internal.extensions import *
+
+
+class BulkAdGroupNegativeProductAudienceAssociation(_SingleRecordBulkEntity):
+    """ Represents an Ad Group Negative Product Audience Association that can be read or written in a bulk file.
+
+    This class exposes the :attr:`negative_ad_group_criterion` property that can be read and written as fields of the
+    Ad Group Negative Product Audience Association record in a bulk file.
+
+    For more information, see Ad Group Negative Product Audience Association at https://go.microsoft.com/fwlink/?linkid=846127.
+
+    *See also:*
+
+    * :class:`.BulkServiceManager`
+    * :class:`.BulkOperation`
+    * :class:`.BulkFileReader`
+    * :class:`.BulkFileWriter`
+    """
+
+    def __init__(self,
+                 negative_ad_group_criterion=None,
+                 campaign_name=None,
+                 ad_group_name=None,
+                 product_audience_name=None):
+        super(BulkAdGroupNegativeProductAudienceAssociation, self).__init__()
+
+        self._negative_ad_group_criterion = negative_ad_group_criterion
+        self._campaign_name = campaign_name
+        self._ad_group_name = ad_group_name
+        self._product_audience_name = product_audience_name
+
+    _MAPPINGS = [
+        _SimpleBulkMapping(
+            _StringTable.Status,
+            field_to_csv=lambda c: bulk_str(c.negative_ad_group_criterion.Status),
+            csv_to_field=lambda c, v: setattr(c.negative_ad_group_criterion, 'Status', v if v else None)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.Id,
+            field_to_csv=lambda c: bulk_str(c.negative_ad_group_criterion.Id),
+            csv_to_field=lambda c, v: setattr(c.negative_ad_group_criterion, 'Id', int(v) if v else None)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.ParentId,
+            field_to_csv=lambda c: bulk_str(c.negative_ad_group_criterion.AdGroupId),
+            csv_to_field=lambda c, v: setattr(c.negative_ad_group_criterion, 'AdGroupId', int(v) if v else None)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.Campaign,
+            field_to_csv=lambda c: c.campaign_name,
+            csv_to_field=lambda c, v: setattr(c, 'campaign_name', v)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.AdGroup,
+            field_to_csv=lambda c: c.ad_group_name,
+            csv_to_field=lambda c, v: setattr(c, 'ad_group_name', v)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.Audience,
+            field_to_csv=lambda c: c.product_audience_name,
+            csv_to_field=lambda c, v: setattr(c, 'product_audience_name', v)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.AudienceId,
+            field_to_csv=lambda c: field_to_csv_CriterionAudienceId(c.negative_ad_group_criterion),
+            csv_to_field=lambda c, v: csv_to_field_CriterionAudienceId(c.negative_ad_group_criterion, int(v) if v else None)
+        ),
+    ]
+
+    @property
+    def negative_ad_group_criterion(self):
+        """ Defines a Negative Ad Group Criterion """
+
+        return self._negative_ad_group_criterion
+
+    @negative_ad_group_criterion.setter
+    def negative_ad_group_criterion(self, negative_ad_group_criterion):
+        self._negative_ad_group_criterion = negative_ad_group_criterion
+
+    @property
+    def campaign_name(self):
+        """ Defines the name of the Campaign.
+
+        :rtype: str
+        """
+
+        return self._campaign_name
+
+    @campaign_name.setter
+    def campaign_name(self, campaign_name):
+        self._campaign_name = campaign_name
+
+    @property
+    def ad_group_name(self):
+        """ Defines the name of the Ad Group
+
+        :rtype: str
+        """
+
+        return self._ad_group_name
+
+    @ad_group_name.setter
+    def ad_group_name(self, ad_group_name):
+        self._ad_group_name = ad_group_name
+
+    @property
+    def product_audience_name(self):
+        """ Defines the name of the Product Audience
+
+        :rtype: str
+        """
+
+        return self._product_audience_name
+
+    @product_audience_name.setter
+    def product_audience_name(self, product_audience_name):
+        self._product_audience_name = product_audience_name
+
+    def process_mappings_from_row_values(self, row_values):
+        self._negative_ad_group_criterion = _CAMPAIGN_OBJECT_FACTORY_V11.create('NegativeAdGroupCriterion')
+        self._negative_ad_group_criterion.Type = 'NegativeAdGroupCriterion'
+        self._negative_ad_group_criterion.Criterion = _CAMPAIGN_OBJECT_FACTORY_V11.create('AudienceCriterion')
+        self._negative_ad_group_criterion.Criterion.Type = 'AudienceCriterion'
+        row_values.convert_to_entity(self, BulkAdGroupNegativeProductAudienceAssociation._MAPPINGS)
+
+    def process_mappings_to_row_values(self, row_values, exclude_readonly_data):
+        self._validate_property_not_null(self.negative_ad_group_criterion, 'negative_ad_group_criterion')
+        self.convert_to_values(row_values, BulkAdGroupNegativeProductAudienceAssociation._MAPPINGS)
+    
+    def read_additional_data(self, stream_reader):
+        super(BulkAdGroupNegativeProductAudienceAssociation, self).read_additional_data(stream_reader)