Method: subscriptions.list

रीसेलर के ज़रिए मैनेज की जाने वाली सदस्यताओं की सूचियां. सूची में सभी सदस्यताएं, किसी ग्राहक की सभी सदस्यताएं या किसी ग्राहक की ट्रांसफ़र की जा सकने वाली सभी सदस्यताएं शामिल हो सकती हैं.

इसके अलावा, इस तरीके से जवाब को customerNamePrefix के हिसाब से फ़िल्टर किया जा सकता है. ज़्यादा जानकारी के लिए, सदस्यताएं मैनेज करना लेख पढ़ें.

एचटीटीपी अनुरोध

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

क्वेरी पैरामीटर

पैरामीटर
customerAuthToken

string

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

customerId

string

यह ग्राहक का प्राइमरी डोमेन नेम या ग्राहक का यूनीक आइडेंटिफ़ायर हो सकता है. अगर किसी ग्राहक का डोमेन नेम बदल जाता है, तो ग्राहक को ऐक्सेस करने के लिए पुराने डोमेन नेम का इस्तेमाल नहीं किया जा सकता. हालांकि, ग्राहक के यूनीक आइडेंटिफ़ायर (जैसा कि एपीआई से मिलता है) का इस्तेमाल हमेशा किया जा सकता है. हमारा सुझाव है कि जहां भी लागू हो, अपने सिस्टम में यूनीक आइडेंटिफ़ायर सेव करें.

customerNamePrefix

string

अपनी सभी सदस्यताओं को वापस लाने और चुनिंदा ग्राहकों के लिए फ़िल्टर करते समय, ग्राहक के नाम के लिए कोई प्रीफ़िक्स डाला जा सकता है. exam.com, example20.com, और example.com वाले ग्राहक ग्रुप के उदाहरण का इस्तेमाल करके:

  • exa -- 'exa' से शुरू होने वाले सभी ग्राहकों के नाम दिखाता है. इनमें exam.com, example20.com, और example.com शामिल हो सकते हैं. नाम का प्रीफ़िक्स, रेगुलर एक्सप्रेशन के ऐस्टरिस्क, exa* का इस्तेमाल करने जैसा है.
  • example -- example20.com और example.com दिखाता है.

maxResults

integer (uint32 format)

बड़ी सूची को फिर से पाने पर, maxResults हर पेज पर नतीजों की ज़्यादा से ज़्यादा संख्या होती है. nextPageToken वैल्यू आपको अगले पेज पर ले जाती है. डिफ़ॉल्ट रूप से, यह संख्या 20 होती है.

pageToken

string

सूची में अगले पेज की जानकारी देने वाला टोकन

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

सदस्यता, Google के ग्राहक के पेमेंट प्लान को प्रॉडक्ट के एसकेयू, उपयोगकर्ता के लाइसेंस, 30 दिनों के मुफ़्त ट्रायल की स्थिति, और रिन्यूअल के विकल्पों के साथ मैनेज करती है. रीसेलर की मुख्य भूमिका, Google के ग्राहक की सदस्यताओं को मैनेज करना है.

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

JSON के काेड में दिखाना
{
  "kind": string,
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
kind

string

संसाधन को सदस्यताओं के कलेक्शन के तौर पर पहचानता है. वैल्यू: reseller#subscriptions

subscriptions[]

object (Subscription)

नतीजों के इस पेज पर मौजूद सदस्यताएं.

nextPageToken

string

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

अनुमति के दायरे

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/apps.order
  • https://www.googleapis.com/auth/apps.order.readonly

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.