REST Resource: purchases.subscriptions

रिसॉर्स: SubscriptionPurchase

SubscriptionPurchase रिसॉर्स से, उपयोगकर्ता की सदस्यता खरीदारी की स्थिति का पता चलता है.

JSON के काेड में दिखाना
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
फ़ील्ड
kind

string

यह टाइप, androidpublisher सेवा में subscriptionPurchase ऑब्जेक्ट को दिखाता है.

startTimeMillis

string (int64 format)

सदस्यता मिलने का समय, मिलीसेकंड में. यह समय, Epoch के बाद का होता है.

expiryTimeMillis

string (int64 format)

सदस्यता की समयसीमा खत्म होने का समय, मिलीसेकंड में. यह समय, Epoch के बाद का होता है.

autoResumeTimeMillis

string (int64 format)

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

autoRenewing

boolean

सदस्यता की मौजूदा समयसीमा खत्म होने पर, क्या वह अपने-आप रिन्यू होगी.

priceCurrencyCode

string

सदस्यता की कीमत के लिए ISO 4217 मुद्रा कोड. उदाहरण के लिए, अगर कीमत ब्रिटिश पाउंड में दी गई है, तो priceCurrencyCode "GBP" होगा.

priceAmountMicros

string (int64 format)

सदस्यता की कीमत. टैक्स के बिना कीमत वाले देशों के लिए, कीमत में टैक्स शामिल नहीं होता. जिन देशों में कीमत में टैक्स शामिल होता है वहां कीमत में टैक्स शामिल होता है. कीमत को माइक्रो-यूनिट में दिखाया जाता है. यहां 1, 000,000 माइक्रो-यूनिट,मुद्रा की एक इकाई के बराबर होते हैं. उदाहरण के लिए, अगर सदस्यता की कीमत 1.99 यूरो है, तो priceAmountMicros की वैल्यू 1990000 होगी.

introductoryPriceInfo

object (IntroductoryPriceInfo)

सदस्यता की शुरुआती कीमत की जानकारी. यह सिर्फ़ तब दिखता है, जब सदस्यता को शुरुआती कीमत पर खरीदा गया हो.

इस फ़ील्ड से यह पता नहीं चलता कि सदस्यता फ़िलहाल शुरुआती कीमत वाली अवधि में है या नहीं.

countryCode

string

सदस्यता मिलने के समय, उपयोगकर्ता के देश/इलाके का ISO 3166-1 alpha-2 बिलिंग कोड.

developerPayload

string

डेवलपर की तय की गई स्ट्रिंग, जिसमें ऑर्डर के बारे में अतिरिक्त जानकारी होती है.

paymentState

integer

सदस्यता के लिए किए गए पेमेंट की स्थिति. वैल्यू, इनमें से कोई हो सकती है: 0. पेमेंट को मंज़ूरी मिलना बाकी है 1. पेमेंट मिल गया 2. मुफ़्त में आज़माएं 3. अपग्रेड/डाउनग्रेड की प्रक्रिया पूरी नहीं हुई

रद्द की गई और समयसीमा खत्म हो चुकी सदस्यताओं के लिए उपलब्ध नहीं है.

cancelReason

integer

सदस्यता रद्द होने या अपने-आप रिन्यू न होने की वजह. वैल्यू, इनमें से कोई हो सकती है: 0. उपयोगकर्ता ने पहली सदस्यता रद्द कर दी. सिस्टम ने सदस्यता रद्द कर दी है. उदाहरण के लिए, बिलिंग से जुड़ी समस्या की वजह से. सदस्यता को नई सदस्यता 3 से बदल दिया गया. डेवलपर ने सदस्यता रद्द कर दी है

userCancellationTimeMillis

string (int64 format)

वह समय जब उपयोगकर्ता ने सदस्यता रद्द की थी. यह समय, युग के शुरू होने के बाद के मिलीसेकंड में होता है. यह सिर्फ़ तब मौजूद होता है, जब cancelReason 0 हो.

cancelSurveyResult

object (SubscriptionCancelSurveyResult)

सदस्यता रद्द करने की प्रोसेस पूरी करने के बाद, उपयोगकर्ता से मिली जानकारी (सदस्यता रद्द करने की वजह का सर्वे).

orderId

string

सदस्यता की खरीदारी से जुड़े, बार-बार होने वाले नए ऑर्डर का ऑर्डर आईडी. अगर पेमेंट अस्वीकार होने की वजह से सदस्यता रद्द की गई थी, तो यह अस्वीकार किए गए पेमेंट के ऑर्डर का ऑर्डर आईडी होगा.

linkedPurchaseToken

string

अगर यह सदस्यता इनमें से कोई एक है, तो मूल खरीदारी का टोकन: 0. रद्द की गई, लेकिन खत्म नहीं हुई सदस्यता के लिए फिर से साइन अप करना 1. पिछली सदस्यता को अपग्रेड या डाउनग्रेड करना

