Method: customEmojis.list

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

لا تتوفّر الرموز التعبيرية المخصّصة إلا لحسابات Google Workspace، وعلى المشرف تفعيل الرموز التعبيرية المخصّصة للمؤسسة. لمزيد من المعلومات، يُرجى الاطّلاع على المقالتَين التعرّف على الرموز التعبيرية المخصّصة في Google Chat وإدارة أذونات الرموز التعبيرية المخصّصة.

تتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

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

طلب 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

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