会话通知端点
| GET | https://s2s.singular.net/api/v1/launch |
使用会话通知端点尽可能实时地向该端点报告所有游戏启动（首次、重复会话）。 Singular 收到的由 Singular 设备 ID 标识的安装的首次游戏启动用于归因。
会话参数
| 参数 | 描述 | 限制条件 | 示例 |
|---|---|---|---|
| a | 你的 Singular 账户的 "SDK "密钥，在 "开发工具 -> SDK 集成 > SDK 密钥 "中 | 必须填写 | your_org_name_sh868sdjv |
| p | 游戏平台，必须是以下支持的值： PC、Xbox、Playstation、任天堂、Metaquest |
必须 仅支持以下值 |
pc |
| i | 游戏的唯一标识符值。 如果同一游戏在多个平台上发行，请使用相同的值。 |
需要 反向 DNS 符号 区分大小写 |
com.singular.game |
| sdid |
Singular 设备 ID，Singular 用于识别用户的独特安装和游戏活动。 此 UUID 应由游戏/服务器生成，建议在首次启动（安装）游戏时生成。 |
UUID （版本 4） | 49c2d3a6-326e-4ec5-a16b-0a47e34ed953 |
| match_id |
可用于归属的标识符，必须在用户首次启动游戏时发送。该值应与 Singular 网络 SDK 实现中使用的 "match_id "匹配。 如果标识符是 PII，则必须经过散列处理（SHA-256）
|
可选，用于确定归属 如果发送，必须在安装后首次启动游戏时发送 |
matchid_12345 |
| 操作系统 |
操作系统/游戏系统 支持自定义值，但建议使用推荐值 |
需要 支持自定义值 |
平台 = PC
平台 = XBox
平台 = Playstation
平台 = 任天堂
平台 = 元任务
|
| ve | 操作系统版本 | 可选 | 22H2 |
| av | 应用程序版本或游戏构建 | 可选 | 1.1.5.581823a |
| IP |
游戏启动时设备的IP 地址 |
必须 | 172.58.29.235 |
| 使用 IP | 从 HTTP 请求中提取 IP 字段。如果设置为 true，则无需提供ip参数。 |
可选 布尔 |
假 |
| 安装源 |
分发游戏的游戏商店名称 支持自定义值，但建议使用推荐值 |
需要 |
蒸汽 史诗级游戏商店 microsoftstore gog humblestore xbox 游戏机 任天堂 自行分发 [自定义]
|
| ua | 设备的用户代理 | 可选 |
Mozilla/5.0 (Windows NT 10.0; Win64; x64) |
| global_properties |
可为用户定义和保存的键值对。定义的值必须在所有后续调用中持续存在。不发送值将被视为未设置值。 |
可选 最多支持 5 个全局属性，每个属性长度为 200 个字符 必须是 URLEncoded JSON 对象 |
%7B%22key1%22%3A%22value1%22%2C% |
| 数据共享选项 |
通过此可选值可表明最终用户是否同意共享信息。如果设置了该值，则必须在用户随后的每次 /launch 和 /evt 请求中持续传递该值。请参阅PC 和控制台用户隐私 通过 "limit_data_sharing":false 表示用户同意（选择加入）共享其信息。 如果用户拒绝，则输入 "limit_data_sharing":true。
|
可选 |
%7B%22limit_data_sharing%22%3Atrue%7D |
| 安装 | 安装标志。如果会话是安装应用程序后的第一个会话，则标记为 "true"。否则为'false'。重装跟踪功能需要此标志。 |
可选 布尔 |
真 |
| 时间 | 游戏启动时间（UNIX 时间）。 | 可选 | 1483228800 |
| 毫秒 | 以 UNIX 时间毫秒为单位的游戏启动时间。 | 可选 | 1483228800000 |
| custom_user_id |
用户 ID |
可选 | 123456789abcd |
事件通知端点
| GET | https://s2s.singular.net/api/v1/evt |
使用事件通知端点尽可能实时地向该端点报告所有所需的可选游戏内事件。强烈建议传递游戏内事件，这些事件可用于分析、报告和转发给各种合作伙伴以进行优化。
事件参数
| 参数 | 说明 | 限制条件 | 示例 |
|---|---|---|---|
| a | 你的 Singular 账户的 "SDK "密钥，在 "开发工具 -> SDK 集成 > SDK 密钥 "中 | 必须填写 | your_org_name_sh868sdjv |
| p | 游戏平台，必须是以下支持的值： PC、Xbox、Playstation、任天堂、Metaquest |
必须 仅支持以下值 |
pc |
| i | 游戏的唯一标识符值。 如果同一游戏在多个平台上发行，请使用相同的值。 |
需要 反向 DNS 符号 区分大小写 |
com.singular.app |
| sdid |
Singular 设备 ID，Singular 使用该 ID 识别用户的独特安装和游戏活动。 此 UUID 应由游戏/服务器生成，建议在首次启动游戏（安装）时生成。 |
UUID | 49c2d3a6-326e-4ec5-a16b-0a47e34ed953 |
| n |
游戏中事件的名称。 强烈建议使用Singular 的标准事件命名规范。 |
必须填写 | sng_achievement_unlocked |
| e |
自定义事件属性，以 JSON 格式提供有关事件的丰富信息。 强烈建议使用Singular 的标准事件属性命名规范。 |
可选 JSON |
%7B%22sng_attr_content_id%22%3A5581%2C sng_attr_content%22%3A%22XBox%22%2C%22 sng_attr_content_type%22%3A%22electronics%22%7D |
| is_revenue_event |
是否为收入事件。如果事件名称为"__iap__"或提供了非零的 "amt"，则可以省略此项。 |
收入事件必填 |
true |
| 金额 |
如果是收入事件，则是货币金额。应与 "cur "参数一起使用。 |
收入事件必填 |
2.51 |
| cur |
如果是收入事件，指ISO-4217三字母货币代码。应与 "amt "参数一起使用。 |
收入事件必填 |
欧元 |
| os |
操作系统/游戏系统 支持自定义值，但建议使用推荐值 |
需要 支持自定义值 |
平台 = PC
平台 = XBox
平台 = Playstation
平台 = 任天堂
平台 = 元任务
|
| ve | 操作系统版本 | 可选 | 22H2 |
| av | 应用程序版本或游戏构建 | 可选 | 1.1.5.581823a |
| IP |
游戏内事件发生时设备的IP 地址 |
必须 | 172.58.29.235 |
| 使用 IP | 从 HTTP 请求中提取 IP 字段。如果设置为 true，则无需提供ip参数。 |
可选 布尔 |
假 |
| 安装源 |
分发游戏的游戏商店名称 支持自定义值，但建议使用推荐值 |
需要 |
蒸汽 史诗级游戏商店 microsoftstore gog humblestore xbox 游戏机 任天堂 自行分发 [自定义]
|
| ua | 设备的用户代理 | 可选 |
Mozilla/5.0 (Windows NT 10.0; Win64; x64) |
| global_properties |
可为用户定义和保存的键值对。定义的值必须在所有后续调用中持续存在。不发送值将被视为未设置值。 |
可选 最多支持 5 个全局属性，每个属性长度为 200 个字符 必须是 URLEncoded JSON 对象 |
%7B%22key1%22%3A%22value1%22%2C% |
| 数据共享选项
|
通过此可选值可表明最终用户是否同意共享信息。如果设置了该值，则必须在用户随后的每次 /launch 和 /evt 请求中持续传递该值。请参阅PC 和控制台用户隐私 通过 "limit_data_sharing":false 表示用户同意（选择加入）共享其信息。 如果用户拒绝，则输入 "limit_data_sharing":true。 |
可选 |
%7B%22limit_data_sharing%22%3Atrue%7D |
| 时间 | 游戏内事件发生的时间（UNIX 时间）。 | 可选 | 1483228800 |
| 毫秒 | 游戏中事件发生的时间，以 UNIX 时间毫秒为单位。 | 可选 | 1483228800000 |
| custom_user_id |
用户 ID |
可选 | 123456789abcd |