उदाहरण के लिए, मान लें कि कोई उपयोगकर्ता मूल रूप से साइन अप करता है और आपको खरीदारी का टोकन X मिलता है. इसके बाद, उपयोगकर्ता सदस्यता रद्द कर देता है और सदस्यता खत्म होने से पहले, फिर से साइन अप करने की प्रोसेस पूरी करता है. इस दौरान, आपको खरीदारी का टोकन Y मिलता है. आखिर में, उपयोगकर्ता अपनी सदस्यता को अपग्रेड करता है और आपको खरीदारी का टोकन Z मिलता है. अगर इस एपीआई को खरीदारी टोकन Z के साथ कॉल किया जाता है, तो यह फ़ील्ड Y पर सेट हो जाएगा. अगर इस एपीआई को खरीदारी टोकन Y के साथ कॉल किया जाता है, तो यह फ़ील्ड X पर सेट हो जाएगा. अगर इस एपीआई को खरीदारी टोकन X के साथ कॉल किया जाता है, तो यह फ़ील्ड सेट नहीं होगा.

purchaseType

integer

सदस्यता खरीदने का तरीका. यह फ़ील्ड सिर्फ़ तब सेट होता है, जब यह खरीदारी स्टैंडर्ड इन-ऐप्लिकेशन बिलिंग फ़्लो का इस्तेमाल करके नहीं की गई थी. वैल्यू, इनमें से कोई हो सकती है: 0. टेस्ट (जैसे, लाइसेंस टेस्टिंग खाते से खरीदा गया) 1. प्रोमो (जैसे, प्रोमो कोड का इस्तेमाल करके खरीदा गया)

priceChange

object (SubscriptionPriceChange)

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

सदस्यता की नई कीमत पर रिन्यू होने या रद्द होने के बाद, कीमत में हुए बदलाव की कोई जानकारी नहीं दी जाएगी.

profileName

string

सदस्यता खरीदने के समय, उपयोगकर्ता की प्रोफ़ाइल का नाम. यह सिर्फ़ 'Subscribe with Google' से की गई खरीदारी के लिए मौजूद है.

emailAddress

string

सदस्यता खरीदते समय उपयोगकर्ता का ईमेल पता. यह सिर्फ़ 'Subscribe with Google' से की गई खरीदारी के लिए मौजूद है.

givenName

string

सदस्यता खरीदते समय उपयोगकर्ता का दिया गया नाम. यह सिर्फ़ 'Subscribe with Google' से की गई खरीदारी के लिए उपलब्ध है.

familyName

string

सदस्यता खरीदते समय उपयोगकर्ता का उपनाम. यह सिर्फ़ 'Subscribe with Google' से की गई खरीदारी के लिए मौजूद है.

profileId

string

सदस्यता खरीदने के समय, उपयोगकर्ता का Google प्रोफ़ाइल आईडी. यह सिर्फ़ 'Subscribe with Google' से की गई खरीदारी के लिए मौजूद है.

acknowledgementState

integer

सदस्यता वाले प्रॉडक्ट की पुष्टि की स्थिति. वैल्यू, इनमें से कोई हो सकती है: 0. स्वीकार नहीं किया गया 1. स्वीकृत

externalAccountId

string

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

promotionType

integer

इस खरीदारी पर लागू किया गया प्रमोशन टाइप. यह फ़ील्ड सिर्फ़ तब सेट होता है, जब सदस्यता खरीदते समय कोई प्रमोशन लागू किया गया हो. वैल्यू, इनमें से कोई हो सकती है: 0. एक बार इस्तेमाल होने वाला कोड 1. वैनिटी कोड

promotionCode

string

इस खरीदारी पर लागू किया गया प्रोमो कोड. यह फ़ील्ड सिर्फ़ तब सेट होता है, जब सदस्यता खरीदते समय कोई वैनिटी कोड प्रोमो लागू किया गया हो.

obfuscatedExternalAccountId

string

आईडी का ऐसा वर्शन जिसे छिपाया गया है. यह आईडी, आपके ऐप्लिकेशन में उपयोगकर्ता के खाते से खास तौर पर जुड़ा होता है. यह इन खरीदारी के लिए मौजूद होता है: * अगर सदस्यता खरीदने के फ़्लो के दौरान खाता लिंक किया गया है. * खरीदारी करते समय, https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid का इस्तेमाल करके, यह जानकारी दी गई थी.

obfuscatedExternalProfileId

string

आईडी का ऐसा वर्शन जिसे बदला गया है. यह आपके ऐप्लिकेशन में उपयोगकर्ता की प्रोफ़ाइल से यूनीक तरीके से जुड़ा होता है. यह सिर्फ़ तब मौजूद होता है, जब खरीदारी करते समय https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid का इस्तेमाल करके बताया गया हो.

