REST Resource: purchases.subscriptions

منبع: SubscriptionPurchase

یک منبع SubscriptionPurchase وضعیت خرید اشتراک کاربر را نشان می دهد.

نمایندگی JSON 
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
فیلدها
kind

string

این نوع نشان دهنده یک شیء اشتراک خرید در سرویس androidpublisher است.

start Time Millis

string ( int64 format)

زمانی که در آن اشتراک اعطا شد، بر حسب میلی ثانیه از دوران.

expiry Time Millis

string ( int64 format)

زمانی که در آن اشتراک منقضی می‌شود، بر حسب میلی‌ثانیه از دوران.

auto Resume Time Millis

string ( int64 format)

زمانی که در آن اشتراک به طور خودکار از سر گرفته می شود، در میلی ثانیه از زمان. فقط در صورتی ارائه شود که کاربر درخواست توقف اشتراک را داشته باشد.

auto Renewing

boolean

آیا اشتراک زمانی که به زمان انقضای فعلی خود برسد به طور خودکار تمدید می شود یا خیر.

price Currency Code

string

کد ارز ISO 4217 برای قیمت اشتراک. برای مثال، اگر قیمت به پوند استرلینگ بریتانیا مشخص شده باشد، PriceCurrencyCode "GBP" است.

price Amount Micros

string ( int64 format)

قیمت اشتراک، برای کشورهای بدون مالیات، قیمت شامل مالیات نمی شود. برای کشورهایی که شامل مالیات می شوند، قیمت شامل مالیات می شود. قیمت در واحدهای خرد بیان می شود که در آن 1,000,000 میکرو واحد نشان دهنده یک واحد ارز است. به عنوان مثال، اگر قیمت اشتراک 1.99 یورو باشد، قیمتAmountMicros 1990000 است.

introductory Price Info

object ( IntroductoryPriceInfo )

اطلاعات قیمت مقدماتی اشتراک. این تنها زمانی وجود دارد که اشتراک با قیمت مقدماتی خریداری شده باشد.

این قسمت نشان نمی دهد که اشتراک در حال حاضر در دوره قیمت اولیه است.

country Code

string

کد کشور/منطقه صورت‌حساب ISO 3166-1 آلفا-2 کاربر در زمان اعطای اشتراک.

developer Payload

string

یک رشته مشخص شده توسط توسعه دهنده که حاوی اطلاعات تکمیلی در مورد یک سفارش است.

payment State

integer

وضعیت پرداخت اشتراک. مقادیر ممکن عبارتند از: 0. پرداخت در انتظار 1. پرداخت دریافت شده 2. آزمایشی رایگان 3. در انتظار ارتقا/کاهش به تعویق افتاده

برای اشتراک های لغو شده و منقضی شده وجود ندارد.

cancel Reason

integer

دلیل لغو یا عدم تمدید خودکار اشتراک. مقادیر ممکن عبارتند از: 0. کاربر اشتراک را لغو کرد 1. اشتراک توسط سیستم لغو شد، برای مثال به دلیل مشکل صورت‌حساب، 2. اشتراک با یک اشتراک جدید جایگزین شد. 3. اشتراک توسط توسعه‌دهنده لغو شد.

user Cancellation Time Millis

string ( int64 format)

زمانی که در آن اشتراک توسط کاربر لغو شد، بر حسب میلی ثانیه از آن دوره. فقط در صورتی ارائه شود که cancelReason 0 باشد.

cancel Survey Result

object ( SubscriptionCancelSurveyResult )

اطلاعات ارائه شده توسط کاربر هنگام تکمیل جریان لغو اشتراک (نظرسنجی دلیل لغو).

order Id

string

شناسه سفارش آخرین سفارش تکراری مرتبط با خرید اشتراک. اگر اشتراک به دلیل رد شدن پرداخت لغو شد، این شناسه سفارش از سفارش رد شده پرداخت خواهد بود.

linked Purchase Token

string

نشانه خرید خرید مبدأ در صورتی که این اشتراک یکی از موارد زیر باشد: 0. ثبت نام مجدد اشتراک لغو شده اما بدون پایان 1. ارتقا/کاهش از اشتراک قبلی

به عنوان مثال، فرض کنید یک کاربر در ابتدا ثبت نام کرده است و شما رمز خرید X را دریافت می کنید، سپس کاربر آن را لغو کرده و از جریان ثبت نام (قبل از اتمام اشتراک خود) عبور می کند و شما رمز خرید Y را دریافت می کنید و در نهایت کاربر اشتراک خود را ارتقا می دهد و شما خرید را دریافت می کنید. نشانه Z. اگر این API را با رمز خرید Z فراخوانی کنید، این فیلد روی Y تنظیم می شود. اگر این API را با نشانه خرید Y فراخوانی کنید، این فیلد روی X تنظیم می شود. شما این API را با توکن خرید X می نامید، این فیلد تنظیم نخواهد شد.

purchase Type

integer

نوع خرید اشتراک. این فیلد فقط در صورتی تنظیم می‌شود که این خرید با استفاده از جریان استاندارد صورت‌حساب درون برنامه‌ای انجام نشده باشد. مقادیر ممکن عبارتند از: 0. تست (یعنی خریداری شده از یک حساب آزمایشی مجوز) 1. تبلیغاتی (یعنی با استفاده از کد تبلیغاتی خریداری شده است)

price Change

object ( SubscriptionPriceChange )

آخرین اطلاعات تغییر قیمت موجود است. این تنها زمانی وجود دارد که تغییر قیمت آتی برای اشتراک هنوز اعمال نشده باشد.

پس از تمدید اشتراک با قیمت جدید یا لغو اشتراک، هیچ اطلاعات تغییر قیمت برگردانده نخواهد شد.

