logos-sdk 0.0.25.dev12__tar.gz → 0.0.25.dev13__tar.gz

{logos_sdk-0.0.25.dev12 → logos_sdk-0.0.25.dev13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: logos-sdk
-Version: 0.0.25.dev12
+Version: 0.0.25.dev13
 Summary: SDK for Logos platform
 Home-page: https://bitbucket.org/databy/logos-sdk-pip/src/master/
 Author: Databy.io

{logos_sdk-0.0.25.dev12 → logos_sdk-0.0.25.dev13}/logos_sdk/services/MicrosoftAdvertising.py

@@ -17,6 +17,12 @@ class EntityStatus:
     PAUSED = "Paused"
 
 
+class BidMatchType:
+    EXACT = "Exact"
+    PHRASE = "Phrase"
+    BROAD = "Broad"
+
+
 class MicrosoftAdvertising:
     def __init__(self, url=None):
         load_dotenv()
@@ -25,9 +31,14 @@ class MicrosoftAdvertising:
         self._GET_ACCESSIBLE_ACCOUNTS = self._URL + "/accessible-accounts"
         self._GET_ACCOUNT_ACCESSIBILITY = self._URL + "/get-account-accessibility"
         self._GET_DESTINATION_URL_REPORT = self._URL + "/destination-url-report"
-        self._GET_CAMPAIGN_PERFORMANCE_REPORT = self._URL + "/campaign-performance-report"
-        self._GET_GEOGRAPHIC_PERFORMANCE_REPORT = self._URL + "/geographic-performance-report"
+        self._GET_CAMPAIGN_PERFORMANCE_REPORT = (
+            self._URL + "/campaign-performance-report"
+        )
+        self._GET_GEOGRAPHIC_PERFORMANCE_REPORT = (
+            self._URL + "/geographic-performance-report"
+        )
         self._GET_BUDGET_SUMMARY_REPORT = self._URL + "/budget-summary-report"
+        self._GET_SHARE_OF_VOICE_REPORT = self._URL + "/share-of-voice-report"
 
     def get_destination_url_report(
         self,
@@ -113,7 +124,69 @@ class MicrosoftAdvertising:
 
         header = get_headers(self._GET_GEOGRAPHIC_PERFORMANCE_REPORT)
         response = self.session.request(
-            "post", url=self._GET_GEOGRAPHIC_PERFORMANCE_REPORT, json=body, headers=header
+            "post",
+            url=self._GET_GEOGRAPHIC_PERFORMANCE_REPORT,
+            json=body,
+            headers=header,
+        )
+
+        if response.status_code == HTTPStatus.OK:
+            service_response = response.json()
+            return service_response["data"]
+        else:
+            raise MicrosoftAdvertisingException(response.content)
+
+    def get_share_of_voice_report(
+        self,
+        account_id: str,
+        secret_id: str,
+        date_from: str,
+        date_to: str,
+        report_columns: List[str],
+        bid_match_type: str = None,
+        filter_keywords: List[str] = None,
+        entity_statuses: dict = None,
+    ) -> List:
+        """
+        Calls endpoint for getting share of voice stats
+        https://learn.microsoft.com/en-us/advertising/reporting-service/geographicperformancereportrequest?view=bingads-13&tabs=xml
+        :param account_id: The ID of the account in Microsoft Advertising
+        :param secret_id: The ID of the secret in secret manager
+        :param date_from: The date we want the report to start from. Must be before date to
+        :param date_to: The date we want the report to end at
+        :param report_columns: stats we want included in the report
+        :param bid_match_type: keywords with this bid match type will be returned
+        :param filter_keywords: just keywords from this list will be returned
+        :param entity_statuses: dict containing status ad_group_status, campaign_status, keyword_status and account_status
+        :return: List of share of voice stats
+        """
+        if entity_statuses is None:
+            entity_statuses = {
+                "ad_group_status": EntityStatus.ACTIVE,
+                "campaign_status": EntityStatus.ACTIVE,
+                "account_status": EntityStatus.ACTIVE,
+                "keyword_status": EntityStatus.ACTIVE,
+            }
+
+        body = {
+            "account_id": account_id,
+            "secret_id": secret_id,
+            "date_from": date_from,
+            "date_to": date_to,
+            "report_columns": report_columns,
+        } | entity_statuses
+
+        if bid_match_type:
+            body["bid_match_type"] = bid_match_type
+        if filter_keywords:
+            body["filter_keywords"] = filter_keywords
+
+        header = get_headers(self._GET_SHARE_OF_VOICE_REPORT)
+        response = self.session.request(
+            "post",
+            url=self._GET_SHARE_OF_VOICE_REPORT,
+            json=body,
+            headers=header,
         )
 
         if response.status_code == HTTPStatus.OK:
@@ -173,7 +246,7 @@ class MicrosoftAdvertising:
         secret_id: str,
         date_from: str,
         date_to: str,
-        report_columns: List[str]
+        report_columns: List[str],
     ):
         """
         Calls endpoint for getting budget summary
@@ -211,12 +284,7 @@ class MicrosoftAdvertising:
         :param secret_id: The ID of the secret in secret manager
         :return: List of dicts with account_id and name keys
         """
-        body = {
-            "secret_id": secret_id,
-            "filters": {
-                "hide_inactive": True
-            }
-        }
+        body = {"secret_id": secret_id, "filters": {"hide_inactive": True}}
         header = get_headers(self._GET_ACCESSIBLE_ACCOUNTS)
         response = self.session.request(
             "post", url=self._GET_ACCESSIBLE_ACCOUNTS, json=body, headers=header
@@ -235,10 +303,7 @@ class MicrosoftAdvertising:
         :param account_id: The ID of the account in Microsoft Advertising
         :return: True if account has access
         """
-        body = {
-            "secret_id": secret_id,
-            "account_id": account_id
-        }
+        body = {"secret_id": secret_id, "account_id": account_id}
         header = get_headers(self._GET_ACCOUNT_ACCESSIBILITY)
         response = self.session.request(
             "post", url=self._GET_ACCOUNT_ACCESSIBILITY, json=body, headers=header

{logos_sdk-0.0.25.dev12 → logos_sdk-0.0.25.dev13}/logos_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: logos-sdk
-Version: 0.0.25.dev12
+Version: 0.0.25.dev13
 Summary: SDK for Logos platform
 Home-page: https://bitbucket.org/databy/logos-sdk-pip/src/master/
 Author: Databy.io