REST Resource: purchases.subscriptionsv2

منبع: SubscriptionPurchaseV2

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

نمایش JSON
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  },
  "etag": string,
  "outOfAppPurchaseContext": {
    object (OutOfAppPurchaseContext)
  },
  "onHoldStateContext": {
    object (OnHoldStateContext)
  },
  "inGracePeriodStateContext": {
    object (InGracePeriodStateContext)
  }
}
فیلدها
kind

string

این نوع نشان‌دهنده شیء SubscriptionPurchaseV2 در سرویس androidpublisher است.

regionCode

string

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

lineItems[]

object (SubscriptionPurchaseLineItem)

اطلاعات سطح مورد برای خرید اشتراک. همه موارد موجود در یک خرید باید از نوع AutoRenewingPlan یا PrepaidPlan باشند.

startTime

string (Timestamp format)

زمانی که اشتراک اعطا شده است. برای اشتراک‌های معلقه تنظیم نشده است (اشتراک ایجاد شده است اما درطول ثبت‌نام درانتظار پرداخت است).

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

subscriptionState

enum (SubscriptionState)

وضعیت فعلی اشتراک.

linkedPurchaseToken

string

اگر این اشتراک یکی از موارد زیر باشد، کد خرید اشتراک قدیمی: * ثبت‌نام مجدد اشتراک لغوشده اما منقضی‌نشده * ارتقا/تنزل از اشتراک قبلی. * تبدیل از پیش‌پرداخت به اشتراک تمدید خودکار. * تبدیل اشتراک تمدید خودکار به پیش‌پرداخت. * اشتراک پیش‌پرداخت را افزایش دهید.

pausedStateContext

object (PausedStateContext)

بافت اضافی درباره اشتراک‌های موقتاً متوقف‌شده. فقط درصورتی وجود دارد که اشتراک درحال‌حاضر دارای subscriptionState SUBSCRIPTION_STATE_PAUSED باشد.

canceledStateContext

object (CanceledStateContext)

بافت اضافی درباره اشتراک‌های لغوشده. فقط درصورتی وجود دارد که اشتراک درحال‌حاضر دارای subscriptionState SUBSCRIPTION_STATE_CANCELED یا SUBSCRIPTION_STATE_EXPIRED باشد.

testPurchase

object (TestPurchase)

فقط درصورتی وجود دارد که این خرید اشتراک یک خرید آزمایشی باشد.

acknowledgementState

enum (AcknowledgementState)

وضعیت تأیید اشتراک.

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

شناسه حساب کاربری در سرویس طرف سوم.

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

نمایه کاربر مرتبط با خریدهای انجام‌شده با «اشتراک با Google».

etag

string

برچسب نهادی که نشان‌دهنده وضعیت فعلی اشتراک است. توسعه‌دهنده این etag را برای کنش‌های اشتراک ارائه خواهد کرد. این etag همیشه برای اشتراک‌های پیش‌پرداخت و تمدید خودکار وجود دارد.

outOfAppPurchaseContext

object (OutOfAppPurchaseContext)

بافت اضافی برای خریدهای خارج از برنامه. این اطلاعات فقط برای خریدهای اشتراک مجدد (خریدهای اشتراکی که پس‌از منقضی شدن اشتراک قبلی همان محصول انجام شده است) که ازطریق مرکز اشتراک‌های Google Play انجام شده است وجود دارد. این فیلد پس‌از تأیید اشتراک برداشته خواهد شد.

onHoldStateContext

object (OnHoldStateContext)

اختیاری. بافت اضافی درباره اشتراک‌ها در وضعیت ON_HOLD. فقط درصورتی وجود دارد که اشتراک درحال‌حاضر دارای subscriptionState SUBSCRIPTION_STATE_ON_HOLD باشد.

inGracePeriodStateContext

object (InGracePeriodStateContext)

اختیاری. بافت اضافی درباره اشتراک‌ها در وضعیت IN_GRACE_PERIOD. فقط درصورتی وجود دارد که اشتراک درحال‌حاضر دارای subscriptionState SUBSCRIPTION_STATE_IN_GRACE_PERIOD باشد.

SubscriptionState

وضعیت‌های احتمالی که اشتراک می‌تواند داشته باشد، برای مثال فعال یا لغوشده بودن آن. موارد موجود در خرید اشتراک می‌توانند همگی طرح‌های تمدید خودکار یا طرح‌های پیش‌پرداخت باشند.

