REST Resource: monetization.subscriptions.basePlans.offers

रिसॉर्स: SubscriptionOffer

एक बार में मिलने वाला, कुछ समय के लिए उपलब्ध ऑफ़र

JSON के काेड में दिखाना
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}
फ़ील्ड
packageName

string

ज़रूरी है. इम्यूटेबल. उस ऐप्लिकेशन का पैकेज नेम जिससे पैरंट सदस्यता जुड़ी है.

productId

string

ज़रूरी है. इम्यूटेबल. उस पैरंट सदस्यता का आईडी जिससे यह ऑफ़र जुड़ा है.

basePlanId

string

ज़रूरी है. इम्यूटेबल. उस बुनियादी प्लान का आईडी जिसका यह ऑफ़र एक्सटेंशन है.

offerId

string

ज़रूरी है. इम्यूटेबल. सदस्यता के इस ऑफ़र का यूनीक आईडी. यह बुनियादी प्लान में यूनीक होना चाहिए.

state

enum (State)

सिर्फ़ आउटपुट के लिए. इस ऑफ़र की मौजूदा स्थिति. 'चालू करें' और 'बंद करें' कार्रवाइयों का इस्तेमाल करके, इसकी स्थिति बदली जा सकती है. अहम जानकारी: बुनियादी प्लान की स्थिति इस स्टेटस की जगह ले लेती है. इसलिए, अगर बुनियादी प्लान चालू नहीं है, तो हो सकता है कि कोई चालू ऑफ़र उपलब्ध न हो.

phases[]

object (SubscriptionOfferPhase)

ज़रूरी है. सदस्यता के इस ऑफ़र के चरण. इसमें कम से कम एक और ज़्यादा से ज़्यादा दो एंट्री होनी चाहिए. उपयोगकर्ताओं को ये सभी चरण हमेशा तय क्रम में मिलेंगे.

targeting

object (SubscriptionOfferTargeting)

इस ऑफ़र की ज़रूरी शर्तें. इस एट्रिब्यूट की वैल्यू से उन ज़रूरी शर्तों के बारे में पता चलता है जिनका आकलन करके, Play यह तय करता है कि किसी ऑफ़र को वापस किया जाना चाहिए या नहीं. डेवलपर, इन ऑफ़र को खुद भी फ़िल्टर कर सकते हैं.

regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

ज़रूरी है. इस ऑफ़र का क्षेत्र के हिसाब से कॉन्फ़िगरेशन. इसमें कम से कम एक एंट्री होनी चाहिए.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

आने वाले समय में, Play को जिन नई जगहों पर लॉन्च किया जा सकता है उनके लिए कॉन्फ़िगरेशन.

offerTags[]

object (OfferTag)

इस ऑफ़र के लिए तय किए गए ज़्यादा से ज़्यादा 20 कस्टम टैग की सूची. साथ ही, बिलिंग लाइब्रेरी की मदद से ऐप्लिकेशन में वापस भेजे गए टैग.

स्थिति

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

Enums
STATE_UNSPECIFIED डिफ़ॉल्ट वैल्यू का कभी भी इस्तेमाल नहीं किया जाना चाहिए.
DRAFT सदस्यता का यह ऑफ़र, उपयोगकर्ताओं के लिए उपलब्ध नहीं है और न ही कभी उपलब्ध था.
ACTIVE सदस्यता का ऑफ़र, नए और मौजूदा उपयोगकर्ताओं के लिए उपलब्ध है.
INACTIVE सदस्यता का ऑफ़र, नए उपयोगकर्ताओं के लिए उपलब्ध नहीं है. मौजूदा उपयोगकर्ताओं के पास ऐक्सेस बना रहेगा.

SubscriptionOfferPhase

सदस्यता के ऑफ़र का एक चरण.

JSON के काेड में दिखाना
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
फ़ील्ड
recurrenceCount

integer

ज़रूरी है. यह फ़ेज़ कितनी बार दोहराया जाएगा. अगर ऑफ़र का यह चरण बिना शुल्क के नहीं है, तो बार-बार रिन्यू होने पर उपयोगकर्ता से इस चरण की कीमत ली जाएगी.

duration

string

ज़रूरी है. इस फ़ेज़ के दोहराए जाने की अवधि. ISO 8601 फ़ॉर्मैट में दी गई.

regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

ज़रूरी है. इस ऑफ़र के फ़ेज़ का, इलाके के हिसाब से कॉन्फ़िगरेशन. इस सूची में, हर उस देश/इलाके के लिए सिर्फ़ एक एंट्री होनी चाहिए जिसके लिए सदस्यता के ऑफ़र में देश/इलाके के हिसाब से कॉन्फ़िगरेशन है.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Play के लॉन्च होने वाली नई जगहों के लिए कीमत की जानकारी.