profile Name

string

نام نمایه کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

email Address

string

آدرس ایمیل کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

given Name

string

نام داده شده کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

family Name

string

نام خانوادگی کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

profile Id

string

شناسه نمایه Google کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

acknowledgement State

integer

وضعیت تأیید محصول اشتراک. مقادیر ممکن عبارتند از: 0. هنوز باید تایید شود 1. تایید

external Account Id

string

شناسه حساب کاربری در سرویس شخص ثالث. فقط در صورتی ارائه شود که پیوند حساب به عنوان بخشی از جریان خرید اشتراک اتفاق افتاده باشد.

promotion Type

integer

نوع تبلیغات اعمال شده در این خرید. این فیلد تنها در صورتی تنظیم می‌شود که هنگام خرید اشتراک، تبلیغی اعمال شود. مقادیر ممکن عبارتند از: 0. کد یکبار مصرف 1. کد غرور

promotion Code

string

کد تبلیغاتی اعمال شده در این خرید. این فیلد فقط در صورتی تنظیم می‌شود که هنگام خرید اشتراک، یک تبلیغ کد بیهوده اعمال شود.

obfuscated External Account Id

string

یک نسخه مبهم از شناسه که به طور منحصر به فرد با حساب کاربر در برنامه شما مرتبط است. برای خریدهای زیر ارائه دهید: * اگر پیوند حساب به عنوان بخشی از جریان خرید اشتراک اتفاق افتاده باشد. * هنگام خرید با استفاده از https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid مشخص شد.

obfuscated External Profile Id

string

یک نسخه مبهم از شناسه که به طور منحصر به فرد با نمایه کاربر در برنامه شما مرتبط است. فقط در صورت مشخص شدن با استفاده از https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid هنگام خرید.

IntroductoryPriceInfo

حاوی اطلاعات قیمت مقدماتی برای اشتراک است.

نمایندگی JSON 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
فیلدها
introductory Price Currency Code

string

کد ارز ISO 4217 برای قیمت اشتراک مقدماتی. برای مثال، اگر قیمت به پوند استرلینگ بریتانیا مشخص شده باشد، PriceCurrencyCode "GBP" است.

introductory Price Amount Micros

string ( int64 format)

قیمت اولیه اشتراک بدون احتساب مالیات. واحد پول همان priceCurrencyCode است. قیمت در واحدهای خرد بیان می شود که در آن 1,000,000 میکرو واحد نشان دهنده یک واحد ارز است. به عنوان مثال، اگر قیمت اشتراک 1.99 یورو باشد، قیمتAmountMicros 1990000 است.

introductory Price Period

string

دوره قیمت اولیه، مشخص شده در قالب ISO 8601. مقادیر رایج عبارتند از (اما نه محدود به) "P1W" (یک هفته)، "P1M" (یک ماه)، "P3M" (سه ماه)، "P6M" (شش ماه)، و "P1Y" (یک سال).

introductory Price Cycles

integer

تعداد دوره صورتحساب برای ارائه قیمت اولیه.

اشتراک CancelSurveyResult

اطلاعات ارائه شده توسط کاربر هنگام تکمیل جریان لغو اشتراک (نظرسنجی دلیل لغو).

نمایندگی JSON 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
فیلدها
cancel Survey Reason

integer

دلیل لغوی که کاربر در نظرسنجی انتخاب کرده است. مقادیر ممکن عبارتند از: 0. سایر 1. من به اندازه کافی از این سرویس استفاده نمی کنم 2. مسائل فنی 3. دلایل مربوط به هزینه 4. برنامه بهتری پیدا کردم

user Input Cancel Reason

string

دلیل لغو ورودی سفارشی شده از کاربر. فقط زمانی ارائه می شود که cancelReason 0 باشد.

تغییر قیمت اشتراک

حاوی اطلاعات تغییر قیمت برای یک اشتراک است که می تواند برای کنترل سفر کاربر برای تغییر قیمت در برنامه استفاده شود. این می تواند به صورت جستجوی تأیید از کاربر یا ایجاد تجربه برای یک تبدیل موفق باشد.

نمایندگی JSON 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
فیلدها
new Price

object ( Price )

در صورت پذیرش تغییر قیمت توسط کاربر، اشتراک با قیمت جدیدی تمدید خواهد شد.

state

integer

وضعیت فعلی تغییر قیمت. مقادیر ممکن عبارتند از: 0. برجسته: وضعیت برای تغییر قیمت معلق در انتظار موافقت کاربر. در این حالت، می‌توانید به‌صورت اختیاری با استفاده از API درون‌برنامه، از کاربر تأییدیه بگیرید. 1. Accepted: برای تغییر قیمت پذیرفته شده اعلام کنید که اشتراک با آن تمدید می شود مگر اینکه لغو شود. تغییر قیمت در تاریخ آینده زمانی که اشتراک تمدید می شود، اعمال می شود. توجه داشته باشید که این تغییر ممکن است در زمان تمدید اشتراک بعدی رخ ندهد.

روش ها

acknowledge

 خرید اشتراک را تایید می کند.

cancel

 خرید اشتراک کاربر را لغو می کند.

defer

 خرید اشتراک کاربر را تا زمان انقضای مشخصی در آینده به تعویق می‌اندازد.

get

 بررسی می کند که آیا خرید اشتراک کاربر معتبر است یا خیر و زمان انقضای آن را برمی گرداند.

refund

 خرید اشتراک کاربر را بازپرداخت می‌کند، اما اشتراک تا زمان انقضای آن معتبر باقی می‌ماند و به تکرار ادامه می‌دهد.

revoke

 خرید اشتراک کاربر را بازپرداخت و بلافاصله لغو می کند.