REST Resource: monetization.subscriptions

संसाधन: सदस्यता

किसी ऐप्लिकेशन के लिए एक सदस्यता.

JSON के काेड में दिखाना 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
फ़ील्ड
packageName

string

इम्यूटेबल. पैरंट ऐप्लिकेशन का पैकेज नेम.
productId

string

इम्यूटेबल. प्रॉडक्ट का यूनीक प्रॉडक्ट आईडी. यह पैरंट ऐप्लिकेशन में यूनीक होना चाहिए. प्रॉडक्ट आईडी में अंग्रेज़ी के छोटे अक्षर (a-z), संख्याएं (0-9), अंडरस्कोर (_), और बिंदु (.) होने चाहिए. यह अंग्रेज़ी के छोटे अक्षर या संख्या से शुरू होना चाहिए. साथ ही, इसमें 1 से 40 वर्ण होने चाहिए.
basePlans[]

object (BasePlan)

इस सदस्यता के लिए बुनियादी प्लान का सेट. अगर कोई अन्य ऑफ़र लागू नहीं होता है, तो यह सदस्यता की कीमतों और अवधि को दिखाता है.
listings[]

object (SubscriptionListing)

ज़रूरी है. इस सदस्यता के लिए, स्थानीय भाषा में उपलब्ध लिस्टिंग की सूची. इसमें पैरंट ऐप्लिकेशन की डिफ़ॉल्ट भाषा के लिए कम से कम एक एंट्री होनी चाहिए.
archived
(deprecated)

boolean

सिर्फ़ आउटपुट के लिए. बंद कर दी गई सुविधा: सदस्यता को संग्रहित करने की सुविधा काम नहीं करती.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

टैक्स और कानूनी नियमों के पालन के बारे में जानकारी.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

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

BasePlan

किसी सदस्यता के लिए एक बुनियादी प्लान.

JSON के काेड में दिखाना 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
फ़ील्ड
basePlanId

string

ज़रूरी है. इम्यूटेबल. इस बुनियादी प्लान का यूनीक आइडेंटिफ़ायर. यह सदस्यता के लिए यूनीक होना चाहिए. साथ ही, RFC-1034 के मुताबिक होना चाहिए. इसका मतलब है कि इस आईडी में सिर्फ़ अंग्रेज़ी के छोटे अक्षर (a-z), संख्याएं (0-9), और हाइफ़न (-) हो सकते हैं. साथ ही, इसमें ज़्यादा से ज़्यादा 63 वर्ण शामिल किए जा सकते हैं.
state

enum (State)

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

object (RegionalBasePlanConfig)

इस बुनियादी प्लान के लिए, इलाके के हिसाब से जानकारी.
offerTags[]

object (OfferTag)

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

object (OtherRegionsBasePlanConfig)

उन नई जगहों के लिए कीमत की जानकारी जहां Play आने वाले समय में लॉन्च हो सकता है. अगर इसे शामिल नहीं किया जाता है, तो आने वाले समय में Play जिन नई जगहों पर लॉन्च होगा वहां BasePlan अपने-आप उपलब्ध नहीं होगा.
यूनियन फ़ील्ड base_plan_type. यह बुनियादी प्लान किस तरह का है. इनमें से किसी एक को सेट करना ज़रूरी है. बुनियादी प्लान बनाने के बाद, उसके टाइप को बदला नहीं जा सकता. base_plan_type इनमें से सिर्फ़ एक हो सकता है:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

यह सेट करें कि बुनियादी प्लान, तय समय पर अपने-आप कब रिन्यू हो.
prepaidBasePlanType

object (PrepaidBasePlanType)

इस विकल्प को तब सेट किया जाता है, जब बिलिंग अवधि खत्म होने पर बुनियादी प्लान अपने-आप रिन्यू नहीं होता है.
installmentsBasePlanType

object (InstallmentsBasePlanType)

यह किस्तों वाले बुनियादी प्लान के लिए सेट किया जाता है. इसमें उपयोगकर्ता को तय संख्या में पेमेंट करना होता है.

स्थिति

बुनियादी प्लान की मौजूदा स्थिति.

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

