Method: customEmojis.list
ایموجی های سفارشی قابل مشاهده برای کاربر احراز هویت شده را فهرست می کند. نیاز به احراز هویت کاربر دارد.
درخواست 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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-02-27 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-02-27 بهوقت ساعت هماهنگ جهانی."],[[["Lists custom emojis visible to the authenticated user, requiring user authentication and specific authorization scopes."],["Allows filtering by creator to see emojis created by the calling user or others."],["Supports pagination to retrieve large lists of custom emojis, with a default page size of 25 and a maximum of 200."],["Returns a list of custom emojis and a token for retrieving subsequent pages if available."],["Requires an empty request body and provides a structured JSON response containing emoji details."]]],["This document details how to list custom emojis in Google Chat via an HTTP GET request to `https://chat.googleapis.com/v1/customEmojis`. The request requires user authentication and supports optional query parameters: `pageSize` (default 25, max 200), `pageToken` (for pagination), and `filter` (to filter by emoji creator). The request body must be empty. The response includes a list of `customEmojis` and an optional `nextPageToken` for pagination. Authorization requires either `chat.customemojis` or `chat.customemojis.readonly` scope.\n"]]