संग्रह की मदद से व्यवस्थित रहें
अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.
इस पेज पर, subscriptions.list() तरीके का इस्तेमाल करके, Google Workspace की सदस्यताओं को लिस्ट करने का तरीका बताया गया है.
उपयोगकर्ता की पुष्टि करने के साथ इस तरीके को कॉल करने पर, यह तरीका उन सदस्यताओं की सूची दिखाता है जिनके लिए उपयोगकर्ता ने अनुमति दी है. ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल करने पर, यह तरीका एक ऐसी सूची दिखा सकता है जिसमें ऐप्लिकेशन के लिए उपलब्ध सभी सदस्यताएं शामिल हों.
ज़रूरी शर्तें
Apps Script
Google Workspace की सदस्यता. इसे बनाने के लिए, सदस्यता बनाना लेख पढ़ें.
Apps Script से अपने-आप बनाए गए डिफ़ॉल्ट प्रोजेक्ट के बजाय, अपने Google Cloud प्रोजेक्ट का इस्तेमाल करें.
आपने OAuth सहमति स्क्रीन को कॉन्फ़िगर करने के लिए जो भी स्कोप जोड़े हैं उन्हें आपको अपने Apps Script प्रोजेक्ट की appsscript.json फ़ाइल में भी जोड़ना होगा.
उदाहरण के लिए, अगर आपने chat.messages स्कोप तय किया है, तो यह जानकारी जोड़ें:
उपयोगकर्ता की पुष्टि करने के लिए, ऐसे स्कोप की ज़रूरत होती है जो सदस्यता के लिए कम से कम एक इवेंट टाइप के साथ काम करता हो. स्कोप की पहचान करने के लिए, इवेंट टाइप के हिसाब से स्कोप देखें.
ऐप्लिकेशन की पुष्टि करने के लिए, chat.bot स्कोप की ज़रूरत होती है. यह सिर्फ़ Google Chat ऐप्लिकेशन के लिए है.
किसी उपयोगकर्ता की ओर से अनुमति दी गई सदस्यताओं की सूची
सदस्यताएं दिखाने के लिए, आपको कम से कम एक इवेंट टाइप के हिसाब से फ़िल्टर करना होगा. एक या उससे ज़्यादा टारगेट रिसॉर्स के हिसाब से भी क्वेरी को फ़िल्टर किया जा सकता है. क्वेरी फ़िल्टर के बारे में जानने के लिए, list() तरीके का दस्तावेज़ देखें.
नीचे दिए गए कोड के सैंपल में, Subscription ऑब्जेक्ट का एक कलेक्शन दिखाया गया है. इसे इवेंट टाइप और टारगेट रिसॉर्स के हिसाब से फ़िल्टर किया गया है. उपयोगकर्ता के तौर पर पुष्टि होने पर, यह तरीका सिर्फ़ उन सदस्यताओं की सूची दिखाता है जिन्हें बनाने की अनुमति उपयोगकर्ता ने ऐप्लिकेशन को दी है.
किसी इवेंट टाइप और टारगेट रिसॉर्स के लिए सदस्यताएं दिखाने के लिए:
Apps Script
अपने Apps Script प्रोजेक्ट में, listSubscriptions नाम की एक नई स्क्रिप्ट फ़ाइल बनाएं और उसमें यह कोड जोड़ें:
functionlistSubscriptions(){// Filter for event type (required).consteventType='EVENT_TYPE';// Filter for target resource (optional).consttargetResource='TARGET_RESOURCE';constfilter=`event_types:"${eventType}" AND target_resource="${targetResource}"`// Call the Workspace Events API using the advanced service.constresponse=WorkspaceEvents.Subscriptions.list({filter});console.log(response);}
इनकी जगह ये डालें:
EVENT_TYPE: CloudEvents स्पेसिफ़िकेशन के मुताबिक फ़ॉर्मैट किया गया इवेंट टाइप. उदाहरण के लिए, Google Chat स्पेस में नई सदस्यताओं के बारे में इवेंट पाने वाली सदस्यताओं को फ़िल्टर करने के लिए, google.workspace.chat.message.v1.created.
TARGET_RESOURCE: यह टारगेट संसाधन है. इसे इसके पूरे संसाधन नाम के तौर पर फ़ॉर्मैट किया जाता है. उदाहरण के लिए, Google Chat स्पेस के लिए सदस्यताएं फ़िल्टर करने के लिए, //chat.googleapis.com/spaces/SPACE_ID का इस्तेमाल करें. यहां spaces/SPACE_ID, Space संसाधन के लिए name फ़ील्ड को दिखाता है.
सदस्यताओं की सूची बनाने के लिए, अपने Apps Script प्रोजेक्ट में listSubscriptions फ़ंक्शन चलाएं.
Python
अपनी वर्किंग डायरेक्ट्री में, list_subscriptions.py नाम की एक फ़ाइल बनाएं और उसमें यह कोड जोड़ें:
"""List subscriptions."""fromgoogle_auth_oauthlib.flowimportInstalledAppFlowfromgoogleapiclient.discoveryimportbuild# Specify required scopes.SCOPES=['SCOPE']# Authenticate with Google Workspace and get user authentication.flow=InstalledAppFlow.from_client_secrets_file('credentials.json',SCOPES)CREDENTIALS=flow.run_local_server()# Call the Workspace Events API using the service endpoint.service=build('workspaceevents','v1',credentials=CREDENTIALS,)# Filter for event type (required).EVENT_TYPE='EVENT_TYPE'# Filter for target resource (optional).TARGET_RESOURCE='TARGET_RESOURCE'FILTER=f'event_types:"{EVENT_TYPE}" AND target_resource="{TARGET_RESOURCE}"'response=service.subscriptions().list(filter=FILTER).execute()print(response)
EVENT_TYPE: CloudEvents स्पेसिफ़िकेशन के मुताबिक फ़ॉर्मैट किया गया इवेंट टाइप. उदाहरण के लिए, Google Chat स्पेस में नई सदस्यताओं के बारे में इवेंट पाने वाली सदस्यताओं को फ़िल्टर करने के लिए, google.workspace.chat.message.v1.created.
TARGET_RESOURCE: यह टारगेट संसाधन है. इसे इसके पूरे संसाधन नाम के तौर पर फ़ॉर्मैट किया जाता है. उदाहरण के लिए, Google Chat स्पेस के लिए सदस्यताएं फ़िल्टर करने के लिए, //chat.googleapis.com/spaces/SPACE_ID का इस्तेमाल करें. यहां spaces/SPACE_ID, Space संसाधन के लिए name फ़ील्ड को दिखाता है.
अपनी वर्किंग डायरेक्ट्री में, पक्का करें कि आपने OAuth क्लाइंट आईडी क्रेडेंशियल सेव किए हों और फ़ाइल का नाम credentials.json रखा हो. कोड का यह सैंपल, Google Workspace से पुष्टि करने और उपयोगकर्ता के क्रेडेंशियल पाने के लिए, इस JSON फ़ाइल का इस्तेमाल करता है. निर्देशों के लिए, OAuth क्लाइंट आईडी के क्रेडेंशियल बनाना लेख पढ़ें.
सदस्यताओं की सूची बनाने के लिए, अपने टर्मिनल में यह कमांड चलाएं:
[null,null,["आखिरी बार 2025-08-26 (UTC) को अपडेट किया गया."],[[["\u003cp\u003eThis page provides instructions on how to list Google Workspace subscriptions using the \u003ccode\u003esubscriptions.list()\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe method returns a list of authorized subscriptions when using user authentication and may return any app subscription when using app authentication.\u003c/p\u003e\n"],["\u003cp\u003eCode samples are provided for both Apps Script and Python to demonstrate listing subscriptions based on event type and target resource.\u003c/p\u003e\n"],["\u003cp\u003ePrerequisites include having a Google Workspace subscription, proper authentication and setup for the chosen scripting language.\u003c/p\u003e\n"],["\u003cp\u003eThe response is a paginated array of \u003ccode\u003eSubscription\u003c/code\u003e objects matching the query filter.\u003c/p\u003e\n"]]],["The `subscriptions.list()` method retrieves Google Workspace subscriptions, returning user-authorized subscriptions with user authentication or any app subscriptions with app authentication. Listing subscriptions requires filtering by event type and optionally by target resource. Apps Script and Python examples detail this process: defining event type and target resource filters, setting OAuth scopes, and running the code to retrieve and print a filtered array of `Subscription` objects using the Workspace Events API. User or app authentication is required.\n"],null,["# List Google Workspace subscriptions\n\nThis page explains how to list Google Workspace subscriptions using the\n[`subscriptions.list()`](/workspace/events/reference/rest/v1/subscriptions/list)\nmethod.\n\nWhen you call this method with user authentication, the method returns\na list of subscriptions authorized by the user. When you use app authentication,\nthe method can return a list that contains any subscription for the app.\n\nPrerequisites\n-------------\n\n### Apps Script\n\n- \u003cbr /\u003e\n\n A Google Workspace subscription. To create one, see [Create a subscription](/workspace/events/guides/create-subscription).\n\n \u003cbr /\u003e\n\n- Requires user authentication with one or more\n [scopes that support all event types for\n the subscription](/workspace/events/guides/auth#scopes-event-type).\n\n | **Note:** To run the code sample in this guide, you must use the same [OAuth client\n | ID credentials](/workspace/events/guides/create-subscription#create-oauth) that you used to create the subscription.\n\n\u003c!-- --\u003e\n\n- An Apps Script project:\n - Use your Google Cloud project instead of the default one created automatically by Apps Script.\n - For all scopes that you added to configure the OAuth consent screen, you must also add the scopes to the `appsscript.json` file in your Apps Script project. For example, if you specified the `chat.messages` scope, then add the following: \n\n ```console\n \"oauthScopes\": [\n \"https://www.googleapis.com/auth/chat.messages\"\n ]\n \n ```\n - [Enable](/apps-script/guides/services/advanced#enable_advanced_services) the `Google Workspace Events` advanced service.\n\n### Python\n\n- Python 3.6 or greater\n- The [pip](https://pypi.org/project/pip/) package management tool\n- The latest Google client libraries for Python. To install or update them, run the following command in your command-line interface: \n\n ```console\n pip3 install --upgrade google-api-python-client google-auth-oauthlib\n \n ```\n\n\u003c!-- --\u003e\n\n- \u003cbr /\u003e\n\n A Google Workspace subscription. To create one, see [Create a subscription](/workspace/events/guides/create-subscription).\n\n \u003cbr /\u003e\n\n- Requires [authentication](/workspace/events/guides/auth):\n\n - For user authentication, requires a scope that supports at least one of the event types for the subscription. To identify a scope, see [Scopes by event type](/workspace/events/guides/auth#scopes-event-type). **Note:** To run the code sample in this guide, you must use the same [OAuth\n | client ID credentials](/workspace/events/guides/create-subscription#create-oauth) that you used to create the subscription.\n - For app authentication, requires the `chat.bot` scope (Google Chat apps only).\n\nList subscriptions authorized by a user\n---------------------------------------\n\nTo list subscriptions, you must filter by at least one event type. You can also\nfilter your query by one or more target resources. To learn about supported\nquery filters, see the [`list()` method\ndocumentation](/workspace/events/reference/rest/v1/subscriptions/list).\n\nThe following code sample returns an array of\n[`Subscription`](/workspace/events/reference/rest/v1/subscriptions) objects\nfiltered by event type and target resource. When authenticated as a user, the\nmethod only returns a list of subscriptions that the user authorized the app to\ncreate.\n\nTo list subscriptions for a specified event type and target resource: \n\n### Apps Script\n\n1. In your Apps Script project, create a new script file\n named `listSubscriptions` and add the following code:\n\n function listSubscriptions() {\n // Filter for event type (required).\n const eventType = &\u003cvar translate=\"no\"\u003e#39;EVENT_\u003c/var\u003eTYPE';\n\n // Filter for target resource (optional).\n const targetReso\u003cvar translate=\"no\"\u003eurce\u003c/var\u003e = 'TARGET_RESOURCE';\n\n const filter = `event_types:\"${eventType}\" AND target_resource=\"${targetResource}\"`\n\n // Call the Workspace Events API using the advanced service.\n const response = WorkspaceEvents.Subscriptions.list({ filter });\n console.log(response);\n }\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eEVENT_TYPE\u003c/var\u003e: An [event type](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.event_types) formatted according to the CloudEvents specification. For example, to filter for subscriptions that receive events about new memberships to a Google Chat space, `google.workspace.chat.message.v1.created`.\n - \u003cvar translate=\"no\"\u003eTARGET_RESOURCE\u003c/var\u003e: A [target resource](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.target_resource), formatted as its full resource name. For example, to filter by subscriptions for a Google Chat space, use `//chat.googleapis.com/spaces/`\u003cvar translate=\"no\"\u003eSPACE_ID\u003c/var\u003e where `spaces/`\u003cvar translate=\"no\"\u003eSPACE_ID\u003c/var\u003e represents the [`name`](/workspace/chat/api/reference/rest/v1/spaces#Space.FIELDS.name) field for the `Space` resource.\n2. To list subscriptions, run the function `listSubscriptions` in\n your Apps Script project.\n\n### Python\n\n1. In your working directory, create a file named `list_subscriptions.py`\n and add the following code:\n\n \"\"\"List subscriptions.\"\"\"\n\n from google_auth_oauthlib.flow import InstalledAppFlow\n from googleapiclient.discovery import build\n\n # Specif\u003cvar translate=\"no\"\u003ey req\u003c/var\u003euired scopes.\n SCOPES = ['SCOPE']\n\n # Authenticate with Google Workspace and get user authentication.\n flow = InstalledAppFlow.from_client_secrets_file('credentials.json', SCOPES)\n CREDENTIALS = flow.run_local_server()\n\n # Call the Workspace Events API using the service endpoint.\n service = build(\n 'workspaceevents',\n 'v1',\n credentials=CRED\u003cvar translate=\"no\"\u003eENTIALS\u003c/var\u003e,\n )\n\n # Filter for event type (required).\n EVENT_TYPE = 'EVENT_T\u003cvar translate=\"no\"\u003eYPE'\u003c/var\u003e\n\n # Filter for target resource (optional).\n TARGET_RESOURCE = 'TARGET_RESOURCE'\n\n FILTER = f'event_types:\"{EVENT_TYPE}\" AND target_resource=\"{TARGET_RESOURCE}\"'\n response = service.subscriptions().list(filter=FILTER).execute()\n print(response)\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eSCOPE\u003c/var\u003e: An OAuth scope that [supports at least\n one event type from the subscription](/workspace/events/guides/auth#scopes-event-type). For example, if your subscription receives events an updated Chat space, `https://www.googleapis.com/auth/chat.spaces.readonly`.\n - \u003cvar translate=\"no\"\u003eEVENT_TYPE\u003c/var\u003e: An [event type](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.event_types) formatted according to the CloudEvents specification. For example, to filter for subscriptions that receive events about new memberships to a Google Chat space, `google.workspace.chat.message.v1.created`.\n - \u003cvar translate=\"no\"\u003eTARGET_RESOURCE\u003c/var\u003e: A [target resource](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.target_resource), formatted as its full resource name. For example, to filter by subscriptions for a Google Chat space, use `//chat.googleapis.com/spaces/`\u003cvar translate=\"no\"\u003eSPACE_ID\u003c/var\u003e where `spaces/`\u003cvar translate=\"no\"\u003eSPACE_ID\u003c/var\u003e represents the [`name`](/workspace/chat/api/reference/rest/v1/spaces#Space.FIELDS.name) field for the `Space` resource.\n2. In your working directory, make sure you've stored your OAuth client ID\n credentials and named the file `credentials.json`. The code sample uses this JSON\n file to authenticate with Google Workspace and get user credentials. For instructions,\n see [Create OAuth client ID\n credentials](/workspace/events/guides/create-subscription#create-oauth).\n\n3. To list subscriptions, run the following in your terminal:\n\n python3 list_subscriptions.py\n\nThe Google Workspace Events API returns a [paginated array of `Subscription`\nobjects](/workspace/events/reference/rest/v1/subscriptions/list#response-body)\nthat match the filter for your query.\n\nRelated topics\n--------------\n\n- [Update or renew a subscription](/workspace/events/guides/update-subscription)\n- [Resolve errors and reactivate a subscription](/workspace/events/guides/reactivate-subscription)\n- [Delete a subscription](/workspace/events/guides/delete-subscription)\n- [Get a subscription](/workspace/events/guides/get-subscription)\n- [Create a subscription](/workspace/events/guides/create-subscription)"]]
