PATCH /api/v2/server-side-api/profile/

Cập nhật hồ sơ người dùng

Cập nhật thông tin hồ sơ người dùng

Header parameters

adapty-customer-user-idstring

ID duy nhất của khách hàng trong hệ thống của bạn. Cần cung cấp một trong hai giá trị adapty-customer-user-id hoặc adapty-profile-id.

adapty-profile-idstring

ID duy nhất của hồ sơ người dùng trong hệ thống của bạn. Lựa chọn tốt nhất khi làm việc với các hồ sơ người dùng ẩn danh. Cần cung cấp một trong hai giá trị adapty-customer-user-id hoặc adapty-profile-id.

Request body

first_namestring

Tên của người dùng cuối của bạn

last_namestring

Họ của người dùng cuối của bạn

genderstring

Giới tính của người dùng cuối của bạn

One of: "f", "m", "o"

emailstring

Email của người dùng cuối của bạn

phone_numberstring

Số điện thoại của người dùng cuối của bạn

birthdaystring

Ngày sinh của người dùng cuối của bạn

ip_countrystring

Quốc gia của người dùng cuối dưới dạng mã ISO 3166-1 alpha-2 gồm hai chữ cái, ví dụ FR

ip_v4_addressstring

Địa chỉ IPv4 của người dùng cuối

store_countrystring

Quốc gia của cửa hàng ứng dụng của người dùng cuối dưới dạng mã ISO 3166-1 alpha-2 gồm hai chữ cái, ví dụ US

storestring

Nền tảng người dùng sử dụng để thực hiện in-app purchase trong ứng dụng của bạn

One of: "app_store", "play_store", "stripe", "adapty", "paddle"

store_account_tokenstring

Token tài khoản cửa hàng

att_statusinteger

Trạng thái Apple App Tracking Transparency (0=chưa xác định, 1=bị hạn chế, 2=bị từ chối, 3=đã cho phép)

One of: 0, 1, 2, 3

analytics_disabledboolean

Tùy chọn để từ chối analytics bên ngoài

custom_attributesarray of object

Cho phép thiết lập tối đa 30 thuộc tính tùy chỉnh cho hồ sơ người dùng

keystringrequired

Khóa phải là một chuỗi không quá 30 ký tự. Chỉ cho phép các chữ cái, số, dấu gạch ngang, dấu chấm và dấu gạch dưới

valuestring | numberrequired

Giá trị thuộc tính không được vượt quá 50 ký tự. Chỉ cho phép chuỗi và số thực (float) làm giá trị

installation_metaobjectrequired

device_idstringrequired

Mã định danh thiết bị duy nhất

devicestring

Thông tin thiết bị

localestring

Ngôn ngữ thiết bị

osstring

Thông tin hệ điều hành

platformstring

Nền tảng (iOS, Android, v.v.)

One of: "iOS", "macOS", "iPadOS", "Android", "visionOS", "web"

timezonestring

Múi giờ thiết bị

user_agentstring

Chuỗi user agent

app_buildstring

Phiên bản build của ứng dụng

app_versionstring

Phiên bản ứng dụng

adapty_sdk_versionstring

Phiên bản SDK Adapty

idfastring

Mã định danh cho nhà quảng cáo trên iOS

idfvstring

Mã định danh cho nhà cung cấp trên iOS

advertising_idstring

ID quảng cáo Android

android_idstring

ID thiết bị Android

android_app_set_idstring

ID tập hợp ứng dụng Android

Responses

Hồ sơ người dùng được cập nhật thành công

Schema

dataobjectrequired

app_idstringrequired

ID nội bộ của ứng dụng của bạn

profile_idstringrequired

ID hồ sơ người dùng Adapty

customer_user_idstringrequired

ID của người dùng trong hệ thống của bạn

total_revenue_usdnumberrequired

Giá trị số thực đại diện cho tổng doanh thu tính bằng USD thu được trong hồ sơ người dùng

segment_hashstringrequired

Tham số nội bộ

timestampintegerrequired

Thời gian phản hồi tính bằng mili giây, dùng để giải quyết race condition

custom_attributesarray of objectrequired

Tối đa 30 thuộc tính tùy chỉnh được phép thiết lập cho hồ sơ người dùng

keystringrequired

Khóa phải là một chuỗi không quá 30 ký tự. Chỉ cho phép các chữ cái, số, dấu gạch ngang, dấu chấm và dấu gạch dưới

