Method: spaces.messagePins.list

किसी स्पेस में पिन किए गए मैसेज की सूची दिखाता है. उपयोगकर्ता, स्पेस में ज़रूरी मैसेज पिन कर सकते हैं, ताकि उन्हें आसानी से ऐक्सेस किया जा सके. ज़्यादा जानकारी के लिए, Google Chat में किसी बातचीत को पिन या अनपिन करना लेख पढ़ें.

इसके लिए, उपयोगकर्ता की पुष्टि ज़रूरी है. साथ ही, इनमें से किसी एक अनुमति के दायरे की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

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

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

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

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. पैरंट स्पेस, जिसमें पिन किए गए आइटम का कलेक्शन होता है. फ़ॉर्मैट: spaces/{space}

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

पैरामीटर
pageSize

integer

ज़रूरी नहीं. जवाब में, पिन किए गए ज़्यादा से ज़्यादा मैसेज की संख्या. ऐसा हो सकता है कि सेवा, इस वैल्यू से कम मैसेज दिखाए. ज़्यादा से ज़्यादा वैल्यू 100 हो सकती है. अगर 100 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो वह अपने-आप 100 में बदल जाती है. अगर कोई वैल्यू तय नहीं की जाती है, तो ज़्यादा से ज़्यादा 100 मैसेज पिन दिखाए जाएंगे. नेगेटिव वैल्यू डालने पर, INVALID_ARGUMENT गड़बड़ी दिखती है.
pageToken

string

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

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

अनुरोध का मुख्य हिस्सा

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

जवाब का मुख्य हिस्सा

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

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
messagePins[]

object (MessagePin)

चुने गए स्पेस से पिन किए गए मैसेज.
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

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