REST Resource: monetization.subscriptions.basePlans.offers

منبع: SubscriptionOffer

یک پیشنهاد واحد و موقت

نمایندگی JSON 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}
فیلدها
package Name

string

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

product Id

string

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

base Plan Id

string

مورد نیاز. تغییرناپذیر. شناسه طرح پایه که این پیشنهاد پسوند آن است.

offer Id

string

مورد نیاز. تغییرناپذیر. شناسه منحصر به فرد این پیشنهاد اشتراک. باید در طرح پایه منحصر به فرد باشد.

state

enum ( State )

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

phases[]

object ( SubscriptionOfferPhase )

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

targeting

object ( SubscriptionOfferTargeting )

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

regional Configs[]

object ( RegionalSubscriptionOfferConfig )

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

other Regions Config

object ( OtherRegionsSubscriptionOfferConfig )

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

offer Tags[]

object ( OfferTag )

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

ایالت

وضعیت فعلی پیشنهاد اشتراک.

Enums
STATE_UNSPECIFIED مقدار پیش فرض، هرگز نباید استفاده شود.
DRAFT پیشنهاد اشتراک در دسترس کاربران نبوده و نبوده است.
ACTIVE پیشنهاد اشتراک برای کاربران جدید و فعلی در دسترس است.
INACTIVE پیشنهاد اشتراک برای کاربران جدید در دسترس نیست. کاربران موجود دسترسی را حفظ می کنند.

SubscriptionOfferPhase

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

نمایندگی JSON 
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
فیلدها
recurrence Count

integer

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

duration

string

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

regional Configs[]

object ( RegionalSubscriptionOfferPhaseConfig )

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

other Regions Config

object ( OtherRegionsSubscriptionOfferPhaseConfig )

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

RegionalSubscriptionOfferPhaseConfig

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

نمایندگی JSON 
{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}
فیلدها
region Code

string

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

فیلد اتحادیه price_override . نادیده گرفتن قیمت این فاز. مورد نیاز. price_override فقط می تواند یکی از موارد زیر باشد:
price

object ( Money )

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

relative Discount

number

کسری از قیمت طرح پایه در طول مدت فازی که کاربر برای این مرحله پیشنهاد پرداخت می‌کند، به نسبت است. به عنوان مثال، اگر قیمت طرح پایه برای این منطقه 12 دلار برای یک دوره 1 ساله باشد، 50٪ تخفیف برای یک مرحله به مدت 3 ماه با قیمت 1.50 دلار مطابقت دارد. تخفیف باید به‌عنوان کسری کاملاً بزرگ‌تر از 0 و کاملاً کوچک‌تر از 1 مشخص شود. قیمت حاصل به نزدیک‌ترین واحد قابل پرداخت گرد می‌شود (مثلاً سنت دلار). اگر قیمت تخفیف خورده کمتر از حداقل قیمت مجاز در این منطقه باشد، تخفیف نسبی نامعتبر تلقی می شود.

absolute Discount

object ( Money )

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

free

object ( RegionalSubscriptionOfferPhaseFreePriceOverride )

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

منطقه‌ای SubscriptionOfferPhaseFreePrice Override

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

نشان دهنده پیکربندی لغو قیمت رایگان برای یک مرحله از پیشنهاد اشتراک است

OtherRegionsSubscriptionOfferPhaseConfig

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

نمایندگی JSON 
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}
فیلدها
فیلد اتحادیه price_override . نادیده گرفتن قیمت این فاز. مورد نیاز. price_override فقط می تواند یکی از موارد زیر باشد:
other Regions Prices

object ( OtherRegionsSubscriptionOfferPhasePrices )

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

relative Discount

number

کسری از قیمت طرح پایه در طول مدت فازی که کاربر برای این مرحله پیشنهاد پرداخت می‌کند، به نسبت است. به عنوان مثال، اگر قیمت طرح پایه برای این منطقه 12 دلار برای یک دوره 1 ساله باشد، 50٪ تخفیف برای یک مرحله به مدت 3 ماه با قیمت 1.50 دلار مطابقت دارد. تخفیف باید به‌عنوان کسری کاملاً بزرگ‌تر از 0 و کاملاً کوچک‌تر از 1 مشخص شود. قیمت حاصل به نزدیک‌ترین واحد قابل پرداخت گرد می‌شود (مثلاً سنت دلار). اگر قیمت تخفیف‌خورده کمتر از حداقل قیمت مجاز در مکان‌های جدیدی باشد که Play ممکن است راه‌اندازی شود، تخفیف نسبی نامعتبر تلقی می‌شود.

