Method: spaces.spaceEvents.list

यह Google Chat पर मौजूद किसी स्पेस के इवेंट की सूची बनाता है. हर इवेंट के लिए, पेलोड में 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 गड़बड़ी के साथ अस्वीकार कर देता है.

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

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

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

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

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

JSON के काेड में दिखाना
{
  "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

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