update to version 12.0.3

Author: qitia

HISTORY.rst

@@ -2,6 +2,15 @@
 
 Release History
 -----------
+12.0.3(2019-01-10)
++++++++++++++++++++
+* BREAKING CHANGE for BulkAdGroupCustomAudienceAssociation, BulkAdGroupInMarketAudienceAssociation, BulkAdGroupNegativeCustomAudienceAssociation, BulkAdGroupNegativeInMarketAudienceAssociation, BulkAdGroupNegativeProductAudienceAssociation, BulkAdGroupNegativeRemarketingListAssociation, BulkAdGroupNegativeSimilarRemarketingListAssociation, BulkAdGroupProductAudienceAssociation, BulkAdGroupRemarketingListAssociation, and BulkAdGroupSimilarRemarketingListAssociation: Replaced custom_audience_name, in_market_audience_name, product_audience_name, remarketing_list_name, and similar_remarketing_list_name with audience_name. The audience_name property is now used to map from the 'Audience Name' field of a Bulk file via all audience association SDK objects. 
+* Updated service proxies to reflect recent interface changes. For details please see the release notes: https://docs.microsoft.com/en-us/bingads/guides/release-notes.
+* Added Bulk mapping for responsive ad images i.e., added Images to the existing BulkResponsiveAd.
+* Added Bulk mapping for campaign target setting i.e., added TargetSetting to the existing BulkCampaign.
+* Added Bulk mapping for campaign level audience associations i.e.,BulkCampaignCustomAudienceAssociation, BulkCampaignInMarketAudienceAssociation, BulkCampaignNegativeCustomAudienceAssociation, BulkCampaignNegativeInMarketAudienceAssociation, BulkCampaignNegativeProductAudienceAssociation, BulkCampaignNegativeRemarketingListAssociation, BulkCampaignNegativeSimilarRemarketingListAssociation, BulkCampaignProductAudienceAssociation, BulkCampaignRemarketingListAssociation, and BulkCampaignSimilarRemarketingListAssociation. 
+* Added the get_response_header method in class ServiceClient, to access the service TrackingId, etc per GitHub issue https://github.com/BingAds/BingAds-Python-SDK/issues/106. 
+
 12.0.2(2018-12-10)
 +++++++++++++++++++
 *Updated service proxies to reflect recent interface changes. For details please see the Bing Ads API Release Notes: https://docs.microsoft.com/en-us/bingads/guides/release-notes.

bingads/headerplugin.py

@@ -7,22 +7,13 @@ def __init__(self):
     def parsed(self, context):
         self.document = context.reply
 
-    def get_headers(self, method):
-        Result = {}
-        method = method.method
-        binding = method.binding.output
-        SHeaderElem = binding.headpart_types(method, False)
-
+    def get_response_header(self):
+        result = {}
         envns = ('SOAP-ENV', 'http://schemas.xmlsoap.org/soap/envelope/')
         soapenv = self.document.getChild('Envelope', envns)
         soapheaders = soapenv.getChild('Header', envns)
         SHeaderNodes = soapheaders.children
 
-        for Elem in SHeaderElem:
-            for Node in SHeaderNodes:
-                if(Node.name == Elem.name):
-                    ElemRes = Elem.resolve(nobuiltin=True)
-                    NodeRes = binding.unmarshaller().process(Node, ElemRes)
-                    Result[Elem.name] = NodeRes
-        return Result
-    #
+        for Node in SHeaderNodes:
+            result[Node.name] = Node.text
+        return result

bingads/manifest.py

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

bingads/service_client.py

@@ -52,6 +52,9 @@ def __getattr__(self, name):
 
         self.set_options(**self._options)
         return _ServiceCall(self, name)
