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)

छूट वाला ऑफ़र.

स्थिति

ऑफ़र की मौजूदा स्थिति.

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 खरीदार को वही कीमत चुकानी होगी जिस पर उसने पहले से ऑर्डर किया था. भले ही, पहले से ऑर्डर करने के बाद कीमत में कोई बदलाव हुआ हो.

OneTimeProductDiscountedOffer

छूट वाले ऑफ़र के लिए कॉन्फ़िगरेशन.

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

यह कुकी, किसी ऐप्लिकेशन, प्रॉडक्ट या खरीदारी के विकल्प के तहत उपलब्ध सभी ऑफ़र की सूची बनाती है.