RegionalSubscriptionOfferPhaseConfig

किसी एक इलाके में, सदस्यता के ऑफ़र के किसी एक चरण के लिए कॉन्फ़िगरेशन.

JSON के काेड में दिखाना
{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}
फ़ील्ड
regionCode

string

ज़रूरी है. इम्यूटेबल. वह क्षेत्र जहां यह कॉन्फ़िगरेशन लागू होता है.

यूनियन फ़ील्ड price_override. इस फ़ेज़ के लिए, कीमत में बदलाव. ज़रूरी है. price_override इनमें से कोई एक हो सकता है:
price

object (Money)

ऑफ़र के इस फ़ेज़ के लिए, उपयोगकर्ता से ली जाने वाली कुल कीमत. कीमत, इस इलाके के लिए तय की गई कम से कम कीमत से कम नहीं होनी चाहिए.

relativeDiscount

number

ऑफ़र के फ़ेज़ के लिए, उपयोगकर्ता से ली जाने वाली कीमत, बुनियादी प्लान की कीमत के हिसाब से तय होती है. यह कीमत, फ़ेज़ की अवधि के हिसाब से तय की जाती है. उदाहरण के लिए, अगर इस इलाके के लिए बुनियादी प्लान की कीमत एक साल के लिए 12 डॉलर है, तो तीन महीने के फ़ेज़ के लिए 50% की छूट, 1.50 डॉलर की कीमत के बराबर होगी. छूट को 0 से ज़्यादा और 1 से कम के फ़्रैक्शन के तौर पर सबमिट किया जाना चाहिए. इससे मिलने वाली कीमत को, बिल के लिए इस्तेमाल की जाने वाली सबसे करीबी इकाई (उदाहरण के लिए, डॉलर के लिए सेंट) में राउंड ऑफ़ कर दिया जाएगा. अगर छूट वाली कीमत, इस इलाके में तय की गई कम से कम कीमत से कम हो जाती है, तो रिलेटिव छूट को अमान्य माना जाता है.

absoluteDiscount

object (Money)

ऑफ़र के इस फ़ेज़ के लिए, उपयोगकर्ता से ली जाने वाली रकम को बुनियादी प्लान की कीमत से घटाने पर जो रकम मिलती है उसे ऑफ़र के फ़ेज़ की अवधि के हिसाब से बांटा जाता है. उदाहरण के लिए, अगर इस इलाके के लिए बुनियादी प्लान की कीमत एक साल के लिए 12 डॉलर है, तो तीन महीने के किसी फ़ेज़ के लिए 1 डॉलर की छूट, 2 डॉलर की कीमत के बराबर होगी. इसकी वजह से, कीमत इस इलाके के लिए तय की गई कम से कम कीमत से कम नहीं होनी चाहिए.

free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

यह बताने के लिए सेट करें कि यह ऑफ़र बिना किसी शुल्क के उपलब्ध है.

RegionalSubscriptionOfferPhaseFreePriceOverride

इस टाइप में कोई फ़ील्ड नहीं है.

सदस्यता के ऑफ़र के किसी एक चरण के लिए, बिना शुल्क के सदस्यता लेने की सुविधा के लिए कीमत बदलने की सुविधा का कॉन्फ़िगरेशन दिखाता है

OtherRegionsSubscriptionOfferPhaseConfig

किसी नए देश या इलाके में ऑफ़र के एक फ़ेज़ के लिए, Play के लॉन्च होने से जुड़ा कॉन्फ़िगरेशन.

JSON के काेड में दिखाना
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}
फ़ील्ड
यूनियन फ़ील्ड price_override. इस फ़ेज़ के लिए, कीमत में बदलाव. ज़रूरी है. price_override इनमें से कोई एक हो सकता है:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

ऑफ़र के इस फ़ेज़ के लिए, उपयोगकर्ता से ली जाने वाली कुल कीमत. कीमत, उन नई जगहों के लिए तय की गई कम से कम कीमत से कम नहीं होनी चाहिए जहां Play लॉन्च किया जा सकता है.

relativeDiscount

number

ऑफ़र के फ़ेज़ के लिए, उपयोगकर्ता से ली जाने वाली कीमत, बुनियादी प्लान की कीमत के हिसाब से तय होती है. यह कीमत, फ़ेज़ की अवधि के हिसाब से तय की जाती है. उदाहरण के लिए, अगर इस इलाके के लिए बुनियादी प्लान की कीमत एक साल के लिए 12 डॉलर है, तो तीन महीने के फ़ेज़ के लिए 50% की छूट, 1.50 डॉलर की कीमत के बराबर होगी. छूट को 0 से ज़्यादा और 1 से कम के फ़्रैक्शन के तौर पर सबमिट किया जाना चाहिए. इससे मिलने वाली कीमत को, बिल के लिए इस्तेमाल की जाने वाली सबसे करीबी इकाई (उदाहरण के लिए, डॉलर के लिए सेंट) में राउंड ऑफ़ कर दिया जाएगा. अगर छूट वाली कीमत, Play के लॉन्च होने वाली नई जगहों पर तय की गई कम से कम कीमत से कम है, तो रिलेटिव छूट को अमान्य माना जाएगा.

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

