Method: spaces.messages.list

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

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

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

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

पाथ के पैरामीटर

पैरामीटर
parent

string

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

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

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

पैरामीटर
pageSize

integer

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

अगर इनकी जानकारी नहीं दी गई है, तो ज़्यादा से ज़्यादा 25 कोड दिखाए जाते हैं.

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

नेगेटिव वैल्यू दिखाने पर INVALID_ARGUMENT गड़बड़ी दिखती है.
pageToken

string

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

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

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

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

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

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

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

मैसेज की सूची के लिए जवाब वाला मैसेज.

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

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

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