Получите подробную информацию о подписке на Google Workspace
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
На этой странице объясняется, как получить подробную информацию о подписке Google Workspace с помощью метода subscriptions.get() .
При вызове этого метода с аутентификацией пользователя метод возвращает информацию о подписке, авторизованной пользователем. При использовании аутентификации приложения метод может возвращать информацию о любой подписке для приложения.
Предпосылки
Питон
- Python 3.6 или выше
- Инструмент управления пакетами pip
- Последние клиентские библиотеки Google для Python. Чтобы установить или обновить их, выполните следующую команду в командной строке:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
Оформить подписку, авторизованную пользователем
Следующий пример кода получает информацию о ресурсе Subscription , используя аутентификацию пользователя. При аутентификации пользователя метод возвращает подписку, которую пользователь разрешил приложению создать.
Чтобы получить подписку, авторизованную пользователем:
Скрипт приложений
В проекте Apps Script создайте новый файл скрипта с именем getSubscription и добавьте следующий код:
function getSubscription() {
// The name of the subscription to get.
const name = 'subscriptions/SUBSCRIPTION_ID';
// Call the Workspace Events API using the advanced service.
const subscription = WorkspaceEvents.Subscriptions.get(name);
console.log(subscription);
}
Заменить следующее:
-
SUBSCRIPTION_ID : Идентификатор подписки. Чтобы получить идентификатор, воспользуйтесь любым из следующих способов:- Значение поля
uid . - Идентификатор имени ресурса, представленный в поле
name . Например, если имя ресурса — subscriptions/subscription-123 , используйте subscription-123 .
Чтобы получить подписку, запустите функцию getSubscription в своем проекте Apps Script.
Питон
В рабочем каталоге создайте файл с именем get_subscription.py и добавьте следующий код:
"""Get subscription."""
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
# 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,
)
NAME = 'subscriptions/SUBSCRIPTION_ID'
subscription = service.subscriptions().get(name=NAME).execute()
print(subscription)
Заменить следующее:
-
SCOPE : область действия OAuth, поддерживающая как минимум один тип событий из подписки . Например, если ваша подписка получает события в обновлённом чат-пространстве, https://www.googleapis.com/auth/chat.spaces.readonly . -
SUBSCRIPTION_ID : Идентификатор подписки. Чтобы получить идентификатор, воспользуйтесь любым из следующих способов:- Значение поля
uid . - Идентификатор имени ресурса, представленный в поле
name . Например, если имя ресурса — subscriptions/subscription-123 , используйте subscription-123 .
Убедитесь, что вы сохранили учётные данные OAuth-клиента в рабочем каталоге и назвали файл credentials.json . В примере кода этот JSON-файл используется для аутентификации в Google Workspace и получения учётных данных пользователя. Инструкции см. в разделе Создание учётных данных OAuth-клиента .
Чтобы оформить подписку, выполните в терминале следующее:
python3 get_subscription.py
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-08-13 UTC.
[null,null,["Последнее обновление: 2025-08-13 UTC."],[[["\u003cp\u003eThis page provides instructions for retrieving details about a Google Workspace subscription using the \u003ccode\u003esubscriptions.get()\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eYou can get details about user-authorized subscriptions using user authentication or any subscription for the app using app authentication.\u003c/p\u003e\n"],["\u003cp\u003eCode samples are provided in Apps Script and Python demonstrating how to retrieve subscription details.\u003c/p\u003e\n"],["\u003cp\u003ePrerequisites include a Google Workspace subscription, proper authentication, and specific environment setups for Apps Script and Python.\u003c/p\u003e\n"],["\u003cp\u003eRelated topics cover subscription management tasks like updating, resolving errors, deleting, listing, and creating subscriptions.\u003c/p\u003e\n"]]],[],null,["# Get details about a Google Workspace subscription\n\nThis page explains how to get details about a Google Workspace subscription\nusing the\n[`subscriptions.get()`](/workspace/events/reference/rest/v1/subscriptions/get)\nmethod.\n\nWhen you call this method with user authentication, the method returns\ndetails about a subscription authorized by the user. When you use app\nauthentication, the method can return details about any subscription for the\napp.\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\nGet a subscription authorized by a user\n---------------------------------------\n\nThe following code sample gets details about a\n[`Subscription`](/workspace/events/reference/rest/v1/subscriptions)resource\nusing user authentication. When authenticated as a user, the method returns a\nsubscription that the user authorized the app to create.\n\nTo get a subscription authorized by a user: \n\n### Apps Script\n\n1. In your Apps Script project, create a new script file\n named `getSubscription` and add the following code:\n\n function getSubscription() {\n // The name of the subscription to get.\n const name = 'subscriptions/\u003cvar translate=\"no\"\u003eSUBSCRIPTION_ID\u003c/var\u003e';\n\n // Call the Workspace Events API using the advanced service.\n const subscription = WorkspaceEvents.Subscriptions.get(name);\n console.log(subscription);\n }\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eSUBSCRIPTION_ID\u003c/var\u003e: The ID of the subscription. To get the ID, you can use any of the following:\n - The value of the [`uid`](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.uid) field.\n - The ID of the resource name represented in the [`name`](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.name) field. For example, if the resource name is `subscriptions/subscription-123`, use `subscription-123`.\n2. To get the subscription, run the function `getSubscription` in\n your Apps Script project.\n\n### Python\n\n1. In your working directory, create a file named `get_subscription.py`\n and add the following code:\n\n \"\"\"Get subscription.\"\"\"\n\n from google_auth_oauthlib.flow import InstalledAppFlow\n from googleapiclient.discovery import build\n\n # Specify required scopes.\n SCOPES = ['\u003cvar translate=\"no\"\u003eSCOPE\u003c/var\u003e']\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=CREDENTIALS,\n )\n\n NAME = 'subscriptions/\u003cvar translate=\"no\"\u003eSUBSCRIPTION_ID\u003c/var\u003e'\n subscription = service.subscriptions().get(name=NAME).execute()\n print(subscription)\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\"\u003eSUBSCRIPTION_ID\u003c/var\u003e: The ID of the subscription. To get the ID, you can use any of the following:\n - The value of the [`uid`](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.uid) field.\n - The ID of the resource name represented in the [`name`](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.name) field. For example, if the resource name is `subscriptions/subscription-123`, use `subscription-123`.\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 get the subscription, run the following in your terminal:\n\n python3 get_subscription.py\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- [List subscriptions](/workspace/events/guides/list-subscriptions)\n- [Create a subscription](/workspace/events/guides/create-subscription)"]]