+    
+    def get_response_header(self):
+        return self.hp.get_response_header()
 
     def set_options(self, **kwargs):
         """ Set suds options, these options will be passed to suds.

bingads/v12/bulk/bulk_operation.py

@@ -240,7 +240,7 @@ def get_status(self):
         if self.final_status is not None:
             return self.final_status
         response = self._get_status_with_retry(4)
-        headers=self.service_client.hp.get_headers(self.service_client.soap_client.service.GetBulkDownloadStatus)
+        headers = self.service_client.get_response_header()
         self.tracking_id = headers['TrackingId'] if 'TrackingId' in headers else None
         status = BulkOperationStatus(
             status=response.RequestStatus,
@@ -339,7 +339,7 @@ def get_status(self):
         if self.final_status is not None:
             return self.final_status
         response = self._get_status_with_retry(4)
-        headers=self.service_client.hp.get_headers(self.service_client.soap_client.service.GetBulkUploadStatus)
+        headers = self.service_client.get_response_header()
         self.tracking_id = headers['TrackingId'] if 'TrackingId' in headers else None
         status = BulkOperationStatus(
             status=response.RequestStatus,

bingads/v12/bulk/bulk_service_manager.py

@@ -202,7 +202,7 @@ def submit_download(self, submit_download_parameters):
                 LastSyncTimeInUTC=last_sync_time_in_utc,
                 PerformanceStatsDateRange=performance_stats_date_range,
             )
-            headers=self.service_client.hp.get_headers(self.service_client.soap_client.service.DownloadCampaignsByAccountIds)
+            headers = self.service_client.get_response_header()
         else:
             response = self.service_client.DownloadCampaignsByCampaignIds(
                 Campaigns={
@@ -218,7 +218,7 @@ def submit_download(self, submit_download_parameters):
                 LastSyncTimeInUTC=last_sync_time_in_utc,
                 PerformanceStatsDateRange=performance_stats_date_range,
             )
-            headers=self.service_client.hp.get_headers(self.service_client.soap_client.service.DownloadCampaignsByCampaignIds)
+            headers = self.service_client.get_response_header()
         operation = BulkDownloadOperation(
             request_id=response,
             authorization_data=self._authorization_data,
@@ -242,7 +242,7 @@ def submit_upload(self, submit_upload_parameters):
             AccountId=self._authorization_data.account_id,
             ResponseMode=submit_upload_parameters.response_mode,
         )
-        headers=self.service_client.hp.get_headers(self.service_client.soap_client.service.GetBulkUploadUrl)
+        headers = self.service_client.get_response_header()
         request_id = response.RequestId
         upload_url = response.UploadUrl
 

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

@@ -2,17 +2,31 @@
 __email__ = '[email protected]'
 
 from .bulk_remarketing_list import *
-from .bulk_ad_group_remarketing_list_association import *
-from .bulk_ad_group_negative_remarketing_list_association import *
 from .bulk_custom_audience import *
 from .bulk_ad_group_custom_audience_association import *
-from .bulk_ad_group_negative_custom_audience_association import *
 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_ad_group_negative_in_market_audience_association import *
+from .bulk_ad_group_negative_custom_audience_association import *
+from .bulk_ad_group_negative_remarketing_list_association import *
+from .bulk_ad_group_negative_similar_remarketing_list_association import *
+from .bulk_ad_group_remarketing_list_association import *
 from .bulk_product_audience import *
 from .bulk_similar_remarketing_list import *
 from .bulk_ad_group_similar_remarketing_list_association import *
-from .bulk_ad_group_negative_similar_remarketing_list_association import *
+from .bulk_ad_group_audience_association import *
+from .bulk_ad_group_negative_audience_association import *
+from .bulk_campaign_audience_association import *
+from .bulk_campaign_custom_audience_association import *
+from .bulk_campaign_in_market_audience_association import *
+from .bulk_campaign_product_audience_association import *
+from .bulk_campaign_remarketing_list_association import *
+from .bulk_campaign_similar_remarketing_list_association import *
+from .bulk_campaign_negative_audience_association import *
+from .bulk_campaign_negative_remarketing_list_association import *
+from .bulk_campaign_negative_custom_audience_association import *
+from .bulk_campaign_negative_in_market_audience_association import *
+from .bulk_campaign_negative_product_audience_association import *
+from .bulk_campaign_negative_similar_remarketing_list_association import *

bingads/v12/bulk/entities/audiences/bulk_ad_group_audience_association.py

@@ -0,0 +1,148 @@
+from bingads.v12.bulk.entities import *
+from bingads.service_client import _CAMPAIGN_OBJECT_FACTORY_V12
+from bingads.v12.internal.bulk.entities.single_record_bulk_entity import _SingleRecordBulkEntity
+from bingads.v12.internal.bulk.mappings import _SimpleBulkMapping
+from bingads.v12.internal.bulk.string_table import _StringTable
+from bingads.v12.internal.extensions import *
+
+
+class BulkAdGroupAudienceAssociation(_SingleRecordBulkEntity):
+    """ Base class for all Ad Group Audience Association subclasses that can be read or written in a bulk file.
+
+    *See also:*
+
+    * :class:`.BulkAdGroupCustomAudienceAssociation`
+    * :class:`.BulkAdGroupInMarketAudienceAssociation`
+    * :class:`.BulkAdGroupProductAudienceAssociation`
+    * :class:`.BulkAdGroupRemarketingListAssociation`
+    * :class:`.BulkAdGroupSimilarRemarketingListAssociation`
+    """
+
+    def __init__(self,
+                 biddable_ad_group_criterion=None,
+                 campaign_name=None,
+                 ad_group_name=None,
+                 audience_name=None):
+        super(BulkAdGroupAudienceAssociation, self).__init__()
+
+        self._biddable_ad_group_criterion = biddable_ad_group_criterion
+        self._campaign_name = campaign_name
+        self._ad_group_name = ad_group_name
+        self._audience_name = audience_name
+        self._performance_data = None
+
+    _MAPPINGS = [
+        _SimpleBulkMapping(
+            _StringTable.Status,
+            field_to_csv=lambda c: bulk_str(c.biddable_ad_group_criterion.Status),
+            csv_to_field=lambda c, v: setattr(c.biddable_ad_group_criterion, 'Status', v if v else None)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.Id,
+            field_to_csv=lambda c: bulk_str(c.biddable_ad_group_criterion.Id),
+            csv_to_field=lambda c, v: setattr(c.biddable_ad_group_criterion, 'Id', int(v) if v else None)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.ParentId,
+            field_to_csv=lambda c: bulk_str(c.biddable_ad_group_criterion.AdGroupId),
+            csv_to_field=lambda c, v: setattr(c.biddable_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.audience_name,
+            csv_to_field=lambda c, v: setattr(c, 'audience_name', v)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.BidAdjustment,
+            field_to_csv=lambda c: field_to_csv_BidAdjustment(c.biddable_ad_group_criterion),
+            csv_to_field=lambda c, v: csv_to_field_BidAdjustment(c.biddable_ad_group_criterion, float(v) if v else None)
+        ),
+        _SimpleBulkMapping(
+            _StringTable.AudienceId,
+            field_to_csv=lambda c: field_to_csv_CriterionAudienceId(c.biddable_ad_group_criterion),
+            csv_to_field=lambda c, v: csv_to_field_CriterionAudienceId(c.biddable_ad_group_criterion, int(v) if v else None)
+        ),
+    ]
+
+    @property
+    def biddable_ad_group_criterion(self):
+        """ Defines a Biddable Ad Group Criterion """
+
+        return self._biddable_ad_group_criterion
+
+    @biddable_ad_group_criterion.setter
+    def biddable_ad_group_criterion(self, biddable_ad_group_criterion):
+        self._biddable_ad_group_criterion = biddable_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 audience_name(self):
+        """ Defines the name of the Audience
+
+        :rtype: str
+        """
+
+        return self._audience_name
+
+    @audience_name.setter
+    def audience_name(self, audience_name):
+        self._audience_name = audience_name
+
+    @property
+    def performance_data(self):
+        return self._performance_data
+
+    def process_mappings_from_row_values(self, row_values):
+        self._biddable_ad_group_criterion = _CAMPAIGN_OBJECT_FACTORY_V12.create('BiddableAdGroupCriterion')
+        self._biddable_ad_group_criterion.Type = 'BiddableAdGroupCriterion'
+        self._biddable_ad_group_criterion.Criterion = _CAMPAIGN_OBJECT_FACTORY_V12.create('AudienceCriterion')
+        self._biddable_ad_group_criterion.Criterion.Type = 'AudienceCriterion'
+        self._biddable_ad_group_criterion.CriterionBid = _CAMPAIGN_OBJECT_FACTORY_V12.create('BidMultiplier')
+        self._biddable_ad_group_criterion.CriterionBid.Type = 'BidMultiplier'
+        row_values.convert_to_entity(self, BulkAdGroupAudienceAssociation._MAPPINGS)
+
+        self._performance_data = PerformanceData.read_from_row_values_or_null(row_values)
+
+    def process_mappings_to_row_values(self, row_values, exclude_readonly_data):
+        self._validate_property_not_null(self.biddable_ad_group_criterion, 'biddable_ad_group_criterion')
+        self.convert_to_values(row_values, BulkAdGroupAudienceAssociation._MAPPINGS)
+
+        PerformanceData.write_to_row_values_if_not_null(self._performance_data, row_values)
+    
+    def read_additional_data(self, stream_reader):
+        super(BulkAdGroupAudienceAssociation, self).read_additional_data(stream_reader)