Google Chat स्पेस के इवेंट की सूची बनाना

इस गाइड में, Google Chat API के SpaceEvent संसाधन पर list के तरीके का इस्तेमाल करने का तरीका बताया गया है. इससे, स्पेस में संसाधनों में हुए बदलावों की सूची बनाई जा सकती है.

SpaceEvent रिसॉर्स, टारगेट किए गए स्पेस में हुए बदलाव के बारे में बताता है. इसमें स्पेस के चाइल्ड रिसॉर्स भी शामिल हैं, जैसे कि मैसेज, प्रतिक्रियाएं, और सदस्यताएं. इवेंट टाइप और इवेंट पेलोड की सूची के बारे में ज़्यादा जानकारी के लिए, SpaceEvent संसाधन के रेफ़रंस दस्तावेज़ के eventType और payload फ़ील्ड देखें.

अनुरोध करने से 28 दिन पहले तक इवेंट की सूची बनाई जा सकती है. सर्वर ऐसे इवेंट दिखाता है जिनमें उस संसाधन का सबसे नया वर्शन होता है जिस पर असर पड़ा है. उदाहरण के लिए, अगर स्पेस के नए सदस्यों के इवेंट शामिल किए जाते हैं, तो सर्वर Membership संसाधन, जिनमें सदस्यता की नई जानकारी शामिल है. अगर अनुरोध की गई अवधि के दौरान नए सदस्य हटा दिए गए थे, तो इवेंट पेलोड में एक खाली Membership रिसॉर्स शामिल होता है.

इस तरीके को कॉल करने के लिए, आपको उपयोगकर्ता की पुष्टि करने की सुविधा का इस्तेमाल करना होगा. किसी स्पेस के इवेंट की सूची देखने के लिए, यह ज़रूरी है कि पुष्टि किए गए उपयोगकर्ता के पास स्पेस का ऐक्सेस हो.

ज़रूरी शर्तें

Python

  • आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.

स्पेस में होने वाले इवेंट की सूची

Chat स्पेस में मौजूद इवेंट की सूची देखने के लिए, यह तरीका अपनाएं:

  • SpaceEvent संसाधन पर list तरीका का इस्तेमाल करें.
  • इसका इस्तेमाल करके यह तय करें कि किस तरह के इवेंट को सूची में शामिल करना है filter फ़ील्ड. आपको कम से कम एक इवेंट टाइप की जानकारी देनी होगी. साथ ही, इवेंट को तारीख के हिसाब से भी फ़िल्टर किया जा सकता है. इस्तेमाल किए जा सकने वाले इवेंट टाइप की सूची देखने के लिए, eventType फ़ील्ड देखें.
  • उपयोगकर्ता की पुष्टि के साथ, अपने अनुरोध में हर तरह के इवेंट के साथ काम करने के लिए, अनुमति के एक या उससे ज़्यादा दायरे तय करें. सबसे सही तरीका यह है कि आप सबसे ज़्यादा पाबंदी वाला स्कोप चुनें, ताकि आपके ऐप्लिकेशन को काम करने की अनुमति मिलती रहे. स्कोप चुनने के लिए यहां देखें पुष्टि करने और अनुमति देने से जुड़ी खास जानकारी.

यहां दिए गए कोड सैंपल में, स्पेस में नई सदस्यताओं और मैसेज से जुड़े इवेंट की सूची दी गई है.

Python

  1. अपनी वर्किंग डायरेक्ट्री में, chat_space_event_list.py नाम की फ़ाइल बनाएं.

  2. 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)

  3. कोड में, इनकी जगह ये डालें:

    • SPACE: स्पेस का नाम, जो आपको Chat API में spaces.list तरीके या स्पेस के यूआरएल से मिल सकता है.

  4. अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और चलाएं:

    python3 chat_space_event_list.py

Chat API, SpaceEvent संसाधन नई सदस्यताओं और मैसेज के बारे में इवेंट.

पेज पर नंबर डालने की सुविधा को पसंद के मुताबिक बनाना

पेजेशन को पसंद के मुताबिक बनाने के लिए, यहां दिए गए क्वेरी पैरामीटर का इस्तेमाल करें. हालांकि, ऐसा करना ज़रूरी नहीं है:

  • pageSize: SpaceEvent संसाधनों की ज़्यादा से ज़्यादा संख्या, जिन्हें लौटाना है. ऐसा हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए. ऋणात्मक मान INVALID_ARGUMENT गड़बड़ी.
  • pageToken: सूची वाले स्पेस के इवेंट के पिछले कॉल से मिला पेज टोकन. अगला पेज देखने के लिए, यह टोकन दें. पेज पर नंबर डालते समय, फ़िल्टर वैल्यू उस कॉल से मैच होनी चाहिए जिससे पेज टोकन मिला है. पासिंग अलग-अलग वैल्यू देने से अनचाहे नतीजे मिल सकते हैं.