REST Resource: purchases.subscriptionsv2

منبع: SubscriptionPurchaseV2

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

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

string

این نوع، یک شیء SubscriptionPurchaseV2 را در سرویس androidpublisher نشان می‌دهد.

regionCode

string

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

lineItems[]

object ( SubscriptionPurchaseLineItem )

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

startTime

string ( Timestamp format)

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

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

subscriptionState

enum ( SubscriptionState )

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

latestOrderId
(deprecated)

string

منسوخ شده: به جای آن از lineItems.latest_successful_order_id استفاده کنید. شناسه سفارش آخرین سفارش مرتبط با خرید اشتراک. برای اشتراک با تمدید خودکار، این شناسه سفارش ثبت نام در صورتی است که هنوز تمدید نشده باشد، یا آخرین شناسه سفارش تکرارشونده (سفارش موفق، در انتظار یا رد شده) است. برای اشتراک پیش‌پرداخت، این شناسه سفارش مرتبط با توکن خرید درخواست شده است.

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 )

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

outOfAppPurchaseContext

object ( OutOfAppPurchaseContext )

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

وضعیت اشتراک

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

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

PausedStateContext

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

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

string ( Timestamp format)

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

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

لغو شدهStateContext

اطلاعات مربوط به اشتراکی که در وضعیت SUBSCRIPTION_STATE_CANCELED یا SUBSCRIPTION_STATE_EXPIRED قرار دارد.

نمایش JSON 
{

  // Union field cancellation_reason can be only one of the following:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of list of possible types for union field cancellation_reason.
}
فیلدها
فیلد union cancellation_reason . دلیل لغو اشتراک. cancellation_reason فقط می‌تواند یکی از موارد زیر باشد:
userInitiatedCancellation

object ( UserInitiatedCancellation )

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

systemInitiatedCancellation

object ( SystemInitiatedCancellation )

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

developerInitiatedCancellation

object ( DeveloperInitiatedCancellation )

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

replacementCancellation

object ( ReplacementCancellation )

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

لغو به درخواست کاربر

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

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

object ( CancelSurveyResult )

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

cancelTime

string ( Timestamp format)

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

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

لغونتیجه نظرسنجی

نتیجه نظرسنجی لغو اشتراک، زمانی که کاربر اشتراک را لغو کرده است.

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

enum ( CancelSurveyReason )

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

reasonUserInput

string

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

لغونظرسنجیدلیل

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

انوم‌ها
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 دلایل دیگر.

لغو آغاز شده توسط سیستم

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

اطلاعات مربوط به لغوهای آغاز شده توسط سیستم گوگل.

لغو درخواست توسعه‌دهنده

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

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

لغو جایگزینی

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

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

خرید آزمایشی

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

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

وضعیت تقدیر و تشکر

تأییدیه احتمالی برای اشتراک بیان شده است.

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

شناسه‌های حساب خارجی

شناسه حساب کاربری در سرویس شخص ثالث.

نمایش 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 مشخص شده باشد.

با اطلاعات گوگل مشترک شوید

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

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

string

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

profileName

string

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

emailAddress

string

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

givenName

string

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

familyName

string

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

اشتراکخرید کالا

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

نمایش JSON 
{
  "productId": string,
  "expiryTime": string,
  "latestSuccessfulOrderId": string,

  // Union field plan_type can be only one of the following:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of list of possible types for union field plan_type.
  "offerDetails": {
    object (OfferDetails)
  },

  // Union field deferred_item_change can be only one of the following:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of list of possible types for union field deferred_item_change.
  "signupPromotion": {
    object (SignupPromotion)
  },
  "itemReplacement": {
    object (ItemReplacement)
  }
}
فیلدها
productId

string

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

expiryTime

string ( Timestamp format)

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

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

latestSuccessfulOrderId

string

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

فیلد plan_type از نوع Union. نوع طرح اشتراک plan_type فقط می‌تواند یکی از موارد زیر باشد:
autoRenewingPlan

object ( AutoRenewingPlan )

کالا به صورت خودکار تمدید می‌شود.

prepaidPlan

object ( PrepaidPlan )

کالا پیش پرداخت شده است.

offerDetails

object ( OfferDetails )

