/api/v2/server-side-api/profile/ 创建用户画像
在 Adapty 中创建应用的新终端用户。
Header parameters
您系统中客户的唯一 ID。adapty-customer-user-id 或 adapty-profile-id 二者必填其一。
您系统中用户画像的唯一 ID。如果您正在处理匿名用户画像，这是最佳选择。adapty-customer-user-id 或 adapty-profile-id 二者必填其一。
安装了您应用的用户设备平台
Request body
您的终端用户的名字
您的终端用户的姓氏
您的终端用户的性别
One of: "f", "m", "o"
您的终端用户的电子邮件地址
您的终端用户的电话号码
您的终端用户的生日
终端用户所在国家/地区，使用两位字母的 ISO 3166-1 alpha-2 代码，例如 FR
终端用户的 IPv4 地址
终端用户应用商店所在国家/地区，使用两位字母的 ISO 3166-1 alpha-2 代码，例如 US
用户在您的应用中进行购买所使用的平台
One of: "app_store", "play_store", "stripe", "adapty", "paddle"
商店账户令牌
Apple 应用跟踪透明度（ATT）状态（0=未确定，1=受限，2=已拒绝，3=已授权）
One of: 0, 1, 2, 3
用于退出外部分析的选项
允许为用户画像设置最多 30 个自定义属性
键必须是不超过 30 个字符的字符串。只允许使用字母、数字、破折号、点和下划线
属性值不得超过 50 个字符。值只允许使用字符串和浮点数
唯一设备标识符
设备信息
设备语言区域
操作系统信息
平台（iOS、Android 等）
One of: "iOS", "macOS", "iPadOS", "Android", "visionOS", "web"
设备时区
用户代理字符串
应用构建版本
应用版本
Adapty SDK 版本
iOS 广告主标识符
iOS 供应商标识符
Android 广告 ID
Android 设备 ID
Android 应用集 ID
Responses
用户画像创建成功
Schema
您的应用程序的内部 ID
Adapty 用户画像 ID
您的系统中该用户的 ID
一个浮点数值，表示该用户画像所产生的以美元计算的总收入
内部参数
响应时间（毫秒），用于解决竞态条件
每个用户画像最多允许设置 30 个自定义属性
键必须是不超过 30 个字符的字符串。只允许使用字母、数字、破折号、点和下划线
属性值不得超过 50 个字符。值只允许使用字符串和浮点数
访问等级对象数组。如果用户没有任何访问等级，则为空数组
访问等级标识符
购买访问等级的商店
商店中的产品 ID。对于 App Store 12 个月承诺计划，ID 以 :monthly 结尾。
商店中的基础方案 ID
商店中的交易 ID
商店中的原始交易 ID
优惠详情（如果应用了促销活动或新用户优惠）
优惠类别
One of: "introductory", "promotional", "offer_code", "win_back"
优惠类型
One of: "free_trial", "pay_as_you_go", "pay_up_front"
优惠 ID
访问等级的生效时间
访问等级的购买时间
访问等级的最初购买时间
访问等级的到期时间
续订取消的时间
检测到账单问题的时间
访问等级是否处于宽限期
取消原因
订阅对象数组。如果用户没有任何订阅，则为空数组
购买订阅的商店
商店中的产品 ID。对于 App Store 12 个月承诺计划，ID 以 :monthly 结尾。
商店中的基础方案 ID
商店中的交易 ID
商店中的原始交易 ID
优惠详情（如果应用了促销活动或新用户优惠）
优惠类别
One of: "introductory", "promotional", "offer_code", "win_back"
优惠类型
One of: "free_trial", "pay_as_you_go", "pay_up_front"
优惠 ID
环境（沙盒、生产）
订阅的购买时间
订阅的原始购买时间
订阅的到期时间
续订取消的时间。对于 12 个月承诺计划，订阅者取消后该字段保持为 null，因为每月付款仍将继续。请改用 commitment.will_renew。
检测到账单问题的时间
订阅是否处于宽限期
取消原因
App Store 承诺计划的 12 个月承诺详情。其他订阅不设置此字段。
本承诺期结束后是否开始新的12个月承诺期。订阅者取消后为 false，但每月付款将持续至 expires_at。
当前承诺期内的月付款编号，从1开始
承诺期内的月付款总次数
承诺期的结束时间。订阅本身的 expires_at 为当前已付费月份的截止时间。
一次性购买对象数组。如果用户没有任何购买记录，则为空数组
唯一购买标识符
购买所在的商店
商店中的产品 ID
商店中的基础方案 ID
商店中的交易 ID
商店中的原始交易 ID
购买时间
环境（沙盒、生产）
是否为退款
是否为消耗型商品
Example
{
"data": {
"app_id": "14c3d623-2f3a-455a-aa86-ef83dff6913b",
"profile_id": "3286abd3-48b0-4e9c-a5f6-ac0a006804a6",
"customer_user_id": "jane.doe@example.com",
"total_revenue_usd": 0,
"segment_hash": "8f45947bad31ab0c",
"timestamp": 1736425645861,
"custom_attributes": [
{
"key": "favourite_sport",
"value": "yoga"
}
],
"access_levels": [],
"subscriptions": [],
"non_subscriptions": []
}
}未授权
Schema
错误来源
错误消息数组
简短错误名称
HTTP 状态码
Example
{
"errors": [
{
"source": "non_field_errors",
"errors": [
"Authentication credentials were not provided."
]
}
],
"error_code": "not_authenticated",
"status_code": 401
}服务器内部错误