AutoRenewingBasePlanType

यह एक बुनियादी प्लान है, जो सदस्यता की अवधि खत्म होने पर अपने-आप रिन्यू हो जाता है.

JSON के काेड में दिखाना 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
फ़ील्ड
billingPeriodDuration

string

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

string

सदस्यता के लिए ग्रेस पीरियड, जिसे ISO 8601 फ़ॉर्मैट में तय किया जाता है. स्वीकार की गई वैल्यू, दिनों में होनी चाहिए. साथ ही, यह P0D और 30D के बीच होनी चाहिए. इसके अलावा, यह बुनियादी प्लान के बिलिंग पीरियड से कम होनी चाहिए.

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

ग्रेस पीरियड और खाते पर लगी रोक की अवधि, दोनों मिलाकर P30D से P60D दिनों के बीच होनी चाहिए.
accountHoldDuration

string

ज़रूरी नहीं. सदस्यता के लिए खाते को होल्ड करने की अवधि, जिसे ISO 8601 फ़ॉर्मैट में बताया गया है. स्वीकार की जाने वाली वैल्यू, दिनों में होनी चाहिए. साथ ही, यह P0D और P60D के बीच होनी चाहिए.

अगर कोई वैल्यू तय नहीं की गई है, तो डिफ़ॉल्ट वैल्यू P30D होती है.

ग्रेस पीरियड और खाते पर लगी रोक की अवधि, दोनों मिलाकर P30D से P60D दिनों के बीच होनी चाहिए.
resubscribeState

enum (ResubscribeState)

इससे यह तय होता है कि क्या उपयोगकर्ता, Google Play के प्लैटफ़ॉर्म पर इस बुनियादी प्लान की सदस्यता फिर से ले सकते हैं. अगर कोई वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से RESUBSCRIBE_STATE_ACTIVE पर सेट होता है.
prorationMode

enum (SubscriptionProrationMode)

बुनियादी प्लान के लिए, प्रोरेटेड मोड से यह तय होता है कि जब कोई उपयोगकर्ता किसी दूसरे बुनियादी प्लान से इस प्लान पर स्विच करता है, तो क्या होता है. अगर यह वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से CHARGE_ON_NEXT_BILLING_DATE सेट हो जाती है.
legacyCompatible

boolean

रिन्यू किया जा रहा बुनियादी प्लान, पुराने सिस्टम के साथ काम करता है या नहीं.

पुराने सिस्टम के साथ काम करने वाला बुनियादी प्लान तब दिखाया जाएगा, जब Google Play Billing Library के लिए ऐसे तरीके का इस्तेमाल किया जाएगा जो अब उपलब्ध नहीं है querySkuDetailsAsync().

किसी सदस्यता के लिए, रिन्यू होने वाले सिर्फ़ एक बुनियादी प्लान को लेगसी वर्शन के साथ काम करने की सुविधा वाला प्लान के तौर पर मार्क किया जा सकता है.
legacyCompatibleSubscriptionOfferId

string

सदस्यता का ऑफ़र आईडी, जो लेगसी सिस्टम के साथ काम करता है.

पुराने सिस्टम के साथ काम करने वाला सदस्यता ऑफ़र तब दिखाया जाएगा, जब Google Play Billing Library के लिए ऐसे तरीके का इस्तेमाल किया जाएगा जो अब उपलब्ध नहीं है querySkuDetailsAsync().

रिन्यू होने वाले किसी बुनियादी प्लान के लिए, सिर्फ़ एक सदस्यता ऑफ़र को लेगसी वर्शन के साथ काम करने की सुविधा वाला के तौर पर मार्क किया जा सकता है.

अगर आपको किसी सदस्यता ऑफ़र को लेगसी सिस्टम के साथ काम करने वाला नहीं बनाना है, तो इस फ़ील्ड को खाली स्ट्रिंग के तौर पर सेट करें.

ResubscribeState

बुनियादी प्लान की सदस्यता फिर से लेने की स्थिति.

