跳到主要内容

活动类型

活动类型声明了您的产品向 k-ID 报告的一类事情,以及它的度量方式。您的产品针对已声明的类型推送记录,k-ID 会拒绝指定其他类型的记录。声明类型是您自己完成的配置变更,因此新增一类活动不需要 k-ID 的工程师参与。

概念请参阅活动,API 请参阅活动摄取

找到活动选项卡

在产品编辑器中打开您的产品,选择活动选项卡。该选项卡包含此产品的活动类型;如果您的组织可以使用屏幕时间,也包含屏幕时间设置。

要使用活动功能,请联系 k-ID 为您的组织启用此功能。

声明一个类型

  1. 活动选项卡中选择添加活动类型。系统会显示一个新条目,在保存之前标记为需要操作

  2. 输入标签。这是可信成人在 Family Connect 中看到的、供人阅读的名称,因此请为家长而不是为代码书写:用聊天时长而不是 chat_time_v2。最多 128 个字符。

  3. 选择指标类型。它固定了您的产品为该类型推送的每个值的形状。

    下拉选项您的产品推送的 value
    时长(秒){ "seconds": 1800 }
    货币(最小单位 + ISO){ "amount": 999, "currency": "USD" }
    计数(整数){ "count": 7 }
    量值(浮点数){ "number": 0.85 }
    布尔{ "bool": true }
  4. 可选地添加允许的属性键。您在这里添加的每个键,都是您的产品可以附加到该类型记录上的键。键以小写字母开头,只能包含小写字母、数字和下划线,最多 64 个字符,每个类型最多 32 个。

  5. 选择保存

警告

指标类型是永久的。由于已经以该类型存储的记录是按这个形状校验的,因此类型创建后无法更改。如果需要另一种形状,请创建新的类型。

在产品中引用一个类型

每个活动类型都有一个,您的产品在记录的 type 字段中发送这个键。

键在您添加类型时由 k-ID 生成,是一个 UUID。您无法选择,也无法编辑。保存类型后,标签字段旁会显示一个复制控件:用它复制键,并把该值粘贴到您的集成中。

提示

请每次都从 Compliance Studio 复制键,不要根据标签推导或手动重新输入。它是自动生成的 UUID,不是可以自行拼装的值。

有一个键是预留的:screentime_usage 属于 k-ID 的屏幕时间端点,使用片段会以它记录。您的产品不会用这个键推送记录。

编辑与删除

类型创建后,您可以修改它的标签和允许的属性键。两者都对变更到达该环境之后推送的记录生效。

移除一个允许的属性键后,携带该键的记录会开始以 attribute_key_not_allowed 为原因被拒绝。请先从您的集成中移除该键,再从类型中移除。

删除一个类型会移除该声明,因此以该键推送的记录会开始以 unknown_type 为原因被拒绝。请在删除之前停止推送该类型。

限制

项目数值
每个产品的活动类型50
每个类型允许的属性键32
标签长度128 个字符
属性键长度64 个字符

发布您的变更

活动类型与产品配置的其余部分走同一条路径。您添加的类型在推送之前都是本地的,每个环境提供的是推送到该环境的那份配置。先推送到测试环境并用测试 API 密钥验证,然后再发布到生产环境。请参阅测试与发布

如果一条记录指定的类型尚未到达您的 API 密钥所服务的环境,它会以 unknown_type 被拒绝,这是新类型看起来不生效的最常见原因。