REST Resource: monetization.subscriptions

منبع: اشتراک

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

نمایش JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
فیلدها
packageName

string

تغییرناپذیر. نام بسته‌ی برنامه‌ی والد.

productId

string

تغییرناپذیر. شناسه محصول منحصر به فرد برای محصول. منحصر به فرد در برنامه والد. شناسه‌های محصول باید از حروف کوچک (az)، اعداد (0-9)، زیرخط (_) و نقطه (.) تشکیل شده باشند. باید با یک حرف یا عدد کوچک شروع شوند و طول آنها بین 1 تا 40 (شامل) کاراکتر باشد.

basePlans[]

object ( BasePlan )

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

listings[]

object ( SubscriptionListing )

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

archived
(deprecated)

boolean

فقط خروجی. منسوخ شده: بایگانی اشتراک پشتیبانی نمی‌شود.

taxAndComplianceSettings

object ( SubscriptionTaxAndComplianceSettings )

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

restrictedPaymentCountries

object ( RestrictedPaymentCountries )

اختیاری. کشورهایی که خرید این اشتراک در آنها محدود به روش‌های پرداخت ثبت‌شده در همان کشور است. در صورت خالی بودن، هیچ محدودیتی برای مکان پرداخت اعمال نمی‌شود.

طرح پایه

یک طرح پایه واحد برای اشتراک.

نمایش JSON 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
فیلدها
basePlanId

string

الزامی. تغییرناپذیر. شناسه منحصر به فرد این طرح پایه. باید در طول اشتراک منحصر به فرد باشد و با RFC-1034 مطابقت داشته باشد. یعنی، این شناسه فقط می‌تواند شامل حروف کوچک (az)، اعداد (0-9) و خط فاصله (-) باشد و حداکثر 63 کاراکتر داشته باشد.

state

enum ( State )

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

regionalConfigs[]

object ( RegionalBasePlanConfig )

اطلاعات خاص منطقه برای این طرح پایه.

offerTags[]

object ( OfferTag )

فهرستی از حداکثر ۲۰ برچسب سفارشی که برای این طرح پایه مشخص شده و از طریق کتابخانه صورتحساب به برنامه بازگردانده شده است. پیشنهادهای اشتراک برای این طرح پایه نیز این برچسب‌های پیشنهادی را در کتابخانه صورتحساب دریافت خواهند کرد.

otherRegionsConfig

object ( OtherRegionsBasePlanConfig )

اطلاعات قیمت‌گذاری برای هر مکان جدیدی که Play ممکن است در آینده راه‌اندازی کند. در صورت حذف، BasePlan به طور خودکار در دسترس نخواهد بود و هیچ مکان جدیدی که Play ممکن است در آینده راه‌اندازی کند، در دسترس نخواهد بود.

فیلد اتحادیه base_plan_type . نوع این طرح پایه. دقیقاً یکی باید تنظیم شود. نوع طرح پایه پس از ایجاد طرح پایه تغییرناپذیر است. base_plan_type فقط می‌تواند یکی از موارد زیر باشد:
autoRenewingBasePlanType

object ( AutoRenewingBasePlanType )

تنظیم کنید که چه زمانی طرح پایه به طور خودکار در یک بازه زمانی منظم تمدید شود.

prepaidBasePlanType

object ( PrepaidBasePlanType )

تنظیم کنید که چه زمانی طرح پایه در پایان دوره صورتحساب به طور خودکار تمدید نشود.

installmentsBasePlanType

object ( InstallmentsBasePlanType )

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

ایالت

وضعیت فعلی یک طرح پایه.

انوم‌ها
STATE_UNSPECIFIED حالت نامشخص.
DRAFT طرح پایه در حال حاضر در حالت پیش‌نویس است و فعال نشده است. در حال حاضر می‌توان آن را با خیال راحت حذف کرد.
ACTIVE طرح پایه فعال و برای مشترکین جدید در دسترس است.
INACTIVE طرح پایه غیرفعال است و فقط برای مشترکین فعلی در دسترس است.

نوع طرح پایه نوسازی خودکار

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

نمایش JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
فیلدها
billingPeriodDuration

string

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

gracePeriodDuration

string

دوره مهلت اشتراک، که در قالب ISO 8601 مشخص شده است. مقادیر قابل قبول باید بر حسب روز و بین P0D و کمتر از 30D و دوره صورتحساب طرح پایه باشد.

در صورت عدم تعیین، مقدار پیش‌فرض بر اساس دوره صورتحساب استفاده خواهد شد.

مجموع gracePeriodDuration و accountHoldDuration باید بین روزهای P30D و P60D، شامل، باشد.

accountHoldDuration

string

اختیاری. دوره نگهداری حساب سفارشی برای اشتراک، که در قالب ISO 8601 مشخص شده است. مقادیر قابل قبول باید بر حسب روز و بین P0D و P60D باشند.

یک فیلد خالی نشان دهنده مدت زمان توصیه شده برای نگهداری حساب است که به صورت ۶۰ روز منهای دوره تنفس محاسبه می‌شود.

مجموع gracePeriodDuration و accountHoldDuration باید بین روزهای P30D و P60D، شامل، باشد.

resubscribeState

enum ( ResubscribeState )

اینکه آیا کاربران باید بتوانند در سطوح Google Play دوباره در این طرح پایه مشترک شوند یا خیر. اگر مشخص نشده باشد، پیش‌فرض RESUBSCRIBE_STATE_ACTIVE است.

prorationMode

enum ( SubscriptionProrationMode )

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

legacyCompatible

boolean

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

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

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

legacyCompatibleSubscriptionOfferId

string

شناسه پیشنهاد اشتراک که با نسخه‌های قدیمی سازگار است.

