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
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.
जब तक कुछ अलग से न बताया जाए, तब तक इस पेज की सामग्री को Creative Commons Attribution 4.0 License के तहत और कोड के नमूनों को Apache 2.0 License के तहत लाइसेंस मिला है. ज़्यादा जानकारी के लिए, Google Developers साइट नीतियां देखें. Oracle और/या इससे जुड़ी हुई कंपनियों का, Java एक रजिस्टर किया हुआ ट्रेडमार्क है.
आखिरी बार 2025-07-25 (UTC) को अपडेट किया गया.
[null,null,["आखिरी बार 2025-07-25 (UTC) को अपडेट किया गया."],[],[],null,["# Method: subscriptions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.Subscriptions.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.\n\nOptionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions).\n\n### HTTP request\n\n`GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerAuthToken` | `string` The `customerAuthToken` query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the [administrator help center](//support.google.com/a/bin/answer.py?answer=142336). |\n| `customerId` | `string` This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. |\n| `customerNamePrefix` | `string` When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes `exam.com`, `example20.com` and `example.com`: - `exa` -- Returns all customer names that start with 'exa' which could include `exam.com`, `example20.com`, and `example.com`. A name prefix is similar to using a regular expression's asterisk, exa\\*. - `example` -- Returns `example20.com` and `example.com`. \u003cbr /\u003e |\n| `maxResults` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` When retrieving a large list, the `maxResults` is the maximum number of results per page. The `nextPageToken` value takes you to the next page. The default is 20. |\n| `pageToken` | `string` Token to specify next page in the list |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA subscription manages the relationship of a Google customer's payment plan with a product's SKU, user licenses, 30-day free trial status, and renewal options. A primary role of a reseller is to manage the Google customer's subscriptions.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"subscriptions\": [ { object (/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions |\n| `subscriptions[]` | `object (`[Subscription](/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription)`)` The subscriptions in this page of results. |\n| `nextPageToken` | `string` The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/apps.order`\n- `\n https://www.googleapis.com/auth/apps.order.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]