Method: spaces.spaceEvents.list

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

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

  • डेवलपर प्रीव्यू में एडमिन की मंज़ूरी के साथ ऐप्लिकेशन की पुष्टि. इसके लिए, इनमें से किसी एक अनुमति के दायरे का इस्तेमाल किया जाता है:

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

  • उपयोगकर्ता की पुष्टि के लिए, अनुमति के इन स्कोप में से किसी एक का इस्तेमाल करें:

    • 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

ज़रूरी नहीं. यह पेज टोकन है. यह पिछले listSpaceEvents कॉल से मिला था. अगला पेज पाने के लिए, यह जानकारी दें.

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

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

string

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

अनुमति पाने के लिंक

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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

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