پیشنهاد اشتراک سازگار با نسخه‌های قبلی توسط متد منسوخ‌شده‌ی querySkuDetailsAsync() در کتابخانه‌ی پرداخت گوگل پلی بازگردانده می‌شود.

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

برای اینکه هیچ پیشنهاد اشتراکی با نسخه قدیمی سازگار نباشد، این فیلد را به صورت رشته خالی تنظیم کنید.

اشتراک مجدد

وضعیت اشتراک مجدد طرح پایه.

انوم‌ها
RESUBSCRIBE_STATE_UNSPECIFIED حالت نامشخص.
RESUBSCRIBE_STATE_ACTIVE اشتراک مجدد فعال است.
RESUBSCRIBE_STATE_INACTIVE عضویت مجدد غیرفعال است.

حالت اشتراک

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

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

نوع طرح پایه پیش‌پرداخت

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

نمایش JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
فیلدها
billingPeriodDuration

string

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

timeExtension

enum ( TimeExtension )

اینکه آیا کاربران باید بتوانند این طرح پایه پیش‌پرداخت را در سطوح Google Play تمدید کنند یا خیر. اگر مشخص نشده باشد، پیش‌فرض روی TIME_EXTENSION_ACTIVE است.

افزونه زمان

تمدید زمان طرح پایه

انوم‌ها
TIME_EXTENSION_UNSPECIFIED حالت نامشخص.
TIME_EXTENSION_ACTIVE تمدید زمان فعال است. کاربران می‌توانند طرح پیش‌پرداخت خود را شارژ یا تمدید کنند.
TIME_EXTENSION_INACTIVE تمدید زمان غیرفعال است. کاربران نمی‌توانند طرح پیش‌پرداخت خود را شارژ یا تمدید کنند.

اقساطنوع طرح پایه

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

نمایش JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
فیلدها
billingPeriodDuration

string

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

committedPaymentsCount

integer

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

renewalType

enum ( RenewalType )

الزامی. تغییرناپذیر. نوع تمدید طرح پایه اقساط. رفتار را در پایان تعهد اولیه تعیین می‌کند. نوع تمدید پس از ایجاد طرح پایه تغییرناپذیر است.

gracePeriodDuration

string

دوره مهلت اشتراک، که در قالب ISO 8601 مشخص شده است. مقادیر قابل قبول باید بر حسب روز و بین P0D و کمتر از 30D و دوره صورتحساب طرح پایه باشد.

در صورت عدم تعیین، مقدار پیش‌فرض بر اساس دوره صورتحساب استفاده خواهد شد.

مجموع gracePeriodDuration و accountHoldDuration باید بین روزهای P30D و P60D، شامل، باشد.

accountHoldDuration

string

اختیاری. دوره نگهداری حساب سفارشی برای اشتراک، که در قالب ISO 8601 مشخص شده است. مقادیر قابل قبول باید بر حسب روز و بین P0D و P60D باشند.

یک فیلد خالی نشان دهنده مدت زمان توصیه شده برای نگهداری حساب است که به صورت ۶۰ روز منهای دوره تنفس محاسبه می‌شود.

مجموع gracePeriodDuration و accountHoldDuration باید بین روزهای P30D و P60D، شامل، باشد.

resubscribeState

enum ( ResubscribeState )

اینکه آیا کاربران باید بتوانند در سطوح Google Play دوباره در این طرح پایه مشترک شوند یا خیر. اگر مشخص نشده باشد، پیش‌فرض RESUBSCRIBE_STATE_ACTIVE است.

prorationMode

enum ( SubscriptionProrationMode )

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

نوع تمدید

نوع تمدید طرح پایه اقساط. رفتار را در پایان تعهد اولیه تعیین می‌کند. نوع تمدید پس از ایجاد طرح پایه تغییرناپذیر است.

انوم‌ها
RENEWAL_TYPE_UNSPECIFIED حالت نامشخص.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT به صورت دوره‌ای و بدون تعهد، برای مدت دوره صورتحساب تمدید می‌شود.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT با تعهدی معادل مدت زمان قرارداد اولیه تمدید می‌شود.

پیکربندی طرح پایه منطقه‌ای

پیکربندی برای یک طرح پایه خاص برای یک منطقه.

نمایش JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
فیلدها
regionCode

string

الزامی. کد منطقه‌ای که این پیکربندی برای آن اعمال می‌شود، طبق تعریف ISO 3166-2، مثلاً "US".

newSubscriberAvailability

boolean

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

price

object ( Money )

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

پیکربندی طرح پایه سایر مناطق

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

نمایش JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
فیلدها
usdPrice

object ( Money )

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

eurPrice

object ( Money )

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

newSubscriberAvailability

boolean

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

فهرست اشتراک

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

نمایش JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
فیلدها
languageCode

string

الزامی. زبان این فهرست، طبق تعریف BCP-47، مثلاً "en-US".

title

string

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

benefits[]

string

فهرستی از مزایایی که در پلتفرم‌هایی مانند فروشگاه Play و در Restore به کاربر نشان داده می‌شود، به زبان این فهرست نمایش داده می‌شود. متن ساده. فهرستی مرتب از حداکثر چهار مزیت.

description

string

توضیحات این اشتراک به زبان این فهرست. حداکثر طول - ۸۰ کاراکتر. متن ساده.

روش‌ها

archive
(deprecated)

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

batchGet

 یک یا چند اشتراک را می‌خواند.

batchUpdate

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

create

 یک اشتراک جدید ایجاد می‌کند.

delete

 اشتراک را حذف می‌کند.

get

 یک اشتراک واحد را می‌خواند.

list

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

patch

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

کدهای خطا

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

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

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

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

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

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