جزئیات پیشنهاد برای این کالا

فیلد مشترک deferred_item_change . این فیلد زمانی وجود دارد که یک آیتم تغییر معوق داشته باشد. می‌تواند حذف یا جایگزین شود. deferred_item_change فقط می‌تواند یکی از موارد زیر باشد:
deferredItemReplacement

object ( DeferredItemReplacement )

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

deferredItemRemoval

object ( DeferredItemRemoval )

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

signupPromotion

object ( SignupPromotion )

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

itemReplacement

object ( ItemReplacement )

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

طرح تمدید خودکار

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

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

boolean

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

recurringPrice

object ( Money )

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

priceChangeDetails

object ( SubscriptionItemPriceChangeDetails )

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

installmentDetails

object ( InstallmentPlan )

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

اشتراکقیمتتغییر جزئیات

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

نمایش 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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

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

نحوه تغییر قیمت.

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

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

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

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

طرح اقساطی

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

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

integer

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

subsequentCommittedPaymentsCount

integer

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

remainingCommittedPaymentsCount

integer

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

pendingCancellation

object ( PendingCancellation )

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

لغو در انتظار

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

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

جزئیات افزایش قیمت

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

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

enum ( ConsentState )

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

consentDeadlineTime

string ( Timestamp format)

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

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

newPrice

object ( Money )

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

رضایت‌نامه

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

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

طرح پیش‌پرداخت

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

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

string ( Timestamp format)

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

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

جزئیات پیشنهاد

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

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

string

آخرین برچسب‌های پیشنهاد مرتبط با پیشنهاد. این شامل برچسب‌هایی است که از طرح پایه به ارث رسیده‌اند.

basePlanId

string

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

offerId

string

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

جایگزینی مورد معوق

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

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

string

شناسه محصول (productId) جایگزین شناسه محصول موجود خواهد شد.

حذف مورد معوق

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

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

ثبت نامتبلیغات

این پیشنهاد ویژه هنگام خرید برای این کالا اعمال شده است.

نمایش JSON 
{

  // Union field promotion_type can be only one of the following:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of list of possible types for union field promotion_type.
}
فیلدها
فیلد union promotion_type . نوع تبلیغی که برای کالا اعمال می‌شود. promotion_type فقط می‌تواند یکی از موارد زیر باشد:
oneTimeCode

object ( OneTimeCode )

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

vanityCode

object ( VanityCode )

یک کد غرور اعمال شد.

وان‌تایم‌کد

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

یک کد تبلیغاتی یکبار مصرف.

ونیتی‌کد

یک کد تخفیف از پیش تعریف‌شده و چندمنظوره.

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

string

کد تبلیغاتی.

جایگزینی مورد

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

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

string

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

replacementMode

enum ( ReplacementMode )

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

basePlanId

string

شناسه طرح پایه ردیف اشتراکی که قرار است جایگزین شود.

offerId

string

شناسه پیشنهاد ردیف اشتراکی که جایگزین می‌شود، در صورت وجود.

حالت جایگزینی

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

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

OutOfAppPurchaseContext

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

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

object ( ExternalAccountIdentifiers )

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

expiredPurchaseToken

string

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

روش‌ها

cancel

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

get

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

revoke

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

کدهای خطا

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

کد خطا دلیل وضوح تصویر
5xx خطای عمومی در سرور گوگل پلی. درخواست خود را دوباره امتحان کنید.

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

409 خطای به‌روزرسانی همزمان.

تلاشی برای به‌روزرسانی شیء در حال به‌روزرسانی صورت گرفته است. برای مثال، یک خرید با فراخوانی متد acknowledgePurchase() از کتابخانه‌ی صورتحساب Play و با فراخوانی همزمان purchases.products.acknowledge از API توسعه‌دهنده‌ی Play، تأیید می‌شود.

 درخواست خود را دوباره امتحان کنید.
410 خرید اشتراک دیگر برای استعلام در دسترس نیست زیرا مدت زیادی است که منقضی شده است. هنگام درخواست اشتراکی که بیش از ۶۰ روز از انقضای آن گذشته است، اجرا می‌شود. دیگر نباید این اشتراک‌ها را درخواست کنید.