Google Workspace 구독에 관한 세부정보 보기
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
이 페이지에서는 subscriptions.get() 메서드를 사용하여 Google Workspace 구독에 대한 세부정보를 가져오는 방법을 설명합니다.
사용자 인증과 함께 이 메서드를 호출하면 메서드는 사용자가 승인한 정기 결제에 관한 세부정보를 반환합니다. 앱 인증을 사용하면 이 메서드가 앱의 모든 정기 결제에 관한 세부정보를 반환할 수 있습니다.
기본 요건
Python
- Python 3.6 이상
- pip 패키지 관리 도구
- 최신 Python용 Google 클라이언트 라이브러리 이를 설치하거나 업데이트하려면 명령줄 인터페이스에서 다음 명령어를 실행하세요.
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Google Workspace 구독 정기 결제를 만들려면 정기 결제 만들기를 참고하세요.
인증 필요:
- 사용자 인증의 경우 구독의 이벤트 유형을 하나 이상 지원하는 범위가 필요합니다. 범위를 확인하려면 이벤트 유형별 범위를 참고하세요.
- 앱 인증의 경우
chat.bot 범위가 필요합니다 (Google Chat 앱만 해당).
사용자가 승인한 정기 결제 가져오기
다음 코드 샘플은 사용자 인증을 사용하여 Subscription 리소스에 관한 세부정보를 가져옵니다. 사용자로 인증되면 이 메서드는 사용자가 앱에 만들 권한을 부여한 정기 결제를 반환합니다.
사용자가 승인한 정기 결제를 가져오려면 다음 단계를 따르세요.
Apps Script
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: 정기 결제의 ID입니다. ID를 가져오려면 다음 중 하나를 사용하세요.
-
uid 필드의 값입니다.
-
name 필드에 표시된 리소스 이름의 ID입니다. 예를 들어 리소스 이름이 subscriptions/subscription-123이면 subscription-123을 사용합니다.
구독을 가져오려면 Apps Script 프로젝트에서 getSubscription 함수를 실행합니다.
Python
작업 디렉터리에서 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 범위입니다. 예를 들어 구독에서 업데이트된 Chat 스페이스(https://www.googleapis.com/auth/chat.spaces.readonly)의 이벤트를 수신하는 경우SUBSCRIPTION_ID: 정기 결제의 ID입니다. ID를 가져오려면 다음 중 하나를 사용하세요.
-
uid 필드의 값입니다.
-
name 필드에 표시된 리소스 이름의 ID입니다. 예를 들어 리소스 이름이 subscriptions/subscription-123이면 subscription-123을 사용합니다.
작업 디렉터리에 OAuth 클라이언트 ID 사용자 인증 정보를 저장하고 파일 이름을 credentials.json로 지정했는지 확인합니다. 코드 샘플은 이 JSON 파일을 사용하여 Google Workspace에서 인증하고 사용자 인증 정보를 가져옵니다. 자세한 내용은 OAuth 클라이언트 ID 사용자 인증 정보 만들기를 참고하세요.
구독을 가져오려면 터미널에서 다음을 실행합니다.
python3 get_subscription.py
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2025-08-21(UTC)
[null,null,["최종 업데이트: 2025-08-21(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)"]]
