pixelarraythirdparty 1.3.4__tar.gz → 1.3.5__tar.gz

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pixelarraythirdparty
-Version: 1.3.4
+Version: 1.3.5
 Summary: PixelArray 第三方微服务客户端
 Author-email: Lu qi <qi.lu@pixelarrayai.com>
 License-Expression: MIT

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.5}/pixelarraythirdparty/__init__.py

@@ -20,7 +20,7 @@ from .support_chat.support_chat import SupportChatManagerAsync
 from .custom_events.custom_events import CustomEventsManagerAsync
 from .project_dashboard.project_dashboard import ProjectDashboardManagerAsync
 
-__version__ = "1.3.4"
+__version__ = "1.3.5"
 __author__ = "Lu qi"
 __email__ = "qi.lu@pixelarrayai.com"
 

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.5}/pixelarraythirdparty/custom_events/custom_events.py

@@ -62,6 +62,38 @@ class CustomEventsManagerAsync(AsyncClient):
             "POST", "/api/custom-events/definitions/create", json=body
         )
 
+    async def get_custom_event_common_field_schema(
+        self, project_name: str
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            查询项目自定义事件公共维度（GET /api/custom-events/common-field-schema）
+        """
+        return await self._request(
+            "GET",
+            "/api/custom-events/common-field-schema",
+            params={"project_name": project_name},
+        )
+
+    async def update_custom_event_common_field_schema(
+        self,
+        project_name: str,
+        field_schema: List[Dict[str, Any]],
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            更新项目公共维度；传空列表表示恢复服务端内置默认（POST /api/custom-events/common-field-schema/update）
+        parameters:
+            field_schema: 每项含 name、type、required、可选 nullable、description
+        """
+        body: Dict[str, Any] = {
+            "project_name": project_name,
+            "field_schema": field_schema or [],
+        }
+        return await self._request(
+            "POST", "/api/custom-events/common-field-schema/update", json=body
+        )
+
     async def report_custom_event(
         self,
         project_name: str,
@@ -71,7 +103,7 @@ class CustomEventsManagerAsync(AsyncClient):
     ) -> Tuple[Dict[str, Any], bool]:
         """
         description:
-            上报单条自定义事件日志（JSON 载荷须符合 Portal 中配置的 field_schema）
+            上报单条自定义事件日志（有效载荷 = 项目公共维度 ∪ 该事件 field_schema；未传的公共键由服务端补 null）
         parameters:
             project_name(str): 项目名称（与 projects.name 一致）
             event_key(str): 事件键

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.5}/pixelarraythirdparty/project_dashboard/project_dashboard.py

@@ -12,6 +12,8 @@ def _resolve_dashboard_path(scope: str) -> Optional[str]:
         return "/api/project-dashboard/dashboard/dau"
     if s.upper() == "RETENTION" or s == "留存":
         return "/api/project-dashboard/dashboard/retention"
+    if s.upper() == "TOTAL_USERS" or s == "总用户":
+        return "/api/project-dashboard/dashboard/total-users"
     return None
 
 
@@ -28,13 +30,13 @@ class ProjectDashboardManagerAsync(AsyncClient):
     ) -> Tuple[Dict[str, Any], bool]:
         """
         description:
-            查询项目看板指标；scope 为 DNU、DAU、RETENTION 或中文「留存」。
+            查询项目看板指标；scope 为 DNU、DAU、RETENTION、TOTAL_USERS 或中文「留存」「总用户」。
         parameters:
             project_name(str): 项目名称（与统一登录 project_name 一致）
             scope(str): DNU | DAU | RETENTION | 留存
             start_date(str, optional): 开始日期 YYYY-MM-DD；不传则服务端默认 T-7
             end_date(str, optional): 结束日期 YYYY-MM-DD；不传则服务端默认 T-0
-            retention_days(str, optional): 仅 scope 为留存时有效；逗号分隔天数，如 2,7,14,20；不传则服务端默认
+            retention_days(str): scope 为留存时必填；逗号分隔天数，如 1,7,14,20
         return:
             data(dict): 成功时为 DauData / DnuData / RetentionData 结构（见接口文档）
             success(bool): 是否成功
@@ -42,14 +44,23 @@ class ProjectDashboardManagerAsync(AsyncClient):
         path = _resolve_dashboard_path(scope)
         if not path:
             return (
-                {"message": "scope 无效，应为 DNU、DAU、RETENTION 或 留存"},
+                {"message": "scope 无效，应为 DNU、DAU、RETENTION、TOTAL_USERS 或 留存 / 总用户"},
+                False,
+            )
+        is_retention = "/retention" in path
+        is_total_users = "/total-users" in path
+        rd = (retention_days or "").strip()
+        if is_retention and not rd:
+            return (
+                {"message": "scope 为留存时须传入 retention_days（逗号分隔正整数，如 1,7,14）"},
                 False,
             )
         params: Dict[str, Any] = {"project_name": project_name}
-        if start_date:
-            params["start_date"] = start_date
-        if end_date:
-            params["end_date"] = end_date
-        if retention_days:
-            params["retention_days"] = retention_days
+        if not is_total_users:
+            if start_date:
+                params["start_date"] = start_date
+            if end_date:
+                params["end_date"] = end_date
+        if rd:
+            params["retention_days"] = rd
         return await self._request("GET", path, params=params)

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.5}/pixelarraythirdparty.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pixelarraythirdparty
-Version: 1.3.4
+Version: 1.3.5
 Summary: PixelArray 第三方微服务客户端
 Author-email: Lu qi <qi.lu@pixelarrayai.com>
 License-Expression: MIT

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pixelarraythirdparty"
-version = "1.3.4"
+version = "1.3.5"
 authors = [
     {name = "Lu qi", email = "qi.lu@pixelarrayai.com"},
 ]