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

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

enum (State)

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

object (RegionalBasePlanConfig)

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

object (OfferTag)

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

object (OtherRegionsBasePlanConfig)

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

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

string

ISO 8601 फ़ॉर्मैट में दी गई सदस्यता की ग्रेस पीरियड. मान्य वैल्यू हैं: P0D (शून्य दिन), P3D (3 दिन), P7D (7 दिन), P14D (14 दिन), और P30D (30 दिन). अगर यह वैल्यू तय नहीं की गई है, तो बार-बार लगने वाले कुल समय के आधार पर, किसी डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाएगा.
accountHoldDuration

string

ज़रूरी नहीं. ISO 8601 फ़ॉर्मैट में दी गई सदस्यता के लिए खाते पर रोक लगाने की अवधि. स्वीकार की जाने वाली वैल्यू DAYS के बीच की होनी चाहिए. साथ ही, वैल्यू P0D (शून्य दिन) से लेकर P30D (30 दिन) के बीच की होनी चाहिए. अगर इसके बारे में तय नहीं किया गया है, तो डिफ़ॉल्ट वैल्यू P30D (30 दिन) होती है.
resubscribeState

enum (ResubscribeState)

उपयोगकर्ता, Google Play के अलग-अलग प्लैटफ़ॉर्म पर बुनियादी प्लान की सदस्यता फिर से ले सकते हैं या नहीं. अगर इसके बारे में नहीं बताया गया है, तो डिफ़ॉल्ट तौर पर यह RE स्ट्रक्चर्ड_STATUS_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

ज़रूरी है. सदस्यता अवधि, आईएसओ 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

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

integer

ज़रूरी है. उपयोगकर्ता कितने पेमेंट करता है.
renewalType

enum (RenewalType)

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

string

ISO 8601 फ़ॉर्मैट में दी गई सदस्यता की ग्रेस पीरियड. मान्य वैल्यू हैं: P0D (शून्य दिन), P3D (3 दिन), P7D (7 दिन), P14D (14 दिन), और P30D (30 दिन). अगर यह वैल्यू तय नहीं की गई है, तो बार-बार लगने वाले कुल समय के आधार पर, किसी डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाएगा.
accountHoldDuration

string

ज़रूरी नहीं. सदस्यता के खाते पर रोक लगने की अवधि, जो खास तौर पर दिनों में और ISO 8601 फ़ॉर्मैट में दी गई है. P0D (शून्य दिन) से P30D (30 दिन) तक की वैल्यू स्वीकार की जाती हैं. अगर इसके बारे में तय नहीं किया गया है, तो डिफ़ॉल्ट वैल्यू P30D (30 दिन) होती है.
resubscribeState

enum (ResubscribeState)

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

तरीके

archive
(deprecated)

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

batchGet

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

batchUpdate

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

create

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

delete

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

get

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

list

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

patch

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