/api/v2/server-side-api/profile/ プロファイルを取得する
アプリの既存エンドユーザーの詳細を取得します。
Header parameters
お客様のシステムにおける顧客の一意の ID です。adapty-customer-user-id または adapty-profile-id のいずれかが必須です。
お客様のシステムにおけるプロファイルの一意の ID です。匿名プロファイルを扱う場合に最適です。adapty-customer-user-id または adapty-profile-id のいずれかが必須です。
Responses
プロファイルが正常に取得されました
Schema
アプリの内部 ID
Adapty プロファイル ID
お客様のシステムにおけるユーザーの ID
プロファイルで獲得した USD 換算の総収益を表す浮動小数点値
内部パラメータ
レスポンス時刻（ミリ秒）。競合状態の解決に使用します
プロファイルに設定できるカスタム属性は最大 30 個です
キーは 30 文字以下の文字列である必要があります。英字、数字、ダッシュ、ピリオド、アンダースコアのみ使用できます
属性値は 50 文字以下である必要があります。文字列と浮動小数点数のみ使用できます
アクセスレベルオブジェクトの配列。顧客がアクセスレベルを持たない場合は空配列
アクセスレベルの識別子
アクセスレベルが購入されたストア
ストアにおけるプロダクト ID
ストアにおけるベースプラン ID
ストアにおけるトランザクション ID
ストアにおける元のトランザクション ID
プロモーションオファーまたは初回オファーが適用された場合のオファー詳細
オファーのカテゴリ
One of: "introductory", "promotional", "offer_code", "win_back"
オファーの種別
One of: "free_trial", "pay_as_you_go", "pay_up_front"
オファー ID
アクセスレベルの開始日時
アクセスレベルが購入された日時
アクセスレベルが最初に購入された日時
アクセスレベルの有効期限
更新がキャンセルされた日時
請求問題が検出された日時
アクセスレベルがグレース期間中かどうか
キャンセルの理由
サブスクリプションオブジェクトの配列。顧客がサブスクリプションを持たない場合は空配列
サブスクリプションが購入されたストア
ストアにおけるプロダクト ID
ストアにおけるベースプラン ID
ストアにおけるトランザクション ID
ストアにおける元のトランザクション ID
プロモーションオファーまたは初回オファーが適用された場合のオファー詳細
オファーのカテゴリ
One of: "introductory", "promotional", "offer_code", "win_back"
オファーの種別
One of: "free_trial", "pay_as_you_go", "pay_up_front"
オファー ID
環境（サンドボックス、本番）
サブスクリプションが購入された日時
サブスクリプションが最初に購入された日時
サブスクリプションの有効期限
更新がキャンセルされた日時
請求問題が検出された日時
サブスクリプションがグレース期間中かどうか
キャンセルの理由
非サブスクリプションオブジェクトの配列。顧客が購入履歴を持たない場合は空配列
購入の一意の識別子
購入が行われたストア
ストアにおけるプロダクト ID
ストアにおけるベースプラン ID
ストアにおけるトランザクション ID
ストアにおける元のトランザクション ID
購入が行われた日時
環境（サンドボックス、本番）
返金かどうか
消耗型アイテムの購入かどうか
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
エラーの発生源
エラーメッセージの配列
エラーの短縮名
HTTP ステータスコード
Example
{
"errors": [
{
"source": "non_field_errors",
"errors": [
"Authentication credentials were not provided."
]
}
],
"error_code": "not_authenticated",
"status_code": 401
}プロファイルが見つかりません
Schema
エラーの発生源
エラーメッセージの配列
エラーの短縮名
HTTP ステータスコード
Example
{
"errors": [
{
"source": null,
"errors": [
"Profile not found"
]
}
],
"error_code": "profile_does_not_exist",
"status_code": 404
}内部サーバーエラー