REST Resource: monetization.subscriptions

منبع: اشتراک

یک اشتراک برای یک برنامه.

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

string

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

product Id

string

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

base Plans[]

object ( BasePlan )

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

listings[]

object ( SubscriptionListing )

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

archived
(deprecated)

boolean

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

tax And Compliance Settings

object ( SubscriptionTaxAndComplianceSettings )

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

restricted Payment Countries

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.
}
فیلدها
base Plan Id

string

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

state

enum ( State )

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

regional Configs[]

object ( RegionalBasePlanConfig )

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

offer Tags[]

object ( OfferTag )

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

other Regions Config

object ( OtherRegionsBasePlanConfig )

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

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

object ( AutoRenewingBasePlanType )

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

prepaid Base Plan Type

object ( PrepaidBasePlanType )

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

installments Base Plan Type

object ( InstallmentsBasePlanType )

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

ایالت

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

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

AutoRenewingBasePlanType

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

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

string

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

grace Period Duration

string

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

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

مجموع GracePeriodDuration و account HoldDuration باید بین P30D و P60D روز باشد.

account Hold Duration

string

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

اگر مشخص نشده باشد، مقدار پیش فرض P30D است.

مجموع GracePeriodDuration و account HoldDuration باید بین P30D و P60D روز باشد.

resubscribe State

enum ( ResubscribeState )

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

proration Mode

enum ( SubscriptionProrationMode )

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

legacy Compatible

boolean

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

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

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

legacy Compatible Subscription Offer Id

string

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

پیشنهاد اشتراک سازگار با گذشته توسط روش منسوخ شده QuerySkuDetailsAsync() کتابخانه صورت‌حساب Google Play برگردانده می‌شود.

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

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

ResubscribeState

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

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

SubscriptionProrationMode

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

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

PrepaidBasePlanType

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

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

string

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

time Extension

enum ( TimeExtension )

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

تمدید زمان

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

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

اقساطBasePlanType

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

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

string

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

committed Payments Count

integer

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

renewal Type

enum ( RenewalType )

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

grace Period Duration

string

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

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

مجموع GracePeriodDuration و account HoldDuration باید بین P30D و P60D روز باشد.

account Hold Duration

string

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

اگر مشخص نشده باشد، مقدار پیش فرض P30D است.

مجموع GracePeriodDuration و account HoldDuration باید بین P30D و P60D روز باشد.

resubscribe State

enum ( ResubscribeState )

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

proration Mode

enum ( SubscriptionProrationMode )

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

نوع تمدید

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

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

RegionalBasePlanConfig

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

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

string

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

new Subscriber Availability

boolean

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

price

object ( Money )

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

OtherRegionsBasePlanConfig

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

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

object ( Money )

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

eur Price

object ( Money )

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

new Subscriber Availability

boolean

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

فهرست اشتراک

فراداده قابل مشاهده برای مصرف کننده یک اشتراک.

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

string

مورد نیاز. زبان این فهرست، همانطور که توسط BCP-47 تعریف شده است، به عنوان مثال "en-US".

title

string

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

benefits[]

string

فهرستی از مزایای نشان داده شده به کاربر در پلتفرم هایی مانند Play Store و در جریان بازیابی به زبان این فهرست است. متن ساده لیست سفارش داده شده از حداکثر چهار مزیت.

description

string

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

کشورهای پرداخت محدود

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

نمایندگی JSON 
{
  "regionCodes": [
    string
  ]
}
فیلدها
region Codes[]

string

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

روش ها

archive
(deprecated)

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

batch Get

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

batch Update

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

create

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

delete

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

get

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

list

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

patch

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