feat: utc_offset_hours

chore: version bump

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 11.1.0
+- Added `utc_offset_hours` parameter for `get_rtb_stats` and `get_summary_stats`
+
 # v11.0.0
 - Added support for Pydantic v2
 - [breaking change] `cookie_hash`, `last_click_time` and `last_impression_time` fields in `Conversion` schema are now nullable

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rtbhouse-sdk"
-version = "11.0.0"
+version = "11.1.0"
 description = "RTB House SDK"
 authors = ["RTB House Apps Team <[email protected]>"]
 license = "BSD License"

rtbhouse_sdk/__init__.py

@@ -1,2 +1,2 @@
 """RTB House Python SDK."""
-__version__ = "11.0.0"
+__version__ = "11.1.0"

rtbhouse_sdk/client.py

@@ -202,12 +202,21 @@ def get_rtb_stats(
         group_by: List[schema.StatsGroupBy],
         metrics: List[schema.StatsMetric],
         count_convention: Optional[schema.CountConvention] = None,
+        utc_offset_hours: int = 0,
         subcampaigns: Optional[List[str]] = None,
         user_segments: Optional[List[schema.UserSegment]] = None,
         device_types: Optional[List[schema.DeviceType]] = None,
     ) -> List[schema.Stats]:
         params = _build_rtb_stats_params(
-            day_from, day_to, group_by, metrics, count_convention, subcampaigns, user_segments, device_types
+            day_from,
+            day_to,
+            group_by,
+            metrics,
+            count_convention,
+            utc_offset_hours,
+            subcampaigns,
+            user_segments,
+            device_types,
         )
 
         data = self._get_list_of_dicts(f"/advertisers/{adv_hash}/rtb-stats", params)
@@ -221,9 +230,12 @@ def get_summary_stats(
         group_by: List[schema.StatsGroupBy],
         metrics: List[schema.StatsMetric],
         count_convention: Optional[schema.CountConvention] = None,
+        utc_offset_hours: int = 0,
         subcampaigns: Optional[List[str]] = None,
     ) -> List[schema.Stats]:
-        params = _build_summary_stats_params(day_from, day_to, group_by, metrics, count_convention, subcampaigns)
+        params = _build_summary_stats_params(
+            day_from, day_to, group_by, metrics, count_convention, utc_offset_hours, subcampaigns
+        )
 
         data = self._get_list_of_dicts(f"/advertisers/{adv_hash}/summary-stats", params)
         return [schema.Stats(**st) for st in data]
@@ -377,12 +389,21 @@ async def get_rtb_stats(
         group_by: List[schema.StatsGroupBy],
         metrics: List[schema.StatsMetric],
         count_convention: Optional[schema.CountConvention] = None,
+        utc_offset_hours: int = 0,
         subcampaigns: Optional[List[str]] = None,
         user_segments: Optional[List[schema.UserSegment]] = None,
         device_types: Optional[List[schema.DeviceType]] = None,
     ) -> List[schema.Stats]:
         params = _build_rtb_stats_params(
-            day_from, day_to, group_by, metrics, count_convention, subcampaigns, user_segments, device_types
+            day_from,
+            day_to,
+            group_by,
+            metrics,
+            count_convention,
+            utc_offset_hours,
+            subcampaigns,
+            user_segments,
+            device_types,
         )
 
         data = await self._get_list_of_dicts(f"/advertisers/{adv_hash}/rtb-stats", params)
@@ -396,9 +417,12 @@ async def get_summary_stats(
         group_by: List[schema.StatsGroupBy],
         metrics: List[schema.StatsMetric],
         count_convention: Optional[schema.CountConvention] = None,
+        utc_offset_hours: int = 0,
         subcampaigns: Optional[List[str]] = None,
     ) -> List[schema.Stats]:
-        params = _build_summary_stats_params(day_from, day_to, group_by, metrics, count_convention, subcampaigns)
+        params = _build_summary_stats_params(
+            day_from, day_to, group_by, metrics, count_convention, utc_offset_hours, subcampaigns
+        )
 
         data = await self._get_list_of_dicts(f"/advertisers/{adv_hash}/summary-stats", params)
         return [schema.Stats(**st) for st in data]
@@ -495,18 +519,21 @@ def _build_rtb_stats_params(
     group_by: List[schema.StatsGroupBy],
     metrics: List[schema.StatsMetric],
     count_convention: Optional[schema.CountConvention] = None,
+    utc_offset_hours: int = 0,
     subcampaigns: Optional[List[str]] = None,
     user_segments: Optional[List[schema.UserSegment]] = None,
     device_types: Optional[List[schema.DeviceType]] = None,
 ) -> Dict[str, Any]:
-    params = {
+    params: Dict[str, Any] = {
         "dayFrom": day_from,
         "dayTo": day_to,
         "groupBy": "-".join(gb.value for gb in group_by),
         "metrics": "-".join(m.value for m in metrics),
     }
     if count_convention is not None:
         params["countConvention"] = count_convention.value
+    if utc_offset_hours != 0:
+        params["utcOffsetHours"] = utc_offset_hours
     if subcampaigns is not None:
         params["subcampaigns"] = "-".join(str(sub) for sub in subcampaigns)
     if user_segments is not None:
@@ -523,16 +550,19 @@ def _build_summary_stats_params(
     group_by: List[schema.StatsGroupBy],
     metrics: List[schema.StatsMetric],
     count_convention: Optional[schema.CountConvention] = None,
+    utc_offset_hours: int = 0,
     subcampaigns: Optional[List[str]] = None,
 ) -> Dict[str, Any]:
-    params = {
+    params: Dict[str, Any] = {
         "dayFrom": day_from,
         "dayTo": day_to,
         "groupBy": "-".join(gb.value for gb in group_by),
         "metrics": "-".join(m.value for m in metrics),
     }
     if count_convention is not None:
         params["countConvention"] = count_convention.value
+    if utc_offset_hours != 0:
+        params["utcOffsetHours"] = utc_offset_hours
     if subcampaigns is not None:
         params["subcampaigns"] = "-".join(str(sub) for sub in subcampaigns)