इस पेज पर, subscriptions.update()
तरीके का इस्तेमाल करके, Google Workspace की सदस्यता रिन्यू करने का तरीका बताया गया है. इस तरीके का इस्तेमाल करके, सदस्यता के खत्म होने का समय अपडेट किया जा सकता है. इसमें, सदस्यता को ज़्यादा से ज़्यादा समय के लिए रिन्यू करना भी शामिल है. इसके अलावा, इसका इस्तेमाल टारगेट रिसॉर्स के बारे में सूचना पाने के लिए, इवेंट टाइप की सूची को अपडेट करने के लिए भी किया जा सकता है.
Apps Script
- Google Workspace की सदस्यता. इसे बनाने के लिए, सदस्यता बनाना लेख पढ़ें.
- Apps Script प्रोजेक्ट:
- Apps Script से अपने-आप बनाए गए डिफ़ॉल्ट प्रोजेक्ट के बजाय, अपने Google Cloud प्रोजेक्ट का इस्तेमाल करें.
- आपने OAuth सहमति स्क्रीन को कॉन्फ़िगर करने के लिए जो भी स्कोप जोड़े हैं उन्हें आपको अपने Apps Script प्रोजेक्ट की
appsscript.json
फ़ाइल में भी जोड़ना होगा. उदाहरण के लिए, अगर आपनेchat.messages
स्कोप तय किया है, तो यह जानकारी जोड़ें: Google Workspace Events
बेहतर सेवा को चालू करें.
"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages" ]
इसके लिए, पुष्टि करना और सदस्यता में हर इवेंट टाइप के लिए अनुमति का सही दायरा तय करना ज़रूरी है:
- उपयोगकर्ता की पुष्टि करने के लिए, एक या उससे ज़्यादा ऐसे स्कोप की ज़रूरत होती है जो सदस्यता के लिए कम से कम एक इवेंट टाइप के साथ काम करते हों. स्कोप की पहचान करने के लिए, इवेंट टाइप के हिसाब से स्कोप देखें.
- Chat ऐप्लिकेशन के तौर पर किसी Chat इवेंट की सदस्यता लेने के लिए, ऐप्लिकेशन की पुष्टि करना और एडमिन से एक बार अनुमति लेना ज़रूरी है. Chat ऐप्लिकेशन के तौर पर, Chat इवेंट की सदस्यता लेने की सुविधा डेवलपर के लिए झलक में उपलब्ध है.
Python
- Python 3.6 या इसके बाद का वर्शन
- pip पैकेज मैनेजमेंट टूल
- Python के लिए Google की नई क्लाइंट लाइब्रेरी. इन्हें इंस्टॉल या अपडेट करने के लिए, कमांड-लाइन इंटरफ़ेस में यह कमांड चलाएं:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Google Workspace की सदस्यता. इसे बनाने के लिए, सदस्यता बनाना लेख पढ़ें.
इसके लिए, पुष्टि करना और सदस्यता में हर इवेंट टाइप के लिए अनुमति का सही दायरा तय करना ज़रूरी है:
- उपयोगकर्ता की पुष्टि करने के लिए, एक या उससे ज़्यादा ऐसे स्कोप की ज़रूरत होती है जो सदस्यता के लिए कम से कम एक इवेंट टाइप के साथ काम करते हों. स्कोप की पहचान करने के लिए, इवेंट टाइप के हिसाब से स्कोप देखें.
- Chat ऐप्लिकेशन के तौर पर किसी Chat इवेंट की सदस्यता लेने के लिए, ऐप्लिकेशन की पुष्टि करना और एडमिन से एक बार अनुमति लेना ज़रूरी है. Chat ऐप्लिकेशन के तौर पर, Chat इवेंट की सदस्यता लेने की सुविधा डेवलपर के लिए झलक में उपलब्ध है.
Google Workspace की सदस्यता रिन्यू करना
इस सेक्शन में, Google Workspace Events API के subscriptions.update()
तरीके का इस्तेमाल करके, सदस्यता को उसकी ज़्यादा से ज़्यादा समयसीमा के लिए रिन्यू किया जाता है. ऐक्सेस के खत्म होने की ज़्यादा से ज़्यादा समयसीमा तय करने के लिए, Subscription
रिसॉर्स के ttl
फ़ील्ड को 0
पर अपडेट करें.
एक्सपायर होने का ज़्यादा से ज़्यादा समय, इस बात पर निर्भर करता है कि इवेंट के पेलोड में कौनसा संसाधन डेटा शामिल है. एक्सपायर होने के समय के बारे में ज़्यादा जानने के लिए, Google Workspace इवेंट के लिए इवेंट डेटा लेख पढ़ें.
Google Workspace की सदस्यता रिन्यू करने के लिए:
Apps Script
अपने Apps Script प्रोजेक्ट में,
updateSubscription
नाम की एक नई स्क्रिप्ट फ़ाइल बनाएं और उसमें यह कोड जोड़ें:function updateSubscription() { // The name of the subscription to update. const name = 'subscriptions/SUBSCRIPTION_ID'; // Call the Workspace Events API using the advanced service. const response = WorkspaceEvents.Subscriptions.patch({ ttl: '0s', }, name); console.log(response); }
इनकी जगह ये डालें:
Google Workspace की सदस्यता को अपडेट करने के लिए, अपने Apps Script प्रोजेक्ट में
updateSubscription
फ़ंक्शन चलाएं.
Python
अपनी वर्किंग डायरेक्ट्री में,
update_subscription.py
नाम की एक फ़ाइल बनाएं और उसमें यह कोड जोड़ें:"""Update subscription.""" from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Specify required scopes. SCOPES = [SCOPES] # 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, ) BODY = { 'ttl': {'seconds': 0}, } NAME = 'subscriptions/SUBSCRIPTION_ID' response = ( service.subscriptions() .patch(name=NAME, updateMask='ttl', body=BODY) .execute() ) print(response)
इनकी जगह ये डालें:
SCOPES
: एक या उससे ज़्यादा OAuth के दायरे, जो सदस्यता के लिए हर इवेंट टाइप के साथ काम करते हैं. इसे स्ट्रिंग के ऐरे के तौर पर फ़ॉर्मैट किया जाता है. एक से ज़्यादा स्कोप की सूची बनाने के लिए, उन्हें कॉमा लगाकर अलग करें. उदाहरण के लिए,'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
.SUBSCRIPTION_ID
: सदस्यता का आईडी. आईडी पाने के लिए, इनमें से किसी भी तरीके का इस्तेमाल किया जा सकता है:
अपनी वर्किंग डायरेक्ट्री में, पक्का करें कि आपने OAuth क्लाइंट आईडी क्रेडेंशियल सेव किए हों और फ़ाइल का नाम
credentials.json
रखा हो. कोड का यह सैंपल, Google Workspace से पुष्टि करने और उपयोगकर्ता के क्रेडेंशियल पाने के लिए, इस JSON फ़ाइल का इस्तेमाल करता है. निर्देशों के लिए, OAuth क्लाइंट आईडी के क्रेडेंशियल बनाना लेख पढ़ें.Google Workspace की सदस्यता अपडेट करने के लिए, अपने टर्मिनल में यह कमांड चलाएं:
python3 update_subscription.py
Subscription
संसाधन का इंस्टेंस होता है.
अपडेट किए गए Subscription
संसाधन के बारे में जानकारी पाने के लिए, operations.get()
तरीके का इस्तेमाल करें. साथ ही, subscriptions.update()
अनुरोध से मिले Operation
संसाधन के बारे में बताएं. इसके अलावा, अगर सदस्यता के पिछले वर्शन से Operation
रिसॉर्स तय किया जाता है, तो जवाब खाली होता है.
Google Chat ऐप्लिकेशन के तौर पर सदस्यता अपडेट करना या रिन्यू करना
इस प्रोग्राम में शामिल होने पर, आपको कुछ सुविधाओं को रिलीज़ होने से पहले ही इस्तेमाल करने का ऐक्सेस मिलता है.उपयोगकर्ता के तौर पर नहीं, बल्कि Chat ऐप्लिकेशन के तौर पर Chat इवेंट की सदस्यता अपडेट या रिन्यू की जा सकती है. यह प्रोसेस एक जैसी है. हालांकि:
उपयोगकर्ता की पुष्टि करने के बजाय, Chat ऐप्लिकेशन के तौर पर पुष्टि करें. इसके लिए, एडमिन से एक बार मंज़ूरी लेनी होगी.
अनुमति के ऐसे स्कोप तय करें जिनसे Chat ऐप्लिकेशन को Chat इवेंट की सदस्यता लेने की अनुमति मिलती हो. अनुमति पाने के ये लिंक हमेशा
chat.app
से शुरू होते हैं. इनमें ये शामिल हैं:https://www.googleapis.com/auth/chat.app.memberships
: Chat स्पेस के सदस्यों के इवेंट की सदस्यता लें.https://www.googleapis.com/auth/chat.app.messages.readonly
: Chat स्पेस में मैसेज से जुड़ी घटनाओं की सूचना पाने के लिए सदस्यता लें.https://www.googleapis.com/auth/chat.app.spaces
: Chat स्पेस के इवेंट की सदस्यता लें.
एपीआई पासकोड बनाना
डेवलपर प्रीव्यू एपीआई के तरीके को कॉल करने के लिए, आपको एपीआई डिस्कवरी दस्तावेज़ के डेवलपर प्रीव्यू वर्शन का इस्तेमाल करना होगा. यह वर्शन सार्वजनिक नहीं होता. अनुरोध की पुष्टि करने के लिए, आपको एपीआई पासकोड डालना होगा.
एपीआई पासकोड बनाने के लिए, अपने ऐप्लिकेशन का Google Cloud प्रोजेक्ट खोलें और यह तरीका अपनाएं:
- Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.
- क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करें.
- आपको नई एपीआई कुंजी दिखेगी.
- अपने ऐप्लिकेशन के कोड में इस्तेमाल करने के लिए, एपीआई पासकोड कॉपी करने के लिए, कॉपी करें पर क्लिक करें. एपीआई कुंजी, आपके प्रोजेक्ट के क्रेडेंशियल के "एपीआई कुंजियां" सेक्शन में भी देखी जा सकती है.
- हमारा सुझाव है कि बिना अनुमति के इस्तेमाल को रोकने के लिए, यह तय करें कि एपीआई कुंजी का इस्तेमाल कहां और किन एपीआई के लिए किया जा सकता है. ज़्यादा जानकारी के लिए, एपीआई पर पाबंदियां जोड़ना लेख पढ़ें.
Google Workspace Events API को कॉल करने वाली स्क्रिप्ट लिखना
नीचे दिया गया कोड सैंपल, Chat ऐप्लिकेशन की Google Workspace सदस्यता को अपडेट करता है:
Python
"""Update subscription."""
from google.oauth2 import service_account
from apiclient.discovery import build
# Specify required scopes.
SCOPES = [SCOPES]
# Specify service account details.
CREDENTIALS = (
service_account.Credentials.from_service_account_file('credentials.json')
.with_scopes(SCOPES)
)
# Call the Workspace Events API using the service endpoint.
service = build(
'workspaceevents',
'v1beta',
credentials=CREDENTIALS,
discoveryServiceUrl='https://workspaceevents.googleapis.com/$discovery/rest?version=v1beta&labels=DEVELOPER_PREVIEW&key=API_KEY',
)
BODY = {
'ttl': {'seconds': 0},
}
NAME = 'subscriptions/SUBSCRIPTION_ID'
response = (
service.subscriptions()
.patch(name=NAME, updateMask='ttl', body=BODY)
.execute()
)
print(response)
इनकी जगह ये डालें:
SCOPES
: अनुमति पाने के ऐसे लिंक तय करें जिनसे Chat ऐप्लिकेशन को Chat इवेंट की सदस्यता लेने की अनुमति मिलती है. अनुमति पाने के ये लिंक हमेशाchat.app
से शुरू होते हैं. इनमें ये शामिल हैं:https://www.googleapis.com/auth/chat.app.memberships
: Chat स्पेस के सदस्यों के इवेंट की सदस्यता लें.https://www.googleapis.com/auth/chat.app.messages.readonly
: चैट स्पेस में मैसेज और रिएक्शन से जुड़े इवेंट की सूचना पाने के लिए सदस्यता लें.https://www.googleapis.com/auth/chat.app.spaces
: Chat स्पेस के इवेंट की सदस्यता लें.
API_KEY
: यह वह एपीआई पासकोड है जिसे आपने Google Workspace Events API के लिए सेवा का एंडपॉइंट बनाने के लिए बनाया था.SUBSCRIPTION_ID
: सदस्यता का आईडी. आईडी पाने के लिए, इनमें से किसी भी तरीके का इस्तेमाल किया जा सकता है: