इस गाइड में, list
को इस्तेमाल करने का तरीका बताया गया है
SpaceEvent
संसाधन पर तरीका
का इस्तेमाल करें.
SpaceEvent
का संसाधन
यह स्पेस के चाइल्ड रिसॉर्स के साथ-साथ, टारगेट किए गए स्पेस में हुए बदलाव दिखाता है
जैसे कि मैसेज, प्रतिक्रियाएं, और पैसे चुकाकर ली जाने वाली सदस्यताएं. इस बारे में ज़्यादा जानकारी पाने के लिए
इवेंट टाइप और इवेंट पेलोड की सूची देखने के लिए, eventType
और
SpaceEvent
संसाधन के payload
फ़ील्ड
देखें.
अनुरोध किए जाने के समय से 28 दिन पहले तक के इवेंट की सूची बनाई जा सकती है. सर्वर
ऐसे इवेंट दिखाता है जिनमें ऐसे संसाधन का सबसे नया वर्शन शामिल होता है जिस पर असर पड़ा है.
उदाहरण के लिए, अगर स्पेस के नए सदस्यों के इवेंट शामिल किए जाते हैं, तो सर्वर
Membership
संसाधन, जिनमें सदस्यता की नई जानकारी शामिल है. अगर नया है
अनुरोध की गई अवधि के दौरान सदस्यों को हटाया गया. इवेंट के पेलोड में
खाली Membership
संसाधन.
इस तरीके को कॉल करने के लिए, आपको user पुष्टि करने की सुविधा. सूची बनाने के लिए किसी स्पेस के इवेंट होने पर, पुष्टि किया गया उपयोगकर्ता स्पेस का सदस्य होना चाहिए.
ज़रूरी शर्तें
Python
- कारोबार या एंटरप्राइज़ Google Workspace खाता, जिसके पास इसका ऐक्सेस है Google Chat.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- उस स्क्रीन को कॉन्फ़िगर करें जहां OAuth के लिए सहमति दी जाती है.
- Google Chat API को चालू और कॉन्फ़िगर करें. आइकॉन और ब्यौरा जोड़ें.
-
डेस्कटॉप ऐप्लिकेशन के लिए OAuth क्लाइंट आईडी क्रेडेंशियल बनाएं. सैंपल को चलाने के लिए
गाइड के साथ क्रेडेंशियल को
client_secrets.json
नाम वाली JSON फ़ाइल के तौर पर लोकल डायरेक्ट्री.
- अनुमति देने का ऐसा स्कोप चुनें जो उपयोगकर्ता की पुष्टि करने की सुविधा देता हो.
स्पेस इवेंट की सूची बनाना
किसी चैट स्पेस में शामिल स्पेस के इवेंट की सूची बनाने के लिए, यह तरीका अपनाएं:
list
तरीके को कॉल करेंSpaceEvent
पर संसाधन.- इसका इस्तेमाल करके यह तय करें कि किस तरह के इवेंट को सूची में शामिल करना है
filter
फ़ील्ड में डालें. आपको कम से कम एक इवेंट टाइप तय करना होगा. साथ ही, इवेंट को इस हिसाब से भी फ़िल्टर किया जा सकता है तारीख. इस्तेमाल किए जा सकने वाले इवेंट टाइप की सूची के लिए,eventType
पर जाएं फ़ील्ड. - user के साथ पुष्टि करें, तो आपके अनुरोध में मौजूद हर इवेंट टाइप के हिसाब से, अनुमति के एक या उससे ज़्यादा स्कोप जोड़े जा सकते हैं. सबसे सही तरीका यह होगा कि आप ऐसा सबसे ज़्यादा पाबंदी वाला दायरा चुनें जो अब भी आपके ऐप्लिकेशन को काम करने की अनुमति देता है. स्कोप चुनने के लिए यहां देखें पुष्टि करने और अनुमति देने से जुड़ी खास जानकारी.
नीचे दिए गए कोड सैंपल में, आपने नई सदस्यताओं और किसी स्पेस में मौजूद मैसेज
Python
- अपनी वर्किंग डायरेक्ट्री में,
chat_space_event_list.py
नाम की फ़ाइल बनाएं. chat_space_event_list.py
में यह कोड शामिल करें:"""Lists SpaceEvent resources from the Chat API.""" from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly", "https://www.googleapis.com/auth/chat.messages.readonly"] # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build( 'chat', 'v1', credentials=creds, ) # Use the service endpoint to call Chat API. result = chat.spaces().spaceEvents().list( # The space from which to list events. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. parent='spaces/SPACE', # A required filter. Filters and returns events about new memberships and messages filter='event_types:"google.workspace.chat.membership.v1.created" OR event_types:"google.workspace.chat.message.v1.created"' ).execute() # Prints details about the created space events. print(result)
कोड में, इन्हें बदलें:
SPACE
: स्पेस का नाम, जिसे यहां से ऐक्सेस किया जा सकता हैspaces.list
तरीका या स्पेस के यूआरएल से मिलेगी.
अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और चलाएं:
python3 chat_space_event_list.py
Chat API,
SpaceEvent
संसाधन
नई सदस्यताओं और मैसेज के बारे में इवेंट.
खोज नतीजों को पेजों में बांटना
इसके अलावा, पेजों को अपने हिसाब से बनाने के लिए, ये क्वेरी पैरामीटर पास करें:
pageSize
: दिए जाने वालेSpaceEvent
संसाधनों की ज़्यादा से ज़्यादा संख्या. यह सेवा इस वैल्यू से कम वैल्यू दिखा सकती है. ऋणात्मक मानINVALID_ARGUMENT
गड़बड़ी.pageToken
: पेज टोकन, जो पिछले लिस्ट स्पेस इवेंट कॉल से मिला है. अगले पेज को वापस पाने के लिए, यह टोकन उपलब्ध कराएं. पेज पर नंबर डालते समय, फ़िल्टर वैल्यू उस कॉल से मैच होनी चाहिए जिससे पेज टोकन मिला है. पासिंग अलग-अलग वैल्यू देने से अनचाहे नतीजे मिल सकते हैं.