شمارشی‌ها
SUBSCRIPTION_STATE_UNSPECIFIED وضعیت اشتراک نامشخص است.
SUBSCRIPTION_STATE_PENDING اشتراک ایجاد شد اما درطول ثبت‌نام درانتظار پرداخت است. در این وضعیت، همه موارد درانتظار پرداخت هستند.
SUBSCRIPTION_STATE_ACTIVE اشتراک فعال است. - (۱) اگر اشتراک طرح تمدید خودکار باشد، حداقل یک مورد autoRenewEnabled است و منقضی نشده است. - (۲) اگر اشتراک طرح پیش‌پرداخت باشد، حداقل یک مورد منقضی نشده باشد.
SUBSCRIPTION_STATE_PAUSED اشتراک موقتاً متوقف شده است. این وضعیت فقط زمانی دردسترس است که اشتراک طرح تمدید خودکار باشد. در این حالت، همه موارد در وضعیت موقتاً متوقف‌شده قرار دارند.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD اشتراک در مهلت ارفاقی است. این وضعیت فقط زمانی دردسترس است که اشتراک طرح تمدید خودکار باشد. در این حالت، همه موارد در مهلت ارفاقی هستند.
SUBSCRIPTION_STATE_ON_HOLD اشتراک در حالت تعلیق است. این وضعیت فقط زمانی دردسترس است که اشتراک طرح تمدید خودکار باشد. در این وضعیت، همه موارد در حالت انتظار هستند.
SUBSCRIPTION_STATE_CANCELED اشتراک لغو شده است اما هنوز منقضی نشده است. این وضعیت فقط زمانی دردسترس است که اشتراک طرح تمدید خودکار باشد. همه موارد autoRenewEnabled را روی نادرست تنظیم کرده‌اند.
SUBSCRIPTION_STATE_EXPIRED اشتراک منقضی شده است. همه موارد expiryTime در گذشته دارند.
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED تراکنش معلقه برای اشتراک لغو شد. اگر این خرید معلقه برای اشتراکی موجود بود، از linkedPurchaseToken برای دریافت وضعیت فعلی آن اشتراک استفاده کنید.

PausedStateContext

اطلاعات مختص اشتراک در وضعیت موقتاً متوقف‌شده.

نمایش JSON
{
  "autoResumeTime": string
}
فیلدها
autoResumeTime

string (Timestamp format)

زمانی که اشتراک به‌طور خودکار ازسر گرفته خواهد شد.

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

CanceledStateContext

اطلاعات مختص اشتراک در وضعیت SUBSCRIPTION_STATE_CANCELED یا SUBSCRIPTION_STATE_EXPIRED.

نمایش JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of mutually exclusive fields.
}
فیلدها
دلیل لغو شدن اشتراک. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
userInitiatedCancellation

object (UserInitiatedCancellation)

اشتراک توسط کاربر لغو شد.

systemInitiatedCancellation

object (SystemInitiatedCancellation)

اشتراک توسط سیستم لغو شده است، مثلاً به‌دلیل مشکل صورت‌حساب.

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

اشتراک توسط توسعه‌دهنده لغو شد.

replacementCancellation

object (ReplacementCancellation)

اشتراک با اشتراک جدیدی جایگزین شد.

پایان فیلدهای متقابلاً انحصاری.

UserInitiatedCancellation

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

نمایش JSON
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
فیلدها
cancelSurveyResult

object (CancelSurveyResult)

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

cancelTime

string (Timestamp format)

زمانی که اشتراک توسط کاربر لغو شده است. ممکن است کاربر پس‌از این زمان همچنان به اشتراک دسترسی داشته باشد. از lineItems.expiry_time برای تعیین اینکه آیا کاربر هنوز دسترسی دارد یا نه استفاده کنید.

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

CancelSurveyResult

نتیجه نظرسنجی لغو وقتی که اشتراک توسط کاربر لغو شده است.

نمایش JSON
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
فیلدها
reason

enum (CancelSurveyReason)

دلیلی که کاربر در نظرسنجی لغو انتخاب کرده است.

reasonUserInput

string

فقط برای CANCEL_SURVEY_REASON_OTHERS تنظیم شده است. این پاسخ آزاد کاربر به نظرسنجی است.

CancelSurveyReason

دلیلی که کاربر در نظرسنجی لغو انتخاب کرده است.

