Method: spaces.spaceEvents.list

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

अनुरोध किए गए डेटा को पढ़ने के लिए, उपयोगकर्ता की पुष्टि की ज़रूरत होती है. साथ ही, अनुमति के दायरे का सही होना भी ज़रूरी है:

  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

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

उदाहरण के लिए, Google Chat के स्पेस में मौजूद इवेंट की सूची देखना लेख पढ़ें.

एचटीटीपी अनुरोध

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. उस Google Chat स्पेस का रिसॉर्स नेम जहां इवेंट हुए.

फ़ॉर्मैट: spaces/{space}.

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

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

नेगेटिव वैल्यू देने पर, INVALID_ARGUMENT गड़बड़ी दिखती है.
pageToken

string

ज़रूरी नहीं. पेज टोकन, जो सूची वाले स्पेस के इवेंट के पिछले कॉल से मिला है. अगला पेज देखने के लिए, यह डालें.

पेज बनाते समय, स्पेस इवेंट की सूची बनाने के लिए दिए गए सभी अन्य पैरामीटर, उस कॉल से मेल खाने चाहिए जिसने पेज टोकन दिया है. अन्य पैरामीटर को अलग-अलग वैल्यू देने पर, अनचाहे नतीजे मिल सकते हैं.
filter

string

ज़रूरी है. क्वेरी फ़िल्टर.

आपको has : ऑपरेटर का इस्तेमाल करके, कम से कम एक इवेंट टाइप (eventType) बताना होगा. एक से ज़्यादा इवेंट टाइप के हिसाब से फ़िल्टर करने के लिए, OR ऑपरेटर का इस्तेमाल करें. अपने फ़िल्टर में, एक साथ होने वाले इवेंट टाइप को शामिल न करें. अनुरोध करने पर, उससे जुड़े सभी बैच इवेंट अपने-आप दिख जाते हैं. उदाहरण के लिए, अगर नए प्रतिक्रियाओं (google.workspace.chat.reaction.v1.created) के हिसाब से फ़िल्टर किया जाता है, तो सर्वर नए प्रतिक्रियाओं के बैच इवेंट (google.workspace.chat.reaction.v1.batchCreated) भी दिखाता है. काम करने वाले इवेंट टाइप की सूची के लिए, SpaceEvents रेफ़रंस दस्तावेज़ देखें.

इसके अलावा, शुरू होने का समय (startTime) और खत्म होने का समय (endTime) के हिसाब से भी फ़िल्टर किया जा सकता है:

  • startTime: स्पेस के इवेंट की सूची बनाने के लिए, खास टाइमस्टैंप. आपके पास 28 दिन पहले तक हुए इवेंट की सूची बनाने का विकल्प है. अगर कोई तारीख नहीं दी गई है, तो पिछले 28 दिनों के स्पेस इवेंट की सूची दिखेगी.
  • endTime: वह टाइमस्टैंप जब तक स्पेस के इवेंट की सूची दिखती है. अगर कोई समय नहीं दिया गया है, तो अनुरोध करने के समय तक के इवेंट दिखाए जाते हैं.

शुरू या खत्म होने का समय बताने के लिए, बराबर = ऑपरेटर का इस्तेमाल करें और RFC-3339 फ़ॉर्मैट में लिखें. startTime और endTime, दोनों के हिसाब से फ़िल्टर करने के लिए, AND ऑपरेटर का इस्तेमाल करें.

उदाहरण के लिए, ये क्वेरी मान्य हैं:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

ये क्वेरी अमान्य हैं:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

अमान्य क्वेरी को सर्वर, INVALID_ARGUMENT गड़बड़ी के साथ अस्वीकार कर देता है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

स्पेस में होने वाले इवेंट की सूची बनाने के लिए जवाब का मैसेज.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
spaceEvents[]

object (SpaceEvent)

नतीजे, सिलसिलेवार तरीके से दिखाए जाते हैं. इसमें सबसे पुराने इवेंट को पहले दिखाया जाता है. ध्यान दें: सूची के अनुरोधों के लिए, Space ऑब्जेक्ट में permissionSettings फ़ील्ड नहीं दिखाया जाता.
nextPageToken

string

ज़्यादा इवेंट फ़ेच करने के लिए इस्तेमाल किया जाने वाला कंटिन्यूएशन टोकन. अगर इस फ़ील्ड को छोड़ा जाता है, तो इसके बाद कोई पेज नहीं दिखेगा.

अनुमति के दायरे

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.