Method: spaces.spaceEvents.list

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

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

उदाहरण के लिए, 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

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

आपको : ऑपरेटर का इस्तेमाल करके, कम से कम एक तरह का इवेंट (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 गड़बड़ी के साथ अस्वीकार कर देता है.

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

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

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

स्पेस में होने वाले इवेंट की लिस्टिंग के लिए रिस्पॉन्स मैसेज.

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

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

object (SpaceEvent)

नतीजे, समय के हिसाब से दिखाए जाते हैं (सबसे पुराना इवेंट पहले).
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

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