شمارشی‌ها
CANCEL_SURVEY_REASON_UNSPECIFIED دلیل لغو نظرسنجی مشخص نشده است.
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE استفاده از اشتراک کافی نیست.
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES مشکلات فنی هنگام استفاده از برنامه.
CANCEL_SURVEY_REASON_FOUND_BETTER_APP کاربر برنامه بهتری پیدا کرده است.
CANCEL_SURVEY_REASON_OTHERS دلایل دیگر.

SystemInitiatedCancellation

این نوع فیلدی ندارد.

اطلاعات مختص لغوهایی که سیستم Google آغاز کرده است.

DeveloperInitiatedCancellation

این نوع فیلدی ندارد.

اطلاعات مربوط به لغوهایی که توسعه‌دهندگان شروع کرده‌اند.

ReplacementCancellation

این نوع فیلدی ندارد.

اطلاعات مختص لغوهای ناشی از جایگزینی اشتراک.

TestPurchase

این نوع فیلدی ندارد.

اینکه آیا این خرید اشتراک یک خرید آزمایشی است یا نه.

AcknowledgementState

وضعیت‌های تأیید احتمالی برای اشتراک.

شمارشی‌ها
ACKNOWLEDGEMENT_STATE_UNSPECIFIED وضعیت تأیید نامشخص.
ACKNOWLEDGEMENT_STATE_PENDING اشتراک هنوز تأیید نشده است.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED اشتراک تأیید شده است.

ExternalAccountIdentifiers

شناسه حساب کاربری در سرویس طرف سوم.

نمایش JSON
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
فیلدها
externalAccountId

string

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

obfuscatedExternalAccountId

string

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

obfuscatedExternalProfileId

string

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

SubscribeWithGoogleInfo

اطلاعات مربوط به خریدهای انجام‌شده با «مشترک شدن با Google».

نمایش JSON
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
فیلدها
profileId

string

شناسه نمایه Google کاربر هنگام خرید اشتراک.

profileName

string

نام نمایه کاربر هنگام خرید اشتراک.

emailAddress

string

نشانی ایمیل کاربر هنگام خرید اشتراک.

givenName

string

نام کاربر هنگام خرید اشتراک.

familyName

string

نام خانوادگی کاربر هنگام خرید اشتراک.

SubscriptionPurchaseLineItem

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

نمایش JSON
{
  "productId": string,
  "expiryTime": string,
  "developerTargetedOffers": [
    {
      object (DeveloperTargetedOffer)
    }
  ],
  "latestSuccessfulOrderId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of mutually exclusive fields.
  "offerDetails": {
    object (OfferDetails)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of mutually exclusive fields.
  "signupPromotion": {
    object (SignupPromotion)
  },
  "itemReplacement": {
    object (ItemReplacement)
  },
  "offerPhase": {
    object (OfferPhase)
  }
}
فیلدها
productId

string

شناسه محصول خریداری‌شده (برای مثال، «monthly001»).

expiryTime

string (Timestamp format)

زمانی که اشتراک منقضی شده است یا منقضی خواهد شد، مگراینکه دسترسی تمدید شود (مثلاً تمدید اشتراک).

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

developerTargetedOffers[]

object (DeveloperTargetedOffer)

اختیاری. جزئیات پیشنهادهای هدف‌یابی‌شده برای توسعه‌دهنده که برای این ردیف هدف ثبت شده است.

latestSuccessfulOrderId

string

شناسه سفارش آخرین سفارش موفق مرتبط با این مورد. اگر مورد هنوز متعلق به کاربر نباشد (مثلاً مورد به‌تعویق‌افتاده جایگزین شده باشد)، وجود ندارد.

نوع طرح اشتراک. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
autoRenewingPlan

object (AutoRenewingPlan)

این مورد به‌طور خودکار تمدید می‌شود.

prepaidPlan

object (PrepaidPlan)

مورد پیش‌پرداخت‌شده است.

پایان فیلدهای متقابلاً انحصاری.
offerDetails

object (OfferDetails)

جزئیات پیشنهاد ویژه برای این مورد.

وقتی موردی تغییر معوق داشته باشد، این فیلد وجود دارد. می‌توان آن را برداشت یا جایگزین کرد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
deferredItemReplacement

object (DeferredItemReplacement)

اطلاعات مربوط به تعویض معوقه محصول.

deferredItemRemoval

object (DeferredItemRemoval)

اطلاعات مربوط به برداشتن مورد به‌تعویق‌افتاده.

پایان فیلدهای متقابلاً انحصاری.
signupPromotion

object (SignupPromotion)

جزئیات تبلیغاتی درباره این مورد. فقط درصورتی تنظیم می‌شود که درطول ثبت‌نام، تبلیغی اعمال شده باشد.

itemReplacement

object (ItemReplacement)

جزئیات موردی که جایگزین می‌شود. این فیلد فقط درصورتی پر می‌شود که این مورد جایگزین مورد دیگری در اشتراک قبلی شده باشد و فقط تا ۶۰ روز پس‌از زمان خرید دردسترس است.

offerPhase

object (OfferPhase)

جزئیات مرحله پیشنهاد فعلی برای این مورد.

AutoRenewingPlan

اطلاعات مربوط به طرح با تمدید خودکار.

نمایش JSON
{
  "autoRenewEnabled": boolean,
  "recurringPrice": {
    object (Money)
  },
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  },
  "planTransitionDetails": {
    object (PlanTransitionDetails)
  },
  "priceStepUpConsentDetails": {
    object (PriceStepUpConsentDetails)
  }
}
فیلدها
autoRenewEnabled

