✨ Source Snapchat Marketing : add attribution_windows and action_report_time to request parameters (#30586)

Co-authored-by: Serhii Lazebnyi <[email protected]>

Author: Abuton

airbyte-integrations/connectors/source-snapchat-marketing/metadata.yaml

@@ -8,7 +8,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: 200330b2-ea62-4d11-ac6d-cfe3e3f8ab2b
-  dockerImageTag: 0.5.0
+  dockerImageTag: 0.6.0
   dockerRepository: airbyte/source-snapchat-marketing
   githubIssueLabel: source-snapchat-marketing
   icon: snapchat.svg

airbyte-integrations/connectors/source-snapchat-marketing/pyproject.toml

@@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "0.5.0"
+version = "0.6.0"
 name = "source-snapchat-marketing"
 description = "Source implementation for Snapchat Marketing."
 authors = [ "Airbyte <[email protected]>",]

airbyte-integrations/connectors/source-snapchat-marketing/source_snapchat_marketing/source.py

@@ -165,10 +165,13 @@ class SnapchatMarketingStream(HttpStream, ABC):
     primary_key = "id"
     raise_on_http_errors = True
 
-    def __init__(self, start_date, end_date, **kwargs):
+    def __init__(self, start_date, end_date, action_report_time, swipe_up_attribution_window, view_attribution_window, **kwargs):
         super().__init__(**kwargs)
         self.start_date = start_date
         self.end_date = end_date
+        self.action_report_time = action_report_time
+        self.swipe_up_attribution_window = swipe_up_attribution_window
+        self.view_attribution_window = view_attribution_window
 
     def next_page_token(self, response: requests.Response) -> Optional[Mapping[str, Any]]:
         next_page_cursor = response.json().get("paging", False)
@@ -246,7 +249,14 @@ def stream_slices(self, **kwargs) -> Iterable[Optional[Mapping[str, Any]]]:
         self.initial_state = stream_state.get(self.cursor_field) if stream_state else self.start_date
         self.max_state = self.initial_state
 
-        parent_stream = self.parent(authenticator=self.authenticator, start_date=self.start_date, end_date=self.end_date)
+        parent_stream = self.parent(
+            authenticator=self.authenticator,
+            start_date=self.start_date,
+            end_date=self.end_date,
+            action_report_time=self.action_report_time,
+            swipe_up_attribution_window=self.swipe_up_attribution_window,
+            view_attribution_window=self.view_attribution_window,
+        )
         stream_slices = get_parent_ids(parent_stream)
 
         if stream_slices:
@@ -368,7 +378,14 @@ def parent(self) -> SnapchatMarketingStream:
     def stream_slices(self, **kwargs) -> Iterable[Optional[Mapping[str, Any]]]:
         """Each stream slice represents each entity id from parent stream"""
 
-        parent_stream = self.parent(authenticator=self.authenticator, start_date=self.start_date, end_date=self.end_date)
+        parent_stream = self.parent(
+            authenticator=self.authenticator,
+            start_date=self.start_date,
+            end_date=self.end_date,
+            action_report_time=self.action_report_time,
+            swipe_up_attribution_window=self.swipe_up_attribution_window,
+            view_attribution_window=self.view_attribution_window,
+        )
         self.parent_name = parent_stream.name
         stream_slices = get_parent_ids(parent_stream)
 
@@ -388,6 +405,9 @@ def request_params(
 
         params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token)
         params["granularity"] = self.granularity.value
+        params["action_report_time"] = self.action_report_time
+        params["swipe_up_attribution_window"] = self.swipe_up_attribution_window
+        params["view_attribution_window"] = self.view_attribution_window
         if self.metrics:
             params["fields"] = ",".join(self.metrics)
 
@@ -808,6 +828,9 @@ def streams(self, config: Mapping[str, Any]) -> List[Stream]:
             ),
             "start_date": config["start_date"],
             "end_date": config.get("end_date", default_end_date),
+            "action_report_time": config.get("action_report_time", "conversion"),
+            "swipe_up_attribution_window": config.get("swipe_up_attribution_window", "28_DAY"),
+            "view_attribution_window": config.get("view_attribution_window", "1_DAY"),
         }
 
         return [

airbyte-integrations/connectors/source-snapchat-marketing/source_snapchat_marketing/spec.json

@@ -45,6 +45,30 @@
         "examples": ["2022-01-30"],
         "order": 4,
         "format": "date"
+      },
+      "action_report_time": {
+        "type": "string",
+        "enum": ["conversion", "impression"],
+        "title": "Action Report Time",
+        "description": "Specifies the principle for conversion reporting.",
+        "default": "conversion",
+        "order": 5
+      },
+      "swipe_up_attribution_window": {
+        "type": "string",
+        "title": "Swipe Up Attribution Window",
+        "description": "Attribution window for swipe ups.",
+        "enum": ["1_DAY", "7_DAY", "28_DAY"],
+        "default": "28_DAY",
+        "order": 6
+      },
+      "view_attribution_window": {
+        "type": "string",
+        "title": "View Attribution Window",
+        "description": "Attribution window for views.",
+        "enum": ["1_HOUR", "3_HOUR", "6_HOUR", "1_DAY", "7_DAY"],
+        "default": "1_DAY",
+        "order": 7
       }
     }
   },

airbyte-integrations/connectors/source-snapchat-marketing/unit_tests/unit_test.py

@@ -23,6 +23,9 @@
     "authenticator": NoAuth(),
     "start_date": "2000-01-01",
     "end_date": "2000-02-10",
+    "action_report_time": "impression",
+    "swipe_up_attribution_window": "7_DAY",
+    "view_attribution_window": "1_DAY",
 }
 stats_stream = AdaccountsStatsDaily(**config_mock)
 

docs/integrations/sources/snapchat-marketing.md

@@ -17,6 +17,10 @@ This page guides you through the process of setting up the Snapchat Marketing so
 * client_secret
 * refresh_token
 * start_date
+* end_date
+* action_report_time (Optional, Default value is conversion) It specifies the principle for conversion reporting.
+* swipe_up_attribution_window (Optional, Default value is 1_DAY) This is the attribution window for swipe up.
+* view_attribution_window (Optional, Default value is 28_DAY) This is the attribution window for views.
 <!-- /env:oss -->
 
 ## Setup guide
@@ -113,6 +117,7 @@ Snapchat Marketing API has limitations to 1000 items per page.
 
 | Version | Date       | Pull Request                                             | Subject                                                                        |
 |:--------|:-----------|:---------------------------------------------------------|:-------------------------------------------------------------------------------|
+| 0.6.0   | 2024-04-10 | [30586](https://github.com/airbytehq/airbyte/pull/30586) | Add `attribution_windows`,`action_report_time` as optional configurable params |
 | 0.5.0   | 2024-03-19 | [36267](https://github.com/airbytehq/airbyte/pull/36267) | Pin airbyte-cdk version to `^0` |
 | 0.4.0   | 2024-02-27 | [35660](https://github.com/airbytehq/airbyte/pull/35660) | Add new fields to streams `ads`, `adsquads`, `creatives`, and `media`          |
 | 0.3.2   | 2024-02-12 | [35171](https://github.com/airbytehq/airbyte/pull/35171) | Manage dependencies with Poetry.                                               |