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

مطلوب. غير قابل للتغيير معرّف عرض المنتج هذا. يجب أن يكون المعرّف فريدًا ضمن خيار الشراء. ويجب أن يبدأ برقم أو حرف صغير، وألّا يتضمّن سوى أحرف صغيرة (a-z) وأرقام (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)

عرض توفيري

الحالة

تمثّل هذه السمة الحالة الحالية للعرض.

عمليات التعداد
STATE_UNSPECIFIED القيمة التلقائية، ويجب عدم استخدامها مطلقًا.
DRAFT العرض الترويجي غير متاح للمستخدمين ولم يكن متاحًا لهم في أي وقت.
ACTIVE يتوفّر العرض للمستخدمين طالما تم استيفاء شروطه.
CANCELLED تتعلّق هذه الحالة بالطلبات المُسبَقة فقط. يتم إلغاء العرض الترويجي ولا يكون متاحًا للمستخدمين. تم إلغاء جميع الطلبات المعلّقة المرتبطة بهذا العرض.
INACTIVE تتعلّق هذه الحالة بالعروض المخفَّضة. لم يعُد العرض الترويجي متاحًا للمستخدمين.

OneTimeProductPreOrderOffer

إعدادات خاصة بعروض الطلب المُسبَق

تمثيل JSON 
{
  "startTime": string,
  "endTime": string,
  "releaseTime": string,
  "priceChangeBehavior": enum (PreOrderPriceChangeBehavior)
}
الحقول
startTime

string (Timestamp format)

مطلوب. الوقت الذي ستبدأ فيه إتاحة الطلب المُسبَق

يستخدم RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا Z-normalized ويستخدم 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-normalized ويستخدم 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-normalized ويستخدم 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

تحدّد هذه السمة كيفية تأثير تغييرات الأسعار في الطلبات المُسبقة الحالية.

عمليات التعداد
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_UNSPECIFIED سلوك غير محدّد لتغيير السعر يجب عدم استخدامها.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_TWO_POINT_LOWEST يتم تحصيل السعر الأدنى من المشتري بين السعر الأولي عند تقديم الطلب المُسبَق وسعر العرض النهائي في تاريخ الإصدار.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_NEW_ORDERS_ONLY يحصل المشتري على السعر نفسه الذي تم طلبه مسبقًا، بغض النظر عن أي تغييرات في السعر قد تكون حدثت بعد الطلب المسبق.

OneTimeProductDiscountedOffer

إعدادات خاصة بالعروض المخفَّضة

تمثيل JSON 
{
  "startTime": string,
  "endTime": string,
  "redemptionLimit": string
}
الحقول
startTime

string (Timestamp format)

تمثّل هذه السمة الوقت الذي سيبدأ فيه توفّر العرض.

يستخدم RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا Z-normalized ويستخدم 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-normalized ويستخدم 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

لا يتضمّن هذا النوع أي حقول.

خيارات عروض المنتجات التي يتم تحصيل سعرها مرة واحدة بدون إلغاء السعر على مستوى منطقة معيّنة

مدى التوفّر

توفُّر العرض

عمليات التعداد
AVAILABILITY_UNSPECIFIED مدى التوفّر غير محدّد. يجب عدم استخدامها.
AVAILABLE يتوفّر العرض للمستخدمين.
NO_LONGER_AVAILABLE لم يعُد العرض الترويجي متاحًا للمستخدمين. لا يمكن استخدام هذه القيمة إلا إذا تم ضبط مدى التوفّر على AVAILABLE (متوفّر) سابقًا.

الطُرق

activate

 تفعّل هذه الطريقة عرضًا ترويجيًا لمنتج يتم تحصيل سعره مرة واحدة.

batchDelete

 يحذف هذا الإجراء عرضًا واحدًا أو أكثر من عروض المنتجات التي يتم تحصيل سعرها مرة واحدة.

batchGet

 تقرأ هذه السمة عرضًا واحدًا أو أكثر من عروض المنتجات التي يتم تحصيل سعرها مرة واحدة.

batchUpdate

 تنشئ هذه الطريقة عرضًا واحدًا أو أكثر من عروض المنتجات التي يتم تحصيل سعرها مرة واحدة أو تعدّلها.

batchUpdateStates

 تعدّل هذه الطريقة مجموعة من حالات عروض المنتجات التي يتم تحصيل سعرها مرة واحدة.

cancel

 تلغي هذه الطريقة عرضًا لمنتج يتم تحصيل سعره مرة واحدة.

deactivate

 تؤدي إلى إيقاف عرض منتج يتم تحصيل سعره مرة واحدة.

list

 تعرض هذه السمة جميع العروض الترويجية ضمن تطبيق أو منتج أو خيار شراء معيّن.