Method: customEmojis.list

ایموجی های سفارشی قابل مشاهده برای کاربر احراز هویت شده را فهرست می کند.

شکلک‌های سفارشی فقط برای حساب‌های Google Workspace در دسترس هستند و سرپرست باید شکلک‌های سفارشی را برای سازمان روشن کند. برای اطلاعات بیشتر، در مورد اموجی‌های سفارشی در گپ Google بدانید و مجوزهای شکلک سفارشی را مدیریت کنید .

به احراز هویت کاربر با یکی از حوزه های مجوز زیر نیاز دارد:

  • 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 Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.