Method: spaces.messages.list

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

इन तरह के authentication के साथ काम करता है:

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

    • https://www.googleapis.com/auth/chat.app.messages.readonly. पुष्टि करने के इस स्कोप का इस्तेमाल करने पर, यह तरीका सिर्फ़ किसी स्पेस में मौजूद सार्वजनिक मैसेज दिखाता है. इसमें निजी मैसेज शामिल नहीं होते हैं.

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

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (सिर्फ़ इंपोर्ट मोड वाले स्पेस)

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

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

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

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

string

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

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

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

थ्रेड के हिसाब से फ़िल्टर करने के लिए, thread.name को spaces/{space}/threads/{thread} के तौर पर फ़ॉर्मैट करें. हर क्वेरी के लिए, सिर्फ़ एक 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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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