Method: customEmojis.list

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

نیاز به احراز هویت کاربر دارد.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
page Size

integer

اختیاری. حداکثر تعداد ایموجی سفارشی برگردانده شده است. این سرویس می تواند شکلک های سفارشی کمتری نسبت به این مقدار برگرداند. اگر مشخص نشده باشد، مقدار پیش فرض 25 است. حداکثر مقدار 200 است. مقادیر بالای 200 به 200 تغییر می کند.

page Token

string

اختیاری. (در صورت از سرگیری درخواست قبلی.)

یک نشانه صفحه دریافت شده از تماس قبلی با شکلک سفارشی. این را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه‌بندی، مقدار فیلتر باید با تماسی که توکن صفحه را ارائه می‌کند، مطابقت داشته باشد. عبور یک مقدار متفاوت ممکن است منجر به نتایج غیرمنتظره شود.

filter

string

اختیاری. یک فیلتر پرس و جو

پشتیبانی از فیلتر توسط سازنده.

برای فیلتر بر اساس سازنده، باید یک مقدار معتبر را مشخص کنید. در حال حاضر فقط creator("users/me") و NOT creator("users/me") برای فیلتر کردن ایموجی های سفارشی پذیرفته می شوند که آیا توسط کاربر تماس گیرنده ایجاد شده اند یا خیر.

برای مثال، کوئری زیر شکلک های سفارشی ایجاد شده توسط تماس گیرنده را برمی گرداند:

creator("users/me")

درخواست‌های نامعتبر توسط سرور با خطای INVALID_ARGUMENT رد می‌شوند.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پاسخی به لیستی از ایموجی های سفارشی.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "customEmojis": [
    {
      object (CustomEmoji)
    }
  ],
  "nextPageToken": string
}
فیلدها
custom Emojis[]

object ( CustomEmoji )

لیست نامرتب لیست ایموجی های سفارشی در صفحه درخواستی (یا اول).

next Page Token

string

نشانه ای که می توانید آن را به عنوان pageToken برای بازیابی صفحه بعدی نتایج ارسال کنید. اگر خالی باشد، هیچ صفحه بعدی وجود ندارد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

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