Enums
RESUBSCRIBE_STATE_UNSPECIFIED स्थिति की जानकारी नहीं दी गई है.
RESUBSCRIBE_STATE_ACTIVE फिर से सदस्यता लेने की सुविधा चालू है.
RESUBSCRIBE_STATE_INACTIVE फिर से सदस्यता लेने की सुविधा चालू नहीं है.

SubscriptionProrationMode

बुनियादी प्लान रिन्यू करने के लिए इस्तेमाल किया गया प्रोरेशन मोड.

Enums
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED मोड की जानकारी नहीं दी गई है.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE मौजूदा बिलिंग अवधि खत्म होने पर, लोगों से नए बुनियादी प्लान का शुल्क लिया जाएगा.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY उपयोगकर्ताओं से, नए बुनियादी प्लान का पूरा शुल्क तुरंत लिया जाएगा. उनकी मौजूदा सदस्यता की बची हुई अवधि का इस्तेमाल, नए बिलिंग प्लान की अवधि बढ़ाने के लिए किया जाएगा.

PrepaidBasePlanType

यह ऐसे बुनियादी प्लान को दिखाता है जो बुनियादी प्लान की अवधि खत्म होने पर अपने-आप रिन्यू नहीं होता. इसे उपयोगकर्ता को मैन्युअल तरीके से रिन्यू करना होता है.

JSON के काेड में दिखाना 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
फ़ील्ड
billingPeriodDuration

string

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

enum (TimeExtension)

क्या उपयोगकर्ताओं को Google Play के प्लैटफ़ॉर्म पर, इस प्रीपेड बुनियादी प्लान की अवधि बढ़ाने की अनुमति दी जानी चाहिए. अगर कोई वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से TIME_EXTENSION_ACTIVE वैल्यू सेट होती है.

TimeExtension

बुनियादी प्लान की समयसीमा बढ़ाना.

Enums
TIME_EXTENSION_UNSPECIFIED स्थिति की जानकारी नहीं दी गई है.
TIME_EXTENSION_ACTIVE समय बढ़ाने की सुविधा चालू है. उपयोगकर्ताओं को प्रीपेड प्लान को टॉप-अप करने या उसकी अवधि बढ़ाने की अनुमति होती है.
TIME_EXTENSION_INACTIVE समय बढ़ाने की सुविधा चालू नहीं है. उपयोगकर्ता, प्रीपेड प्लान को टॉप-अप नहीं कर सकते या उसकी अवधि नहीं बढ़ा सकते.

InstallmentsBasePlanType

यह किस्तों वाले बुनियादी प्लान को दिखाता है. इसमें उपयोगकर्ता, तय संख्या में पेमेंट करने का वादा करता है.

JSON के काेड में दिखाना 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
फ़ील्ड
billingPeriodDuration

string

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

integer

ज़रूरी है. इम्यूटेबल. उपयोगकर्ता को कितने पेमेंट करने हैं. बुनियादी प्लान बनाने के बाद, इसे बदला नहीं जा सकता.
renewalType

enum (RenewalType)

ज़रूरी है. इम्यूटेबल. किस्तों में पेमेंट करने की सुविधा वाले बुनियादी प्लान के रिन्यूअल का टाइप. यह कुकी, बिना सदस्यता रद्द किए तय की गई शुरुआती अवधि के खत्म होने पर होने वाली कार्रवाई तय करती है. बुनियादी प्लान बनाने के बाद, रिन्यूअल का टाइप नहीं बदला जा सकता.
gracePeriodDuration

string

सदस्यता के लिए ग्रेस पीरियड, जिसे ISO 8601 फ़ॉर्मैट में तय किया जाता है. स्वीकार की गई वैल्यू, दिनों में होनी चाहिए. साथ ही, यह P0D और 30D के बीच होनी चाहिए. इसके अलावा, यह बुनियादी प्लान के बिलिंग पीरियड से कम होनी चाहिए.

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

ग्रेस पीरियड और खाते पर लगी रोक की अवधि, दोनों मिलाकर P30D से P60D दिनों के बीच होनी चाहिए.
accountHoldDuration

string