boolean

اگر اشتراک درحال‌حاضر روی تمدید خودکار تنظیم شده باشد، مثلاً کاربر اشتراک را لغو نکرده باشد

recurringPrice

object (Money)

قیمت تکرارشونده فعلی طرح با تمدید خودکار. توجه داشته باشید که قیمت تخفیف‌ها را درنظر نمی‌گیرد و شامل مالیات نمی‌شود. برای قیمت‌گذاری بدون مالیات، لطفاً درصورت نیاز به جزئیات تراکنش، با میانای برنامه‌سازی کاربردی orders.get تماس بگیرید.

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

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

installmentDetails

object (InstallmentPlan)

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

planTransitionDetails

object (PlanTransitionDetails)

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

SubscriptionItemPriceChangeDetails

اطلاعات مربوط به تغییر قیمت محصول اشتراکی.

نمایش JSON
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
فیلدها
newPrice

object (Money)

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

priceChangeMode

enum (PriceChangeMode)

حالت تغییر قیمت مشخص می‌کند که قیمت مورد اشتراک چگونه تغییر می‌کند.

priceChangeState

enum (PriceChangeState)

وضعیت فعلی تغییر قیمت را بیان کنید.

expectedNewPriceChargeTime

string (Timestamp format)

زمان تمدیدی که تغییر قیمت برای کاربر اعمال خواهد شد. این مورد ممکن است در آینده تغییر کند (به زمان دیگری موکول شود) زیرا زمان تمدید ممکن است به‌دلیل مواردی مثل توقف موقت تغییر کند. این فیلد فقط درصورتی پر می‌شود که تغییر قیمت اعمال نشده باشد.

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

PriceChangeMode

حالت تغییر قیمت.

شمارشی‌ها
PRICE_CHANGE_MODE_UNSPECIFIED حالت تغییر قیمت مشخص نشده است. این مقدار هرگز نباید تنظیم شود.
PRICE_DECREASE اگر قیمت اشتراک درحال کاهش باشد.
PRICE_INCREASE اگر قیمت اشتراک درحال افزایش است و کاربر باید آن را بپذیرد.
OPT_OUT_PRICE_INCREASE اگر قیمت اشتراک با حالت انصراف افزایش یابد.

PriceChangeState

وضعیت تغییر قیمت.

شمارشی‌ها
PRICE_CHANGE_STATE_UNSPECIFIED وضعیت تغییر قیمت نامشخص است. از این مقدار نباید استفاده شود.
OUTSTANDING درانتظار موافقت کاربر با تغییر قیمت.
CONFIRMED تغییر قیمت برای کاربر تأیید شده است.
APPLIED تغییر قیمت اعمال شده است، یعنی کاربر شروع به پرداخت قیمت جدید کرده است.
CANCELED تغییر قیمت لغو شد.

InstallmentPlan

اطلاعات مربوط به طرح اقساطی.

نمایش JSON
{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}
فیلدها
initialCommittedPaymentsCount

integer

تعداد کل پرداخت‌هایی که کاربر در ابتدا برای آن‌ها متعهد شده است.

subsequentCommittedPaymentsCount