ऑफ़र के इस फ़ेज़ के लिए, उपयोगकर्ता से ली जाने वाली रकम को बुनियादी प्लान की कीमत से घटाने पर जो रकम मिलती है उसे ऑफ़र के फ़ेज़ की अवधि के हिसाब से बांटा जाता है. उदाहरण के लिए, अगर इस इलाके के लिए बुनियादी प्लान की कीमत एक साल के लिए 12 डॉलर है, तो तीन महीने के किसी फ़ेज़ के लिए 1 डॉलर की छूट, 2 डॉलर की कीमत के बराबर होगी. यह कीमत, उन नई जगहों के लिए तय की गई कम से कम कीमत से कम नहीं होनी चाहिए जहां Play को लॉन्च किया जा सकता है.

free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

यह बताने के लिए सेट करें कि यह ऑफ़र बिना किसी शुल्क के उपलब्ध है.

OtherRegionsSubscriptionOfferPhasePrices

Play के लॉन्च होने वाली नई जगहों के लिए कीमत की जानकारी.

JSON के काेड में दिखाना
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}
फ़ील्ड
usdPrice

object (Money)

ज़रूरी है. अमेरिकन डॉलर में कीमत, ताकि Play को उन नई जगहों पर लॉन्च करने के लिए इसका इस्तेमाल किया जा सके.

eurPrice

object (Money)

ज़रूरी है. यूरो में कीमत, ताकि Play को उन नई जगहों पर लॉन्च करने के लिए इसका इस्तेमाल किया जा सके.

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

इस टाइप में कोई फ़ील्ड नहीं है.

इसमें, उन सभी नई जगहों के लिए मुफ़्त में कीमत बदलने की सुविधा का कॉन्फ़िगरेशन दिखता है जहां Play, ऑफ़र के किसी एक चरण के लिए लॉन्च हो सकता है.

SubscriptionOfferTargeting

यह नियम तय करता है कि यह ऑफ़र पाने के लिए, उपयोगकर्ता को क्या करना होगा.

JSON के काेड में दिखाना
{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}
फ़ील्ड
यूनियन फ़ील्ड rule. डेवलपर के तय किए गए ऑफ़र की ज़रूरी शर्तों के लिए, इस फ़ील्ड को खाली छोड़ें. rule इनमें से कोई एक हो सकता है:
acquisitionRule

object (AcquisitionTargetingRule)

नए उपयोगकर्ता हासिल करने के लिए, ऑफ़र टारगेटिंग का नियम.

upgradeRule

object (UpgradeTargetingRule)

उपयोगकर्ताओं के मौजूदा प्लान को अपग्रेड करने के लिए, ऑफ़र टारगेटिंग का नियम.

AcquisitionTargetingRule

यह फ़ॉर्म के टारगेटिंग नियम को दिखाता है: उपयोगकर्ता के पास पहले कभी {scope} नहीं था.

JSON के काेड में दिखाना
{
  "scope": {
    object (TargetingRuleScope)
  }
}
फ़ील्ड
scope

object (TargetingRuleScope)

ज़रूरी है. इस नियम में सदस्यताओं का दायरा. सिर्फ़ "यह सदस्यता" और "ऐप्लिकेशन में मौजूद कोई भी सदस्यता" को अनुमति दी जाती है.

TargetingRuleScope

इससे उन सदस्यताओं का दायरा तय होता है जिनके लिए टारगेटिंग नियम, उपयोगकर्ताओं को ऑफ़र टारगेट करने के लिए, पुराने या मौजूदा एनटाइटलमेंट के आधार पर मैच कर सकता है.

JSON के काेड में दिखाना
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
फ़ील्ड

यूनियन फ़ील्ड scope.

scope इनमें से कोई एक हो सकता है:

thisSubscription

object (TargetingRuleScopeThisSubscription)

मौजूदा टारगेटिंग नियम का दायरा, वह सदस्यता है जिसमें यह ऑफ़र तय किया गया है.

anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

मौजूदा टारगेटिंग नियम का दायरा, पैरंट ऐप्लिकेशन में मौजूद किसी भी सदस्यता तक है.

specificSubscriptionInApp

string

