Method: customEmojis.list

تعرض قائمة برموز الإيموجي المخصّصة التي تظهر للمستخدم الذي تم مصادقة هويته.

يتطلب مصادقة المستخدم.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز 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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.