Method: spaces.messages.list

यह डायलॉग बॉक्स उन स्पेस में मौजूद मैसेज की सूची बनाता है जिनका सदस्य कॉलर है. इसमें, ब्लॉक किए गए सदस्यों और स्पेस के मैसेज भी शामिल हैं. अगर बिना मैसेज वाले स्पेस के मैसेज की सूची बनाई जाती है, तो जवाब एक खाली ऑब्जेक्ट होता है. REST/एचटीटीपी इंटरफ़ेस का इस्तेमाल करते समय, रिस्पॉन्स में एक खाली JSON ऑब्जेक्ट, {} होता है. उदाहरण के लिए, मैसेज की सूची बनाना देखें. उपयोगकर्ता की पुष्टि ज़रूरी है.

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

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

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

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. स्पेस के मैसेज की सूची बनाने के लिए, संसाधन का नाम.

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

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

पैरामीटर
pageSize

integer

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

अगर जानकारी नहीं है, तो ज़्यादा से ज़्यादा 25 नतीजे लौटाए जाते हैं.

ज़्यादा से ज़्यादा वैल्यू 1,000 है. अगर 1,000 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो वह अपने-आप 1,000 में बदल जाता है.

नेगेटिव वैल्यू से INVALID_ARGUMENT गड़बड़ी मिलती है.
pageToken

string

ज़रूरी नहीं, अगर इसे किसी पिछली क्वेरी से फिर से शुरू किया जा रहा हो.

पिछले मैसेज कॉल से मिला पेज टोकन. बाद वाले पेज को फिर से पाने के लिए यह पैरामीटर दें.

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

string

क्वेरी फ़िल्टर.

तारीख (createTime) और थ्रेड (thread.name) के हिसाब से मैसेज फ़िल्टर किए जा सकते हैं.

मैसेज को उन्हें बनाए जाने की तारीख के हिसाब से फ़िल्टर करने के लिए, RFC-3339 फ़ॉर्मैट में टाइमस्टैंप और डबल कोटेशन मार्क के साथ createTime की जानकारी दें. उदाहरण के लिए, "2023-04-21T11:30:00-04:00". टाइमस्टैंप के बाद बनाए गए मैसेज की सूची बनाने के लिए, ऑपरेटर > से ज़्यादा ऑपरेटर का इस्तेमाल किया जा सकता है. वहीं, टाइमस्टैंप से पहले बनाए गए मैसेज की सूची बनाने के लिए, ऑपरेटर < का इस्तेमाल किया जा सकता है. किसी समयावधि में मैसेज फ़िल्टर करने के लिए, दो टाइमस्टैंप के बीच AND ऑपरेटर का इस्तेमाल करें.

थ्रेड के हिसाब से फ़िल्टर करने के लिए, spaces/{space}/threads/{thread} फ़ॉर्मैट में thread.name डालें. हर क्वेरी के लिए सिर्फ़ एक thread.name तय किया जा सकता है.

थ्रेड और तारीख, दोनों के हिसाब से फ़िल्टर करने के लिए, अपनी क्वेरी में AND ऑपरेटर का इस्तेमाल करें.

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

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

string

ज़रूरी नहीं, अगर इसे किसी पिछली क्वेरी से फिर से शुरू किया जा रहा हो.

मैसेज की सूची को क्रम से लगाने का तरीका. ऑर्डर करने की कार्रवाई के हिसाब से वह वैल्यू डालें जिसे ऑर्डर करना है. मान्य ऑर्डर ऑपरेशन मान इस प्रकार हैं:

  • बढ़ते क्रम में लगाने के लिए ASC.

  • घटते क्रम में लगाने के लिए, DESC.

डिफ़ॉल्ट क्रम createTime ASC है.
showDeleted

boolean

क्या मिटाए गए मैसेज शामिल करने हैं. मिटाए गए मैसेज में, मिटाए जाने का समय और उनसे जुड़ा मेटाडेटा शामिल होता है. हालांकि, मैसेज का कॉन्टेंट उपलब्ध नहीं होता.

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

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

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

लिस्टिंग मैसेज के लिए जवाब देने वाला मैसेज.

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

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

object (Message)

मैसेज की सूची.
nextPageToken

string

नतीजों का अगला पेज वापस पाने के लिए, pageToken के तौर पर टोकन भेजा जा सकता है. अगर खाली है, तो इसके बाद कोई पेज नहीं होता.

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

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

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

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