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 कस्टम टैग की सूची. ये टैग, Billing Library की मदद से ऐप्लिकेशन को दिखाए जाते हैं. इस बुनियादी प्लान के लिए सदस्यता के ऑफ़र को भी बिलिंग लाइब्रेरी में ये ऑफ़र टैग मिलेंगे.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

आने वाले समय में, Play जिन नई जगहों पर लॉन्च हो सकता है उनके लिए कीमत की जानकारी. अगर इस एट्रिब्यूट की वैल्यू नहीं दी जाती है, तो BasePlan उन सभी नई जगहों पर अपने-आप उपलब्ध नहीं होगा जहां Play आने वाले समय में लॉन्च हो सकता है.
यूनियन फ़ील्ड 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 के बीच होनी चाहिए. हालांकि, यह बुनियादी प्लान की बिलिंग अवधि से कम होनी चाहिए.

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

gracePeriodDuration और accountHoldDuration की वैल्यू का कुल योग, P30D से P60D के बीच होना चाहिए.
accountHoldDuration

string

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

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

gracePeriodDuration और accountHoldDuration की वैल्यू का कुल योग, 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

सदस्यता का ऑफ़र आईडी, जो 'Play Billing लाइब्रेरी' के पुराने वर्शन के साथ काम करता है.

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

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

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

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 के बीच होनी चाहिए. हालांकि, यह बुनियादी प्लान की बिलिंग अवधि से कम होनी चाहिए.

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

gracePeriodDuration और accountHoldDuration की वैल्यू का कुल योग, P30D से P60D के बीच होना चाहिए.
accountHoldDuration

string

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

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

gracePeriodDuration और accountHoldDuration की वैल्यू का कुल योग, 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

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

boolean

किसी खास इलाके में, बुनियादी प्लान नए सदस्यों के लिए उपलब्ध है या नहीं. अगर इस वैल्यू को 'गलत' पर सेट किया जाता है, तो मौजूदा सदस्यों की सदस्यता रद्द नहीं की जाएगी. अगर इसकी वैल्यू नहीं दी जाती है, तो यह डिफ़ॉल्ट रूप से 'गलत' पर सेट हो जाएगी.
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 वर्ण इस्तेमाल किए जा सकते हैं. प्लेन टेक्स्ट.

RestrictedPaymentCountries

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

JSON के काेड में दिखाना 
{
  "regionCodes": [
    string
  ]
}
फ़ील्ड
regionCodes[]

string

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

तरीके

archive
(deprecated)

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

batchGet

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

batchUpdate

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

create

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

delete

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

get

 एक सदस्यता को पढ़ता है.

list

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

patch

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