Skip to content

Commit

Permalink
feat: audio and viewability support
Browse files Browse the repository at this point in the history
  • Loading branch information
peku33 committed Sep 3, 2024
1 parent 8e68fbe commit 8a93b26
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 16 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# v13.0.0
- [breaking change] current `viewability` metric has been renamed to `ssp_viewability`. We are leaving compatibility layer in the api until 2024-12-31.
- added audio related metrics: `audio_complete_listens`, `ecpl`, `acr`.
- added viewability related metrics: `viewability_measurability`, `viewability_viewability`, `evcpm`.
- added visits related metrics: `visits_count`, `cpvisit`.

# v12.0.0
- [breaking change] Stats (`schema.Stats`, returned from `get_rtb_stats` and `get_summary_stats`) metrics: `imps_count`, `clicks_count`, `conversions_count`, `video_complete_views` are now represented as float type, to reflect actual api responses. Fractional metrics may appear in certain scenarios, eg. for custom grouping and/or as a result of manual adjustment.

Expand Down
22 changes: 11 additions & 11 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "rtbhouse-sdk"
version = "12.0.1"
version = "13.0.0"
description = "RTB House SDK"
authors = ["RTB House Apps Team <[email protected]>"]
license = "BSD License"
Expand Down Expand Up @@ -38,7 +38,7 @@ isort = "^5.10.1"
mypy = "^1.0"
pylint = "^3.0.0"
pytest = "^8.0.0"
pytest-asyncio = "^0.23.0"
pytest-asyncio = "^0.24.0"
pytest-cov = "^5.0.0"
respx = "^0.21.0"

Expand Down
2 changes: 1 addition & 1 deletion rtbhouse_sdk/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""RTB House Python SDK."""

__version__ = "12.0.0"
__version__ = "13.0.0"
20 changes: 18 additions & 2 deletions rtbhouse_sdk/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,15 @@ class StatsMetric(str, Enum):
VIDEO_COMPLETE_VIEWS = "videoCompleteViews"
ECPV = "ecpv"
VCR = "vcr"
VIEWABILITY = "viewability"
AUDIO_COMPLETE_LISTENS = "audioCompleteListens"
ECPL = "ecpl"
ACR = "acr"
VIEWABILITY_MEASURABILITY = "viewabilityMeasurability"
VIEWABILITY_VIEWABILITY = "viewabilityViewability"
EVCPM = "evcpm"
SSP_VIEWABILITY = "sspViewability"
VISITS_COUNT = "visitsCount"
CPVISIT = "cpvisit"
USER_FREQUENCY = "userFrequency"
USER_REACH = "userReach"

Expand Down Expand Up @@ -254,6 +262,14 @@ class Stats(CamelizedBaseModel):
video_complete_views: Optional[float] = None
ecpv: Optional[float] = None
vcr: Optional[float] = None
viewability: Optional[float] = None
audio_complete_listens: Optional[float] = None
ecpl: Optional[float] = None
acr: Optional[float] = None
viewability_measurability: Optional[float] = None
viewability_viewability: Optional[float] = None
evcpm: Optional[float] = None
ssp_viewability: Optional[float] = None
visits_count: Optional[float] = None
cpvisit: Optional[float] = None
user_frequency: Optional[float] = None
user_reach: Optional[float] = None

0 comments on commit 8a93b26

Please sign in to comment.