@doubao-dev/plugin-app-dev 0.0.0-stage → 0.0.40-canary-dea0ddc73-20261026073950

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/15-/346/225/260/346/215/256/345/210/206/346/236/220.md

@@ -0,0 +1,124 @@
+# 豆包应用插件的端能力 API: 数据分析
+
+监控上报、事件和数据分析上报。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [reportEvent](#reportevent) | 上报数据分析事件。 |
+
+## API 详情
+
+<a id="reportevent"></a>
+### reportEvent()
+
+# reportEvent
+
+上报数据分析事件。
+
+## 扫码预览
+![扫码预览 reportEvent](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdata-analysis%252Freport-event%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.28`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- 事件名与事件参数会用于数据分析，请勿写入用户隐私或敏感数据。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+reportEvent(params: ReportEventParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>data</code></td><td><code>Record&lt;string, any&gt;</code></td><td>是</td><td>-</td><td>-</td><td>事件参数，会作为事件属性一并上报。</td></tr>
+<tr><td><code>eventName</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>事件名称。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { reportEvent } from '@doubao-dev/framework/api';
+
+await reportEvent({
+  eventName: 'page_view',
+  data: {
+    pageName: 'home',
+    source: 'feed'
+  }
+});
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 错误码
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+## 相关类型
+
+<a id="reporteventparams"></a>
+### ReportEventParams
+
+上报数据分析事件的请求参数。
+
+#### Properties
+
+• **eventName**: `string` - 事件名称
+• **data**: `Record<string, any>` - 事件参数，会作为事件属性一并上报