Method: customEmojis.list

पुष्टि किए गए उपयोगकर्ता को दिखने वाले कस्टम इमोजी की सूची.

पसंद के मुताबिक बनाए गए इमोजी सिर्फ़ Google Workspace खातों के लिए उपलब्ध हैं. साथ ही, एडमिन को संगठन के लिए पसंद के मुताबिक बनाए गए इमोजी की सुविधा चालू करनी होगी. ज़्यादा जानकारी के लिए, Google Chat में पसंद के मुताबिक बनाए गए इमोजी के बारे में जानकारी और पसंद के मुताबिक बनाए गए इमोजी की अनुमतियां मैनेज करना लेख पढ़ें.

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

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis

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

GET https://chat.googleapis.com/v1/customEmojis

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

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

पैरामीटर
pageSize

integer

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

string

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

पसंद के मुताबिक बनाए गए इमोजी की सूची के लिए, पिछले कॉल से मिला पेज टोकन. अगला पेज देखने के लिए, यह डालें.

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

string

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

क्रिएटर के हिसाब से फ़िल्टर करने की सुविधा.

क्रिएटर के हिसाब से फ़िल्टर करने के लिए, आपको कोई मान्य वैल्यू डालनी होगी. फ़िलहाल, कस्टम इमोजी को कॉल करने वाले उपयोगकर्ता ने बनाया है या नहीं, इस आधार पर फ़िल्टर करने के लिए सिर्फ़ creator("users/me") और NOT creator("users/me") का इस्तेमाल किया जा सकता है.

उदाहरण के लिए, नीचे दी गई क्वेरी से, कॉलर के बनाए गए पसंद के मुताबिक इमोजी दिखते हैं:

creator("users/me")

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

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

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

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

पसंद के मुताबिक बनाए गए इमोजी की सूची दिखाने के लिए जवाब.

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

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

object (CustomEmoji)

बिना क्रम वाली सूची. पसंद के मुताबिक बनाए गए इमोजी की सूची.
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

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