Method: customEmojis.list

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

उपयोगकर्ता की पुष्टि ज़रूरी है.

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

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

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