REST Resource: monetization.onetimeproducts.purchaseOptions.offers

منبع: OneTimeProductOffer

یک پیشنهاد واحد برای یک محصول یک بار مصرف.

نمایندگی JSON
{
  "packageName": string,
  "productId": string,
  "purchaseOptionId": string,
  "offerId": string,
  "state": enum (State),
  "regionalPricingAndAvailabilityConfigs": [
    {
      object (RegionalPricingAndAvailabilityConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "regionsVersion": {
    object (RegionsVersion)
  },

  // Union field offer_type can be only one of the following:
  "preOrderOffer": {
    object (OneTimeProductPreOrderOffer)
  },
  "discountedOffer": {
    object (OneTimeProductDiscountedOffer)
  }
  // End of list of possible types for union field offer_type.
}
فیلدها
packageName

string

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

productId

string

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

purchaseOptionId

string

مورد نیاز. تغییرناپذیر. شناسه گزینه خریدی که این پیشنهاد برای آن افزونه است.

offerId

string

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

state

enum ( State )

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

regionalPricingAndAvailabilityConfigs[]

object ( RegionalPricingAndAvailabilityConfig )

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

offerTags[]

object ( OfferTag )

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

regionsVersion

object ( RegionsVersion )

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

offer_type فیلد اتحادیه. نوع این پیشنهاد دقیقاً یکی باید تنظیم شود. offer_type فقط می تواند یکی از موارد زیر باشد:
preOrderOffer

object ( OneTimeProductPreOrderOffer )

پیشنهاد پیش خرید

discountedOffer

object ( OneTimeProductDiscountedOffer )

یک پیشنهاد با تخفیف

ایالت

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

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

OneTimeProductPreOrderOffer

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

نمایندگی JSON
{
  "startTime": string,
  "endTime": string,
  "releaseTime": string,
  "priceChangeBehavior": enum (PreOrderPriceChangeBehavior)
}
فیلدها
startTime

string ( Timestamp format)

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

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

endTime

string ( Timestamp format)

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

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

releaseTime

string ( Timestamp format)

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

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

priceChangeBehavior

enum ( PreOrderPriceChangeBehavior )

مورد نیاز. تغییرناپذیر. مشخص می‌کند که چگونه تغییرات قیمت بر پیش‌سفارش‌های از قبل موجود تأثیر می‌گذارد.

PreorderPriceChangeBehavior

مشخص می‌کند که چگونه تغییرات قیمت بر پیش‌سفارش‌های از قبل موجود تأثیر می‌گذارد.

Enums
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_UNSPECIFIED رفتار تغییر قیمت نامشخص نباید استفاده شود.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_TWO_POINT_LOWEST خریدار حداقل بین قیمت اولیه در زمان پیش‌سفارش و قیمت پیشنهادی نهایی در تاریخ انتشار دریافت می‌کند.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_NEW_ORDERS_ONLY خریدار بدون توجه به تغییرات قیمتی که ممکن است پس از پیش‌سفارش اتفاق افتاده باشد، همان قیمتی را که پیش‌سفارش کرده است، دریافت می‌کند.

یک بار محصول با تخفیف

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

نمایندگی JSON
{
  "startTime": string,
  "endTime": string,
  "redemptionLimit": string
}
فیلدها
startTime

string ( Timestamp format)

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

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

endTime

string ( Timestamp format)

زمانی که پیشنهاد متوقف می شود.

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

redemptionLimit

string ( int64 format)

اختیاری. تعداد دفعاتی که می توان از این پیشنهاد استفاده کرد. اگر تنظیم نشود یا روی 0 تنظیم شود، امکان بازخرید پیشنهاد نامحدود را فراهم می کند. در غیر این صورت باید عددی بین 1 تا 50 باشد.

RegionalPricingAndAvailabilityConfig

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

نمایندگی JSON
{
  "regionCode": string,
  "availability": enum (Availability),

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

string

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

availability

enum ( Availability )

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

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

object ( OneTimeProductOfferNoPriceOverrideOptions )

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

relativeDiscount

number

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

absoluteDiscount

object ( Money )

قدر مطلق تخفیف که از قیمت اختیار خرید کسر می شود.

باید بین 0 و قیمت گزینه خرید باشد.

OneTimeProductOfferNoPriceOverrideOptions

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

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

در دسترس بودن

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

Enums
AVAILABILITY_UNSPECIFIED در دسترس بودن نامشخص نباید استفاده شود.
AVAILABLE پیشنهاد در دسترس کاربران است.
NO_LONGER_AVAILABLE این پیشنهاد دیگر در دسترس کاربران نیست. این مقدار فقط در صورتی قابل استفاده است که در دسترس بودن قبلاً به عنوان AVAILABLE تنظیم شده باشد.

روش ها

activate

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

batchDelete

یک یا چند پیشنهاد یک بار مصرف محصول را حذف می کند.

batchGet

یک یا چند پیشنهاد یک بار مصرف محصول را می خواند.

batchUpdate

یک یا چند پیشنهاد یک بار مصرف محصول را ایجاد یا به روز می کند.

batchUpdateStates

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

cancel

پیشنهاد یک بار مصرف محصول را لغو می کند.

deactivate

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

list

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