English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
GET /api/v2/server-side-api/profile/

获取用户画像

Copy as Markdown

检索应用现有终端用户的详细信息。

Header parameters

adapty-customer-user-idstring

您系统中客户的唯一 ID。adapty-customer-user-id 或 adapty-profile-id 二者必填其一。

adapty-profile-idstring

您系统中用户画像的唯一 ID。如果您正在处理匿名用户画像，这是最佳选择。adapty-customer-user-id 或 adapty-profile-id 二者必填其一。

Responses

用户画像获取成功

Schema
dataobjectrequired
app_idstringrequired

您的应用程序的内部 ID

profile_idstringrequired

Adapty 用户画像 ID

customer_user_idstringrequired

您的系统中该用户的 ID

total_revenue_usdnumberrequired

一个浮点数值，表示该用户画像所产生的以美元计算的总收入

segment_hashstringrequired

内部参数

timestampintegerrequired

响应时间（毫秒），用于解决竞态条件

custom_attributesarray of objectrequired

每个用户画像最多允许设置 30 个自定义属性

keystringrequired

键必须是不超过 30 个字符的字符串。只允许使用字母、数字、破折号、点和下划线

valuestring | numberrequired

属性值不得超过 50 个字符。值只允许使用字符串和浮点数

access_levelsarray of objectrequired

访问等级对象数组。如果用户没有任何访问等级，则为空数组

access_level_idstring

访问等级标识符

storestring

购买该访问等级的商店

store_product_idstring

商店中的产品 ID

store_base_plan_idstring

商店中的基础方案 ID

store_transaction_idstring

商店中的交易 ID

store_original_transaction_idstring

商店中的原始交易 ID

offerallOf

优惠详情（若应用了促销活动或新用户优惠）

categorystring

优惠类别

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

优惠类型

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

优惠 ID

starts_atstring

访问等级的生效时间

purchased_atstring

访问等级的购买时间

originally_purchased_atstring

访问等级的最初购买时间

expires_atstring

访问等级的到期时间

renewal_cancelled_atstring

续订取消的时间

billing_issue_detected_atstring

检测到计费问题的时间

is_in_grace_periodboolean

该访问等级是否处于宽限期

cancellation_reasonstring

取消原因

subscriptionsarray of objectrequired

订阅对象数组。如果用户没有任何订阅，则为空数组

storestring

购买订阅的商店

store_product_idstring

商店中的产品 ID

store_base_plan_idstring

商店中的基础方案 ID

store_transaction_idstring

商店中的交易 ID

store_original_transaction_idstring

商店中的原始交易 ID

offerallOf

优惠详情（若已应用促销活动或新用户优惠）

categorystring

优惠类别

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

优惠类型

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

优惠 ID

environmentstring

环境（沙盒、生产）

purchased_atstring

订阅的购买时间

originally_purchased_atstring

订阅的首次购买时间

expires_atstring

订阅的到期时间

renewal_cancelled_atstring

取消续订的时间

billing_issue_detected_atstring

检测到计费问题的时间

is_in_grace_periodboolean

订阅是否处于宽限期

cancellation_reasonstring

取消原因

non_subscriptionsarray of objectrequired

一次性购买对象数组。如果用户没有任何购买记录，则为空数组

purchase_idstring

唯一购买标识符

storestring

购买所在的商店

store_product_idstring

商店中的产品 ID

store_base_plan_idstring

商店中的基础方案 ID

store_transaction_idstring

商店中的交易 ID

store_original_transaction_idstring

商店中的原始交易 ID

purchased_atstring

购买时间

environmentstring

环境（沙盒、生产）

is_refundboolean

是否为退款

is_consumableboolean

是否为消耗型商品

Example 
{
  "data": {
    "app_id": "14c3d333-2f3a-455a-aa86-ef83dff6913b",
    "profile_id": "d8533a10-bcce-4e33-8c9d-88b05ac56559",
    "customer_user_id": "77B14FB4-FD2A-4D38-AA3A-4C433F79863C",
    "total_revenue_usd": 9.99,
    "segment_hash": "fdaeef7f8aaa33c9",
    "timestamp": 1733324566777,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "access_levels": [
      {
        "access_level_id": "premium",
        "store": "app_store",
        "store_product_id": "unlimited.9999",
        "store_base_plan_id": null,
        "store_transaction_id": "2000000335013007",
        "store_original_transaction_id": "2000000335013007",
        "offer": null,
        "starts_at": null,
        "purchased_at": "2024-12-24T10:50:23+00:00",
        "originally_purchased_at": "2024-12-24T10:50:23+00:00",
        "expires_at": null,
        "renewal_cancelled_at": "2025-01-05T13:27:47.461425+00:00",
        "billing_issue_detected_at": null,
        "is_in_grace_period": false,
        "cancellation_reason": null
      }
    ],
    "subscriptions": [
      {
        "store": "app_store",
        "store_product_id": "unlimited.9999",
        "store_base_plan_id": null,
        "store_transaction_id": "2000000815013007",
        "store_original_transaction_id": "2000000815013007",
        "offer": null,
        "environment": "Sandbox",
        "purchased_at": "2024-12-24T10:50:23+00:00",
        "originally_purchased_at": "2024-12-24T10:50:23+00:00",
        "expires_at": null,
        "renewal_cancelled_at": null,
        "billing_issue_detected_at": null,
        "is_in_grace_period": false,
        "cancellation_reason": null
      }
    ],
    "non_subscriptions": [
      {
        "purchase_id": "7a5f9a7d-e236-33e6-96d8-53a3c59c5562",
        "store": "app_store",
        "store_product_id": "1year.premium",
        "store_base_plan_id": null,
        "store_transaction_id": "30002109551456",
        "store_original_transaction_id": "30002109551456",
        "purchased_at": "2022-10-12T09:42:50+00:00",
        "environment": "Production",
        "is_refund": false,
        "is_consumable": false
      }
    ]
  }
}

未授权

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

Example 
{
  "errors": [
    {
      "source": "non_field_errors",
      "errors": [
        "Authentication credentials were not provided."
      ]
    }
  ],
  "error_code": "not_authenticated",
  "status_code": 401
}

用户画像未找到

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

Example 
{
  "errors": [
    {
      "source": null,
      "errors": [
        "Profile not found"
      ]
    }
  ],
  "error_code": "profile_does_not_exist",
  "status_code": 404
}

服务器内部错误