会话通知端点
| GET | https://s2s.singular.net/api/v1/launch |
使用会话通知端点尽可能实时地向该端点报告所有游戏启动情况（首次、重复会话）。 Singular 收到的由 Singular 设备 ID 识别的安装的首次游戏启动情况将用于归因。
会话参数
| 参数 | 描述 | 限制条件 | 示例 |
|---|---|---|---|
| a | 您的 Singular 账户的 "SDK "密钥，位于 "开发工具 -> SDK 集成 > SDK 密钥 "中 | 要求 | your_org_name_sh868sdjv |
| p | 游戏平台。支持的值有： pc, xbox, playstation, nintendo, metaquest |
要求 仅支持值 |
pc |
| i | 您的游戏独有的游戏标识符值。 如果同一游戏在多个平台上发行，请使用相同的值。 |
要求 反向 DNS 符号 大小写敏感 |
com.singular.game |
| sdid |
奇异设备 ID，Singular 用于识别用户的独特安装和游戏活动。 该 UUID 应由游戏/服务器生成，建议在首次启动游戏（安装）时生成，并在游戏安装期间持续存在。 |
UUIDv4 | 49c2d3a6-326e-4ec5-a16b-0a47e34ed953 |
| match_id |
用户首次启动游戏时必须发送一个可用于归属的唯一标识符。该值应与 Singular WebSDK 实现中使用的 "match_id "相匹配。match_id 可以从 WebSDK 的 "singularSdk.getMatchID() "函数中获取。
|
可选，用于确定归属。 如果发送 match_id，则必须在安装后的第一次游戏 LAUNCH 时发送。 |
matchid_12345 |
| os |
操作系统/游戏系统 支持自定义值，但建议使用推荐值 |
要求 支持自定义值 |
Platform = PC
Platform = XBox
Platform = Playstation
Platform = Nintendo
Platform = Meta Quest
|
| ve | 会话时设备的操作系统版本。 | 选配 | 22H2 |
| av | 应用程序版本或游戏构建 | 选配 | 1.1.5.581823a |
| ip |
游戏启动时设备的 IP 地址 |
要求 | 172.58.29.235 |
| use_ip | 从 HTTP 请求中提取 IP 字段。如果设置为 true，则无需提供 ip 参数。 |
选配 布尔 |
false |
| install_source |
分发游戏的游戏商店名称 支持自定义值，但建议使用 |
要求 |
steam epicgamestore microsoftstore gog humblestore xbox playstation nintendo selfdistributed [custom]
|
| ua | 设备的用户代理 | 选配 |
Mozilla/5.0 (Windows NT 10.0; Win64; x64) |
| global_properties |
可为用户定义和保存的键值对。定义的值必须在所有后续调用中持续存在。不发送值将被视为未设置值。 |
您最多可以定义 5 个全局属性。每个属性的键和值最长可包含 200 个字符。如果输入的属性名称或属性值较长，则会被截断为 200 个字符。值必须是 URLEncoded JSON 对象。 |
%7B%22key1%22%3A%22value1%22%2C% |
| install | 安装标志。如果会话是安装应用程序后的第一个会话，则标记为 "true"。否则为'false'。需要重新安装跟踪功能。 |
选配 布尔 |
true |
| utime | 会话时间（UNIX 时间）。 | 选配 | 1483228800 |
| umilisec | 会话时间（毫秒），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, nintendo, metaquest |
要求 仅支持值 |
pc |
| i | 您的游戏独有的游戏标识符值。 如果同一游戏在多个平台上发行，请使用相同的值。 |
要求 反向 DNS 符号 大小写敏感 |
com.singular.app |
| sdid |
奇异设备 ID，Singular 用于识别用户的独特安装和游戏活动。 该 UUID 应由游戏/服务器生成，建议在首次启动游戏（安装）时生成，并在游戏安装期间持续存在。 |
UUIDv4 | 49c2d3a6-326e-4ec5-a16b-0a47e34ed953 |
| n |
事件名称。 |
要求 | sng_achievement_unlocked |
| e |
JSON 格式的自定义事件属性。 |
选配 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 |
| amt |
货币金额。应与 "cur "参数一起使用。 |
收入活动所需 |
2.51 |
| cur |
ISO 4217 三字母货币代码。应与 "amt "参数一起使用。 |
收入活动所需 |
EUR |
| os |
操作系统/游戏系统 支持自定义值，但建议使用推荐值 |
要求 支持自定义值 |
Platform = PC
Platform = XBox
Platform = Playstation
Platform = Nintendo
Platform = Meta Quest
|
| ve | 会话时设备的操作系统版本。 | 选配 | 22H2 |
| av | 应用程序版本或游戏构建 | 选配 | 1.1.5.581823a |
| ip |
游戏内事件发生时设备的 IP 地址 |
要求 | 172.58.29.235 |
| use_ip | 从 HTTP 请求中提取 IP 字段。如果设置为 true，则无需提供 ip 参数。 |
选配 布尔 |
false |
| install_source |
分发游戏的游戏商店名称 支持自定义值，但建议使用 |
要求 |
steam epicgamestore microsoftstore gog humblestore xbox playstation nintendo selfdistributed [custom]
|
| ua | 设备的用户代理 | 选配 |
Mozilla/5.0 (Windows NT 10.0; Win64; x64) |
| global_properties |
可为用户定义和保存的键值对。定义的值必须在所有后续调用中持续存在。不发送值将被视为未设置值。 |
您最多可以定义 5 个全局属性。每个属性的键和值最长可包含 200 个字符。如果输入的属性名称或属性值较长，则会被截断为 200 个字符。值必须是 URLEncoded JSON 对象。 |
%7B%22key1%22%3A%22value1%22%2C% |
| utime | 会话时间（UNIX 时间）。 | 选配 | 1483228800 |
| umilisec | 会话时间（毫秒），UNIX 时间。 | 选配 | 1483228800000 |
| custom_user_id |
用户 ID |
选配 | 123456789abcd |