integer

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

remainingCommittedPaymentsCount

integer

تعداد کل پرداخت‌های متعهدشده باقی‌مانده که باید در این چرخه تمدید پرداخت شود.

pendingCancellation

object (PendingCancellation)

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

PendingCancellation

این نوع فیلدی ندارد.

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

PlanTransitionDetails

اطلاعات مربوط به انتقال طرح.

نمایش JSON
{
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "transitionInfo": {
    object (TransitionInfo)
  }
}
فیلدها
productId

string

[الزامی] شناسه محصولی که این طرح به آن منتقل می‌شود (برای مثال، «monthly001»).

basePlanId

string

[الزامی] شناسه طرح پایه که این طرح به آن منتقل می‌شود.

offerId

string

شناسه پیشنهاد ویژه. فقط برای پیشنهادهای ویژه تخفیف‌دار وجود دارد. این فقط زمانی تنظیم می‌شود که طرح هدف طرح پایه نباشد.

transitionInfo

object (TransitionInfo)

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

TransitionInfo

اطلاعات مربوط به انتقال طرح زمان‌بندی‌شده.

نمایش JSON
{
  "transitionState": enum (TransitionState),
  "price": {
    object (Money)
  },
  "expectedTransitionTime": string
}
فیلدها
transitionState

enum (TransitionState)

فقط خروجی. [الزامی] وضعیت فعلی انتقال.

price

object (Money)

قیمت طرح پایه پیش‌فرض که طرح به آن منتقل خواهد شد.

expectedTransitionTime

string (Timestamp format)

زمان موردانتظار فعلی که ممکن است طرح منتقل شود. این مورد ممکن است (به زمان دیگری در آینده) تغییر کند، زیرا در مواردی مثل توقف موقت و تعلیق حساب، زمان تمدید تغییر می‌کند.

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

TransitionState

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

شمارشی‌ها
TRANSITION_STATE_UNSPECIFIED وضعیت انتقال نامشخص.
SCHEDULED انتقال برای شروع در آینده زمان‌بندی شده است.
IN_PROGRESS فرایند انتقال آغاز شده است و اعلان انتقال اولیه برای کاربر ارسال شده است.
COMPLETED انتقال تکمیل شده است.
CANCELED انتقال لغو شد.

PriceStepUpConsentDetails

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

نمایش JSON
{
  "state": enum (ConsentState),
  "consentDeadlineTime": string,
  "newPrice": {
    object (Money)
  }
}
فیلدها
state

enum (ConsentState)

فقط خروجی. وضعیت رضایت برای افزایش قیمت.

consentDeadlineTime

string (Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

newPrice

object (Money)

قیمت جدیدی که به رضایت کاربر نیاز دارد.

ConsentState

وضعیت رضایت برای افزایش قیمت.

شمارشی‌ها
CONSENT_STATE_UNSPECIFIED حالت رضایت نامشخص.
PENDING کاربر هنوز رضایت نداده است.
CONFIRMED کاربر موافقت کرده است و قیمت جدید در انتظار اعمال شدن است.
COMPLETED کاربر موافقت کرده است و قیمت جدید اعمال شده است.

PrepaidPlan

اطلاعات مربوط به طرح پیش‌پرداخت.

نمایش JSON
{
  "allowExtendAfterTime": string
}
فیلدها
allowExtendAfterTime

string (Timestamp format)

اگر وجود داشته باشد، این زمانی است که پس‌از آن خرید افزونه برای طرح پیش‌پرداخت مجاز است. برای طرح‌های پیش‌پرداخت منقضی‌شده وجود نخواهد داشت.

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

OfferDetails

جزئیات پیشنهاد اطلاعات مربوط به مورد سطری خرید.

نمایش JSON
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
فیلدها
offerTags[]

string

جدیدترین برچسب‌های پیشنهاد ویژه مرتبط با پیشنهاد ویژه. این طرح شامل برچسب‌های به‌ارث‌رسیده از طرح پایه است.

basePlanId

string

شناسه طرح پایه. برای همه طرح‌های پایه و پیشنهادها وجود دارد.

offerId

string

شناسه پیشنهاد ویژه. فقط برای پیشنهادهای ویژه تخفیف‌دار وجود دارد.

DeferredItemReplacement

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

نمایش JSON
{
  "productId": string
}
فیلدها
productId

string

productId که قرار است جایگزین productId موجود شود.

DeferredItemRemoval

این نوع فیلدی ندارد.

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

SignupPromotion

عرضه ترویجی هنگام خرید روی این مورد اعمال شد.

نمایش JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of mutually exclusive fields.
}
فیلدها
نوع تبلیغی که برای این مورد اعمال شده است. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
oneTimeCode