मौजूदा टारगेटिंग नियम का दायरा, बताए गए सदस्यता आईडी वाली सदस्यता है. यह उसी पैरंट ऐप्लिकेशन में मौजूद सदस्यता होनी चाहिए.

TargetingRuleScopeThisSubscription

इस टाइप में कोई फ़ील्ड नहीं है.

इस एट्रिब्यूट से, उन सदस्यताओं के लिए टारगेटिंग नियम के दायरे के बारे में पता चलता है जिनमें यह ऑफ़र तय किया गया है.

TargetingRuleScopeAnySubscriptionInApp

इस टाइप में कोई फ़ील्ड नहीं है.

पैरंट ऐप्लिकेशन में मौजूद किसी भी सदस्यता से जुड़े टारगेटिंग नियम के दायरे को दिखाता है.

UpgradeTargetingRule

यह फ़ॉर्म के टारगेटिंग नियम को दिखाता है: उपयोगकर्ता के पास फ़िलहाल {scope} [बिलिंग अवधि {billing_period} के साथ] है.

JSON के काेड में दिखाना
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
फ़ील्ड
oncePerUser

boolean

यह ऑफ़र, हर उपयोगकर्ता के लिए सिर्फ़ एक बार उपलब्ध कराएं. अगर इस वैल्यू को 'सही है' पर सेट किया जाता है, तो अगर उपयोगकर्ता ने पहले कभी इस ऑफ़र की सदस्यता ली है, तो वह फिर कभी इस ऑफ़र के लिए ज़रूरी शर्तें पूरी नहीं कर पाएगा.

scope

object (TargetingRuleScope)

ज़रूरी है. इस नियम में सदस्यताओं का दायरा. सिर्फ़ "यह सदस्यता" और "ऐप्लिकेशन में मौजूद खास सदस्यता" को अनुमति दी जाती है.

billingPeriodDuration

string

ISO 8601 फ़ॉर्मैट में बताई गई बिलिंग अवधि. इस नियम की ज़रूरी शर्तें पूरी करने के लिए, उपयोगकर्ता के पास इस अवधि के लिए सदस्यता होनी चाहिए. अगर कोई समयसीमा नहीं तय की जाती है, तो किसी भी बिलिंग अवधि की सदस्यता लेने वाले उपयोगकर्ताओं को मैच किया जाता है.

RegionalSubscriptionOfferConfig

किसी एक इलाके में सदस्यता के ऑफ़र का कॉन्फ़िगरेशन.

JSON के काेड में दिखाना
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
फ़ील्ड
regionCode

string

ज़रूरी है. इम्यूटेबल. ISO 3166-2 के मुताबिक, वह क्षेत्र कोड जिस पर यह कॉन्फ़िगरेशन लागू होता है. उदाहरण के लिए, "US".

newSubscriberAvailability

boolean

यह जानकारी कि किसी इलाके में सदस्यता का ऑफ़र, नए सदस्यों के लिए उपलब्ध है या नहीं. अगर इस वैल्यू को 'गलत' पर सेट किया जाता है, तो मौजूदा सदस्यों की सदस्यता रद्द नहीं की जाएगी. अगर इसकी वैल्यू नहीं दी जाती है, तो यह डिफ़ॉल्ट रूप से 'गलत' पर सेट हो जाएगी.

OtherRegionsSubscriptionOfferConfig

सदस्यता के ऑफ़र में बताई गई उन नई जगहों के लिए कॉन्फ़िगरेशन जहां Play लॉन्च हो सकता है.

JSON के काेड में दिखाना
{
  "otherRegionsNewSubscriberAvailability": boolean
}
फ़ील्ड
otherRegionsNewSubscriberAvailability

boolean

आने वाले समय में, Play किसी नई जगह पर सदस्यता का ऑफ़र लॉन्च कर सकता है या नहीं. अगर इसकी वैल्यू नहीं दी जाती है, तो यह डिफ़ॉल्ट रूप से 'गलत' पर सेट हो जाएगी.

तरीके

activate

सदस्यता का ऑफ़र चालू करता है.

batchGet

एक या उससे ज़्यादा सदस्यता ऑफ़र पढ़ता है.

batchUpdate

सदस्यता के ऑफ़र के एक ग्रुप को अपडेट करता है.

batchUpdateStates

सदस्यता के ऑफ़र की स्थितियों के एक ग्रुप को अपडेट करता है.

create

सदस्यता का नया ऑफ़र बनाता है.

deactivate

सदस्यता के किसी ऑफ़र को बंद करता है.

delete

सदस्यता के किसी ऑफ़र को मिटाता है.

get

एक ऑफ़र को पढ़ता है

list

किसी सदस्यता के तहत मिलने वाले सभी ऑफ़र की सूची दिखाता है.

patch

सदस्यता के किसी मौजूदा ऑफ़र को अपडेट करता है.