valuestring | numberrequired

Giá trị thuộc tính không được vượt quá 50 ký tự. Chỉ cho phép chuỗi và số thực (float) làm giá trị

access_levelsarray of objectrequired

Mảng các đối tượng mức độ truy cập. Mảng rỗng nếu khách hàng không có mức độ truy cập nào

access_level_idstring

Mã định danh mức độ truy cập

storestring

Cửa hàng nơi mức độ truy cập được mua

store_product_idstring

ID sản phẩm trong cửa hàng

store_base_plan_idstring

ID gói cơ bản trong cửa hàng

store_transaction_idstring

ID giao dịch trong cửa hàng

store_original_transaction_idstring

ID giao dịch gốc trong cửa hàng

offerallOf

Chi tiết ưu đãi, nếu có ưu đãi hoặc ưu đãi giới thiệu được áp dụng

categorystring

Danh mục ưu đãi

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

typestring

Loại ưu đãi

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

idstring

ID ưu đãi

starts_atstring

Thời điểm mức độ truy cập bắt đầu

purchased_atstring

Thời điểm mức độ truy cập được mua

originally_purchased_atstring

Thời điểm mức độ truy cập được mua lần đầu

expires_atstring

Thời điểm mức độ truy cập hết hạn

renewal_cancelled_atstring

Thời điểm gia hạn bị hủy

billing_issue_detected_atstring

Thời điểm phát hiện sự cố thanh toán

is_in_grace_periodboolean

Mức độ truy cập có đang trong thời gian ân hạn hay không

cancellation_reasonstring

Lý do hủy

subscriptionsarray of objectrequired

Mảng các đối tượng gói đăng ký. Mảng rỗng nếu khách hàng không có gói đăng ký nào

storestring

Cửa hàng nơi gói đăng ký được mua

store_product_idstring

ID sản phẩm trong cửa hàng

store_base_plan_idstring

ID gói cơ bản trong cửa hàng

store_transaction_idstring

ID giao dịch trong cửa hàng

store_original_transaction_idstring

ID giao dịch gốc trong cửa hàng

offerallOf

Chi tiết ưu đãi, nếu có ưu đãi hoặc ưu đãi giới thiệu được áp dụng

categorystring

Danh mục ưu đãi

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

typestring

Loại ưu đãi

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

idstring

ID ưu đãi

environmentstring

Môi trường (Sandbox, Production)

purchased_atstring

Thời điểm gói đăng ký được mua

originally_purchased_atstring

Thời điểm gói đăng ký được mua lần đầu

expires_atstring

Thời điểm gói đăng ký hết hạn

renewal_cancelled_atstring

Thời điểm hủy gia hạn

billing_issue_detected_atstring

Thời điểm phát hiện sự cố thanh toán

is_in_grace_periodboolean

Gói đăng ký có đang trong thời gian ân hạn hay không

cancellation_reasonstring

Lý do hủy

non_subscriptionsarray of objectrequired

Mảng các đối tượng sản phẩm mua một lần. Mảng rỗng nếu khách hàng chưa thực hiện giao dịch mua nào

purchase_idstring

Mã định danh mua hàng duy nhất

storestring

Cửa hàng nơi thực hiện giao dịch mua

store_product_idstring

ID sản phẩm trong cửa hàng

store_base_plan_idstring

ID gói cơ bản trong cửa hàng

store_transaction_idstring

ID giao dịch trong cửa hàng

store_original_transaction_idstring

ID giao dịch gốc trong cửa hàng

purchased_atstring

Thời điểm thực hiện giao dịch mua

environmentstring

Môi trường (Sandbox, Production)

is_refundboolean

Liệu đây có phải là giao dịch hoàn tiền hay không

is_consumableboolean

Liệu đây có phải là giao dịch mua consumable hay không

Yêu cầu không hợp lệ

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc của lỗi

errorsarray of string

Mảng các thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Không được phép truy cập

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc của lỗi

errorsarray of string

Mảng các thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Không tìm thấy hồ sơ người dùng

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc của lỗi

errorsarray of string

Mảng các thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Lỗi máy chủ nội bộ

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

Body

curl --request PATCH \
  --url 'https://api.adapty.io/api/v2/server-side-api/profile/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/profile/', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
  },
});
const data = await response.json();

import requests

response = requests.patch('https://api.adapty.io/api/v2/server-side-api/profile/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
})
data = response.json()