object (OneTimeCode)

کد یک‌بارمصرف اعمال شد.

vanityCode

object (VanityCode)

کد سفارشی اعمال شد.

پایان فیلدهای متقابلاً انحصاری.

OneTimeCode

این نوع فیلدی ندارد.

کد ترویجی یک‌بارمصرف.

VanityCode

کد ترویجی ازپیش تعریف‌شده با امکان استفاده چندباره.

نمایش JSON
{
  "promotionCode": string
}
فیلدها
promotionCode

string

کد ترویجی.

ItemReplacement

جزئیات مربوط به قلم کالا اشتراک که درحال جایگزین شدن است.

نمایش JSON
{
  "productId": string,
  "replacementMode": enum (ReplacementMode),
  "basePlanId": string,
  "offerId": string
}
فیلدها
productId

string

شناسه محصول مورد خط اشتراک که جایگزین می‌شود.

replacementMode

enum (ReplacementMode)

حالت جایگزینی که درطول خرید اعمال شده است.

basePlanId

string

شناسه طرح پایه مورد خط اشتراک که جایگزین می‌شود.

offerId

string

شناسه پیشنهاد ویژه مورد خط اشتراک که درصورت وجود جایگزین می‌شود.

ReplacementMode

حالت جایگزینی برای اشتراک.

شمارشی‌ها
REPLACEMENT_MODE_UNSPECIFIED حالت جایگزینی نامشخص.
WITH_TIME_PRORATION طرح جدید به‌صورت تناسبی محاسبه می‌شود و اعتبار آن از طرح قدیمی کسر می‌شود.
CHARGE_PRORATED_PRICE قیمت سرشکن‌شده‌ای برای طرح جدید از کاربر کسر خواهد شد.
WITHOUT_PRORATION طرح جدید بدون محاسبه تناسبی زمان جایگزین طرح قدیمی خواهد شد.
CHARGE_FULL_PRICE قیمت کامل طرح جدید از کاربر کسر خواهد شد.
DEFERRED طرح قدیمی لغو خواهد شد و طرح جدید پس‌از منقضی شدن طرح قدیمی اعمال خواهد شد.
KEEP_EXISTING با این جایگزینی، طرح بدون تغییر باقی خواهد ماند.

OfferPhase

جزئیات مرحله پیشنهاد.

نمایش JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prorationPeriod": {
    object (ProrationPeriodOfferPhase)
  },
  "freeTrial": {
    object (FreeTrialOfferPhase)
  },
  "introductoryPrice": {
    object (IntroductoryPriceOfferPhase)
  },
  "basePrice": {
    object (BasePriceOfferPhase)
  }
  // End of mutually exclusive fields.
}
فیلدها
جزئیات مرحله پیشنهاد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
prorationPeriod

object (ProrationPeriodOfferPhase)

وقتی مرحله پیشنهاد دوره تناسبی است، تنظیم کنید.

freeTrial

object (FreeTrialOfferPhase)

وقتی مرحله پیشنهاد دوره آزمایشی رایگان است، تنظیم کنید.

introductoryPrice

object (IntroductoryPriceOfferPhase)

زمانی تنظیم می‌شود که مرحله پیشنهاد، مرحله پیشنهاد قیمت آغازین باشد.

basePrice

object (BasePriceOfferPhase)

وقتی فاز پیشنهاد فاز قیمت‌گذاری طرح پایه است، تنظیم کنید.

پایان فیلدهای متقابلاً انحصاری.

ProrationPeriodOfferPhase

جزئیات مربوط به مرحله پیشنهاد دوره سرشکن کردن.

نمایش JSON
{
  "originalOfferPhaseType": enum (OriginalOfferPhaseType)
}
فیلدها
originalOfferPhaseType

enum (OriginalOfferPhaseType)

نوع مرحله پیشنهاد اصلی قبل‌از دوره تناسبی. فقط زمانی تنظیم می‌شود که دوره تناسبی از مرحله پیشنهاد ویژه موجود به‌روز شود.

OriginalOfferPhaseType