IntroductoryPriceInfo

इसमें किसी सदस्यता के लिए, शुरुआती कीमत की जानकारी शामिल होती है.

JSON के काेड में दिखाना
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
फ़ील्ड
introductoryPriceCurrencyCode

string

शुरुआती सदस्यता की कीमत के लिए, ISO 4217 मुद्रा कोड. उदाहरण के लिए, अगर कीमत ब्रिटिश पाउंड में दी गई है, तो priceCurrencyCode "GBP" होगा.

introductoryPriceAmountMicros

string (int64 format)

सदस्यता की शुरुआती कीमत, जिसमें टैक्स शामिल नहीं है. मुद्रा, priceCurrencyCode जैसी ही है. कीमत को माइक्रो-यूनिट में दिखाया जाता है. यहां 1, 000,000 माइक्रो-यूनिट,मुद्रा की एक इकाई के बराबर होते हैं. उदाहरण के लिए, अगर सदस्यता की कीमत 1.99 यूरो है, तो priceAmountMicros की वैल्यू 1990000 होगी.

introductoryPricePeriod

string

शुरुआती कीमत की अवधि, जो ISO 8601 फ़ॉर्मैट में दी गई है. आम तौर पर, "P1W" (एक हफ़्ता), "P1M" (एक महीना), "P3M" (तीन महीने), "P6M" (छह महीने), और "P1Y" (एक साल) जैसी वैल्यू इस्तेमाल की जाती हैं. हालांकि, इनके अलावा और भी वैल्यू इस्तेमाल की जा सकती हैं.

introductoryPriceCycles

integer

शुरुआती कीमत की सुविधा देने के लिए, बिलिंग अवधि की संख्या.

SubscriptionCancelSurveyResult

सदस्यता रद्द करने की प्रोसेस पूरी करने के बाद, उपयोगकर्ता से मिली जानकारी (सदस्यता रद्द करने की वजह का सर्वे).

JSON के काेड में दिखाना
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
फ़ील्ड
cancelSurveyReason

integer

सदस्यता रद्द करने की वह वजह जो उपयोगकर्ता ने सर्वे में चुनी है. वैल्यू, इनमें से कोई हो सकती है: 0. अन्य 1. यह सेवा मेरे लिए बहुत ज़्यादा काम की नहीं है 2. तकनीकी समस्याएं 3. कीमत से जुड़ी वजहें 4. मुझे एक बेहतर ऐप्लिकेशन मिला है

userInputCancelReason

string

उपयोगकर्ता की ओर से सदस्यता रद्द करने की वजह. यह सिर्फ़ तब मौजूद होता है, जब cancelReason 0 हो.

SubscriptionPriceChange

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

JSON के काेड में दिखाना
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
फ़ील्ड
newPrice

object (Price)

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

state

integer

कीमत में बदलाव की मौजूदा स्थिति. वैल्यू, इनमें से कोई हो सकती है: 0. बाकी है: कीमत में हुए ऐसे बदलाव की स्थिति जिस पर उपयोगकर्ता की सहमति मिलना बाकी है. इस स्थिति में, आपके पास In-App API का इस्तेमाल करके, उपयोगकर्ता से पुष्टि करने का विकल्प होता है. 1. स्वीकार किया गया: कीमत में हुए उस बदलाव के लिए बताएं जिसे स्वीकार कर लिया गया है. सदस्यता को तब तक रिन्यू किया जाएगा, जब तक उसे रद्द नहीं कर दिया जाता. कीमत में बदलाव, सदस्यता के रिन्यू होने की तारीख को लागू होता है. ध्यान दें कि ऐसा हो सकता है कि सदस्यता के अगले रिन्यूअल पर, यह बदलाव न हो.

तरीके

acknowledge

सदस्यता खरीदने की पुष्टि करता है.

cancel

उपयोगकर्ता की सदस्यता की खरीदारी रद्द करता है.

defer

उपयोगकर्ता की सदस्यता खरीदारी को, सदस्यता खत्म होने के तय समय तक के लिए रोक देता है.

get

यह जांचता है कि उपयोगकर्ता की सदस्यता की खरीदारी मान्य है या नहीं. साथ ही, सदस्यता की समयसीमा खत्म होने का समय दिखाता है.

refund

उपयोगकर्ता की खरीदी गई सदस्यता का रिफ़ंड देता है. हालांकि, सदस्यता खत्म होने की तय अवधि तक मान्य रहती है और वह बार-बार रिन्यू होती रहेगी.

revoke

उपयोगकर्ता की सदस्यता की खरीदारी का रिफ़ंड देता है और उसे तुरंत रद्द कर देता है.