absolute Discounts

object ( OtherRegionsSubscriptionOfferPhasePrices )

مقدار مطلق پول کسر شده از قیمت طرح پایه نسبت به مدت فازی که کاربر برای این مرحله پیشنهاد می‌پردازد. به عنوان مثال، اگر قیمت طرح پایه برای این منطقه 12 دلار برای یک دوره 1 ساله باشد، آنگاه یک دلار تخفیف مطلق برای یک مرحله به مدت 3 ماه با قیمت 2 دلار مطابقت دارد. قیمت به‌دست‌آمده ممکن است از حداقل قیمت مجاز برای مکان‌های جدیدی که Play در آن راه‌اندازی شود، کمتر نباشد.

free

object ( OtherRegionsSubscriptionOfferPhaseFreePriceOverride )

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

OtherRegionsSubscriptionOfferPhasePrices

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

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

object ( Money )

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

eur Price

object ( Money )

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

OtherRegionsSubscriptionOfferPhaseFreePrice Override

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

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

SubscriptionOfferTargeting

قانونی را که یک کاربر برای دریافت این پیشنهاد باید رعایت کند را تعریف می کند.

نمایندگی JSON 
{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}
فیلدها
rule میدان اتحادیه برای واجد شرایط بودن پیشنهاد تعیین‌شده توسط توسعه‌دهنده، خالی بگذارید. rule فقط می تواند یکی از موارد زیر باشد:
acquisition Rule

object ( AcquisitionTargetingRule )

قانون هدف گذاری پیشنهاد برای جذب کاربر جدید.

upgrade Rule

object ( UpgradeTargetingRule )

پیشنهاد قانون هدف گذاری برای ارتقای طرح های موجود کاربران.

قانون هدف گذاری کسب

نشان دهنده یک قانون هدف گذاری از فرم است: کاربر قبلاً هرگز {scope} را نداشته است.

نمایندگی JSON 
{
  "scope": {
    object (TargetingRuleScope)
  }
}
فیلدها
scope

object ( TargetingRuleScope )

مورد نیاز. دامنه اشتراک هایی که این قانون در نظر می گیرد. فقط «این اشتراک» و «هر گونه اشتراک در برنامه» را مجاز می‌کند.

TargetingRuleScope

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

نمایندگی JSON 
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
فیلدها

scope میدان اتحادیه

scope می تواند تنها یکی از موارد زیر باشد:

this Subscription

object ( TargetingRuleScopeThisSubscription )

محدوده قانون هدف گذاری فعلی اشتراکی است که در آن این پیشنهاد تعریف شده است.

any Subscription In App

object ( TargetingRuleScopeAnySubscriptionInApp )

محدوده قانون هدف‌یابی فعلی، هرگونه اشتراک در برنامه والد است.

specific Subscription In App

string

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

TargetingRuleScopeThisSubscription

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

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

TargetingRuleScopeAnySubscriptionInApp

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

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

UpgradeTargetingRule

نشان دهنده یک قانون هدف‌یابی از فرم است: کاربر در حال حاضر دارای {scope} [با دوره صورت‌حساب {billing_period}] است.

نمایندگی JSON 
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
فیلدها
once Per User

boolean

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

scope

object ( TargetingRuleScope )

مورد نیاز. دامنه اشتراک هایی که این قانون در نظر می گیرد. فقط «این اشتراک» و «اشتراک خاص در برنامه» را مجاز می‌کند.

billing Period Duration

string

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

RegionalSubscriptionOfferConfig

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

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

string

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

new Subscriber Availability

boolean

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

OtherRegionsSubscriptionOfferConfig

پیکربندی برای هر مکان جدیدی که Play ممکن است در یک پیشنهاد اشتراک مشخص شده راه اندازی شود.

نمایندگی JSON 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
فیلدها
other Regions New Subscriber Availability

boolean

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

روش ها

activate

 پیشنهاد اشتراک را فعال می کند.

batch Get

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

batch Update

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

batch Update States

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

create

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

deactivate

 پیشنهاد اشتراک را غیرفعال می کند.

delete

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

get

 یک پیشنهاد را می خواند

list

 همه پیشنهادات تحت یک اشتراک معین را فهرست می کند.

patch

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