مرحله پیشنهاد اصلی پرداخت پیشنهاد، اگر پرداخت پیشنهاد پرداخت تناسبی باشد.

شمارشی‌ها
ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED نوع مرحله پیشنهاد اصلی نامشخص است.
BASE اشتراک در مرحله قیمت‌گذاری پایه است (مثلاً قیمت کامل).
INTRODUCTORY اشتراک در مرحله قیمت‌گذاری آغازین است.
FREE_TRIAL اشتراک در دوره آزمایشی رایگان است.

FreeTrialOfferPhase

این نوع فیلدی ندارد.

جزئیات مربوط به مرحله پیشنهاد دوره آزمایشی رایگان.

IntroductoryPriceOfferPhase

این نوع فیلدی ندارد.

جزئیات مربوط به مرحله پیشنهاد قیمت آغازین.

BasePriceOfferPhase

این نوع فیلدی ندارد.

جزئیات درباره مرحله پیشنهاد قیمت پایه.

DeveloperTargetedOffer

اطلاعات مربوط به پیشنهاد هدف‌یابی‌شده توسعه‌دهنده برای مورد خط اشتراک.

نمایش JSON
{
  "offerId": string,
  "activateTime": string
}
فیلدها
offerId

string

اختیاری. شناسه پیشنهاد ویژه ایجادشده توسط توسعه‌دهنده که برای اشتراک هدف‌یابی شده است.

activateTime

string (Timestamp format)

اختیاری. زمانی که هدف‌یابی پیشنهاد فعال شد.

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

OutOfAppPurchaseContext

اطلاعات مختص خرید خارج از برنامه.

نمایش JSON
{
  "expiredExternalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "expiredPurchaseToken": string
}
فیلدها
expiredExternalAccountIdentifiers

object (ExternalAccountIdentifiers)

شناسه حساب کاربری از آخرین اشتراک منقضی‌شده برای این SKU.

expiredPurchaseToken

string

نشان خرید آخرین اشتراک منقضی‌شده. این کد خرید فقط باید برای کمک به شناسایی کاربر استفاده شود، درصورتی‌که پیوند بین purchaseToken و کاربر در پایگاه داده شما ذخیره شده باشد. اگر بیش‌از ۶۰ روز از انقضا گذشته باشد، نمی‌توان از آن برای فراخوانی Google Developer API استفاده کرد.

OnHoldStateContext

بافت اضافی درباره اشتراک‌ها در وضعیت ON_HOLD.

نمایش JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
فیلدها
دلیل اینکه اشتراک در وضعیت ON_HOLD (درانتظار) است. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
renewalDeclined

object (RenewalDeclinedContext)

اختیاری. پرداخت برای تمدید رد شد.

پایان فیلدهای متقابلاً انحصاری.

RenewalDeclinedContext

زمینه مربوط به سناریوی رد شدن تمدید.

نمایش JSON
{
  "pendingOrderId": string
}
فیلدها
pendingOrderId

string

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

InGracePeriodStateContext

بافت اضافی درباره اشتراک‌ها در وضعیت IN_GRACE_PERIOD.

نمایش JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
فیلدها
دلیل اینکه اشتراک در وضعیت IN_GRACE_PERIOD است. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
renewalDeclined

object (RenewalDeclinedContext)

اختیاری. پرداخت برای تمدید رد شد.

پایان فیلدهای متقابلاً انحصاری.

روش‌ها

activateoffertargeting

هدف‌یابی را برای پیشنهاد ویژه‌ای خاص فعال می‌کند.

cancel

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

cancelplantransition

انتقال طرح را برای اشتراکی لغو کنید.

deactivateoffertargeting

هدف‌یابی را برای پیشنهادی خاص غیرفعال می‌کند.

defer

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

get

دریافت فراداده درباره اشتراک

revoke

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

scheduleplantransition

انتقال طرح را برای اشتراک زمان‌بندی کنید.

کدهای خطا

عملیات این منبع، کدهای خطای HTTP زیر را برمی‌گرداند:

