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 )

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

offerTags[]

object ( OfferTag )

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

regionsVersion

object ( RegionsVersion )

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

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

object ( OneTimeProductPreOrderOffer )

یک پیشنهاد پیش‌سفارش.

discountedOffer

object ( OneTimeProductDiscountedOffer )

یه پیشنهاد تخفیف خورده.

ایالت

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

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

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

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

نمایش JSON 
{
  "startTime": string,
  "endTime": string,
  "releaseTime": string,
  "priceChangeBehavior": enum (PreOrderPriceChangeBehavior)
}
فیلدها
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" .

endTime

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" .

releaseTime

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" .

priceChangeBehavior

enum ( PreOrderPriceChangeBehavior )

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

پیش سفارشتغییر رفتار قیمت

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

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

redemptionLimit

string ( int64 format)

اختیاری. تعداد دفعاتی که این پیشنهاد می‌تواند استفاده شود. اگر تنظیم نشود یا روی ۰ تنظیم شود، امکان استفاده نامحدود از پیشنهاد را فراهم می‌کند. در غیر این صورت باید عددی بین ۱ تا ۵۰ باشد.

پیکربندی قیمت‌گذاری و دسترسی منطقه‌ای

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

نمایش 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

کسری از قیمت اختیار خرید که کاربر برای این پیشنهاد پرداخت می‌کند. به عنوان مثال، اگر قیمت اختیار خرید برای این منطقه ۱۲ دلار باشد، تخفیف ۵۰٪ معادل قیمت ۶ دلار خواهد بود. تخفیف باید به صورت کسری مشخص شود که کاملاً بزرگتر از ۰ و کاملاً کوچکتر از ۱ باشد. قیمت حاصل به نزدیکترین واحد قابل پرداخت (مثلاً سنت برای دلار آمریکا) گرد می‌شود. اگر قیمت تخفیف خورده در نهایت کمتر از حداقل قیمت مجاز در این منطقه باشد، تخفیف نسبی نامعتبر تلقی می‌شود.

absoluteDiscount

object ( Money )

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

باید بین ۰ و قیمت اختیار خرید باشد.

پیشنهاد ویژه محصول بدون قیمتگزینه‌های لغو

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

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

در دسترس بودن

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

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

روش‌ها

activate

 پیشنهاد ویژه محصول را که فقط یک بار ارائه می‌شود، فعال می‌کند.

batchDelete

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

batchGet

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

batchUpdate

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

batchUpdateStates

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

cancel

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

deactivate

 پیشنهاد ویژه محصول را که فقط یک بار ارائه می‌شود، غیرفعال می‌کند.

list

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

کدهای خطا

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

کد خطا دلیل توضیحات وضوح تصویر