ज़रूरी नहीं. सदस्यता के लिए खाते को होल्ड करने की अवधि, जिसे ISO 8601 फ़ॉर्मैट में बताया गया है. स्वीकार की जाने वाली वैल्यू, दिनों में होनी चाहिए. साथ ही, यह P0D और P60D के बीच होनी चाहिए.

अगर कोई वैल्यू तय नहीं की गई है, तो डिफ़ॉल्ट वैल्यू P30D होती है.

ग्रेस पीरियड और खाते पर लगी रोक की अवधि, दोनों मिलाकर P30D से P60D दिनों के बीच होनी चाहिए.
resubscribeState

enum (ResubscribeState)

इससे यह तय होता है कि क्या उपयोगकर्ता, Google Play के प्लैटफ़ॉर्म पर इस बुनियादी प्लान की सदस्यता फिर से ले सकते हैं. अगर कोई वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से RESUBSCRIBE_STATE_ACTIVE पर सेट होता है.
prorationMode

enum (SubscriptionProrationMode)

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

RenewalType

किस्तों में पेमेंट करने की सुविधा वाले बुनियादी प्लान के रिन्यूअल का टाइप. यह कुकी, बिना सदस्यता रद्द किए तय की गई शुरुआती अवधि के खत्म होने पर होने वाली कार्रवाई तय करती है. बुनियादी प्लान बनाने के बाद, रिन्यूअल का टाइप नहीं बदला जा सकता.

Enums
RENEWAL_TYPE_UNSPECIFIED स्थिति की जानकारी नहीं दी गई है.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT यह सदस्यता, बिलिंग अवधि के लिए बिना किसी शर्त के समय-समय पर रिन्यू होती है.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT यह प्लान, उसी अवधि के लिए रिन्यू होता है जिसके लिए आपने इसे खरीदा था.

RegionalBasePlanConfig

किसी देश/इलाके के लिए बुनियादी प्लान का कॉन्फ़िगरेशन.

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

string

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

boolean

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

object (Money)

चुने गए देश/इलाके में बुनियादी प्लान की कीमत. अगर बुनियादी प्लान नए सदस्यों के लिए उपलब्ध है, तो इसे सेट करना ज़रूरी है. इसे उस मुद्रा में सेट किया जाना चाहिए जो बताए गए क्षेत्र से जुड़ी है.

OtherRegionsBasePlanConfig

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

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

object (Money)

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

object (Money)

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

boolean

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

SubscriptionListing

सदस्यता का वह मेटाडेटा जो खरीदार को दिखता है.

JSON के काेड में दिखाना 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
फ़ील्ड
languageCode

string

ज़रूरी है. BCP-47 के मुताबिक, इस लिस्टिंग की भाषा. उदाहरण के लिए, "en-US".
title

string

ज़रूरी है. इस सदस्यता का टाइटल, इस लिस्टिंग की भाषा में. सामान्य टेक्स्ट.
benefits[]

string

फ़ायदों की सूची, Play Store जैसे प्लैटफ़ॉर्म पर उपयोगकर्ता को दिखाई जाती है. साथ ही, सदस्यता बहाल करने के फ़्लो में भी यह सूची दिखती है. यह सूची, इस स्टोर पेज की भाषा में होती है. सामान्य टेक्स्ट. ज़्यादा से ज़्यादा चार फ़ायदों की क्रम से लगाई गई सूची.
description

string

इस सदस्यता का ब्यौरा, इस लिस्टिंग की भाषा में. ज़्यादा से ज़्यादा 80 वर्ण इस्तेमाल किए जा सकते हैं. सामान्य टेक्स्ट.

तरीके

archive
(deprecated)

 बंद कर दी गई सुविधा: सदस्यता को संग्रहित करने की सुविधा काम नहीं करती.

batchGet

 यह कुकी, एक या उससे ज़्यादा सदस्यताओं को पढ़ती है.

batchUpdate

 सदस्यताओं के बैच को अपडेट करता है.

create

 इससे नई सदस्यता बनती है.

delete

 यह सदस्यता मिटाता है.

get

 एक सदस्यता की जानकारी पढ़ता है.

list

 यह किसी ऐप्लिकेशन के तहत मौजूद सभी सदस्यताओं की सूची दिखाता है.

patch

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