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)

המצב הנוכחי של המבצע.

טיפוסים בני מנייה (enum)
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

מציינים איך שינויים במחיר משפיעים על הזמנות מראש קיימות.

טיפוסים בני מנייה (enum)
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

בסוג הזה אין שדות.

אפשרויות למבצעים על מוצרים בחיוב חד-פעמי ללא שינוי מחיר אזורי.

זמינות

זמינות המבצע.

טיפוסים בני מנייה (enum)
AVAILABILITY_UNSPECIFIED זמינות לא מוגדרת. אסור להשתמש בו.
AVAILABLE המבצע זמין למשתמשים.
NO_LONGER_AVAILABLE המבצע כבר לא זמין למשתמשים. אפשר להשתמש בערך הזה רק אם הזמינות הוגדרה קודם כ'זמין'.

Methods

activate

 הפעלה של מוצר בחיוב חד-פעמי.

batchDelete

 מחיקת מוצר אחד או יותר בחיוב חד-פעמי.

batchGet

 קריאה של מבצע אחד או יותר על מוצרים בחיוב חד-פעמי.

batchUpdate

 יצירה או עדכון של מבצעים על מוצרים בחיוב חד-פעמי.

batchUpdateStates

 עדכון קבוצה של סטטוסים של מוצרים בחיוב חד-פעמי.

cancel

 ביטול מוצר בחיוב חד-פעמי.

deactivate

 השבתה של מוצר בחיוב חד-פעמי.

list

 רשימה של כל המבצעים באפליקציה, במוצר או באפשרות רכישה מסוימת.

קודי שגיאה

הפעולות של המשאב הזה מחזירות את קודי שגיאות ה-HTTP הבאים:

קוד שגיאה סיבה תיאור רזולוציה