کد خطا استدلال شرح وضوح
400 / 410 subscriptionExpired اشتراک منقضی شده است و عملیات درخواستی نمی‌تواند انجام شود. زمان انقضای اشتراک را بررسی کنید. این عملیات در اشتراک‌های منقضی‌شده مجاز نیست.
400 subscriptionInvalidArgument متغیر مستقل نامعتبری در درخواست اشتراک ارائه شده است. سند API را مرور کنید و مطمئن شوید که همه فیلدهای الزامی ارائه شده‌اند و به‌درستی قالب‌بندی شده‌اند.
400 invalidPurchaseState خرید در وضعیت معتبری برای انجام عملیات درخواستی نیست. برای مثال، ممکن است بخواهید خریدی را که قبلاً مصرف شده است تأیید کنید یا اشتراکی را که فعال نیست لغو کنید. قبل‌از تلاش برای انجام عملیات، وضعیت فعلی منبع را بااستفاده از Get API مربوطه بررسی کنید. مطمئن شوید منبع در وضعیت مناسبی برای این کنش قرار دارد.
400 invalidValue مقدار نامعتبری در درخواست ارائه شده است. این خطا اغلب برای کد خرید نامعتبر یا بدشکل برگردانده می‌شود. مقدار فیلد نامعتبر را در متن درخواست یا پارامترها براساس مرجع میانای برنامه‌سازی کاربردی اصلاح کنید.
400 prepaidSubscriptionNotSupported عملیات درخواست‌شده برای اشتراک‌های پیش‌پرداخت پشتیبانی نمی‌شود. مطمئن شوید که عملیات برای نوع اشتراک قابل‌اجرا است. این خطا مختص روش‌هایی مانند «لغو» است.
400 productNotOwnedByUser ژتون خرید ارائه‌شده معتبر است، اما کاربر درحال‌حاضر مالک محصول نیست. این اتفاق زمانی می‌افتد که خرید قبل‌از تأیید، مسترد، لغو، یا منقضی شده باشد. قبل‌از تلاش برای انجام عملیات، وضعیت فعلی منبع را بااستفاده از Get API مربوطه بررسی کنید. مطمئن شوید منبع در وضعیت مناسبی برای این کنش قرار دارد.
400 purchaseTokenMismatch ژتون خرید ارائه‌شده با خرید، نام بسته، شناسه اشتراک، یا شناسه محصول مطابقت ندارد. تأیید کنید که همه جزئیات درخواست صحیح و مطابق با یکدیگر باشند.
400 required فیلد یا پارامتر الزامی در درخواست وجود ندارد. برای اطمینان از اینکه همه فیلدها و پارامترهای اجباری گنجانده شده‌اند، به اسناد API مراجعه کنید.
400 unsupportedIabType این عملیات برای نوع «خدمات صدور صورت‌حساب درون‌برنامه» ارائه‌شده پشتیبانی نمی‌شود. مطمئن شوید روش API با نوع موردی که مدیریت می‌شود سازگار باشد.
403 userInsufficientPermission کاربر اجازه کافی برای انجام عملیات درخواستی را ندارد. مطمئن شوید کاربر اصالت‌سنجی‌شده اجازه‌های لازم را در Google Play Console داشته باشد. برای جزئیات بیشتر، استفاده از حساب سرویس را ببینید.
404 notFound منبع درخواستی پیدا نشد. درستی‌سنجی کنید که شناسه‌ها (برای نمونه، کد خرید، نام بسته، شناسه محصول، شناسه اشتراک) صحیح باشند.
409 concurrentUpdate تلاشی برای به‌روزرسانی شیئی که هم‌زمان درحال به‌روزرسانی است انجام شد. درخواست را با عقب‌گرد نمایی تکرار کنید. از اصلاح هم‌زمان یک منبع خودداری کنید.
410 purchaseTokenNoLongerValid ژتون خرید برای همیشه نامعتبر است زیرا حساب کاربری مرتبط حذف شده است یا سابقه خرید دیگر وجود ندارد. استفاده از این کد خرید را متوقف کنید.
410 subscriptionNoLongerAvailable خرید اشتراک دیگر برای پُرسمان دردسترس نیست زیرا مدت زیادی از انقضای آن گذشته است. این خطا نشان می‌دهد که اشتراک بیش‌از ۶۰ روز است که منقضی شده است. دیگر نباید این اشتراک‌ها را پُرسمان کنید.
5xx Generic error خطای عمومی در سرور Google Play. درخواستتان را دوباره امتحان کنید.

اگر مشکل برطرف نشد، با مدیر حساب Google Play خود تماس بگیرید یا درخواست پشتیبانی ارسال کنید. برای اطلاع از قطعی‌های شناخته‌شده، داشبورد وضعیت Play را بررسی کنید.