REST Resource: customEmojis
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
منبع: CustomEmoji
| نمایندگی JSON |
|---|
{
"name": string,
"uid": string,
"emojiName": string,
"temporaryImageUri": string,
"payload": {
object (CustomEmojiPayload)
}
} |
| فیلدها |
|---|
name | string شناسه. نام منبع ایموجی سفارشی که توسط سرور اختصاص داده شده است. قالب: customEmojis/{customEmoji} |
uid | string فقط خروجی کلید منحصر به فرد برای منبع ایموجی سفارشی. |
emojiName | string اختیاری. تغییرناپذیر. نام ارائه شده توسط کاربر برای ایموجی سفارشی، که در سازمان منحصر به فرد است. زمانی که ایموجی سفارشی ایجاد می شود، لازم است، فقط در غیر این صورت خروجی بگیرید. نام ایموجی‌ها باید با دونقطه شروع و ختم شوند، باید با حروف کوچک باشند و فقط شامل نویسه‌های الفبایی، خط فاصله و زیرخط باشند. خط فاصله و زیرخط باید برای جدا کردن کلمات استفاده شود و نمی توان آنها را پشت سر هم به کار برد. مثال: :valid-emoji-name: |
temporaryImageUri | string فقط خروجی یک URL تصویر موقت برای شکلک سفارشی که حداقل 10 دقیقه معتبر است. توجه داشته باشید که هنگام ایجاد ایموجی سفارشی، این در پاسخ پر نمی شود. |
payload | object ( CustomEmojiPayload ) اختیاری. فقط ورودی داده های بار. هنگام ایجاد ایموجی سفارشی لازم است. |
CustomEmojiPayload
داده های بارگذاری برای شکلک سفارشی.
| نمایندگی JSON |
|---|
{
"fileContent": string,
"filename": string
} |
| فیلدها |
|---|
fileContent | string ( bytes format) مورد نیاز. فقط ورودی تصویر مورد استفاده برای ایموجی سفارشی. حجم بار باید کمتر از 256 کیلوبایت باشد و ابعاد تصویر باید مربع و بین 64 تا 500 پیکسل باشد. محدودیت ها در معرض تغییر هستند. |
filename | string مورد نیاز. فقط ورودی نام فایل تصویری پسوندهای فایل پشتیبانی شده: .png ، .jpg ، .gif . |
روش ها |
|---|
| یک ایموجی سفارشی ایجاد می کند. |
| یک ایموجی سفارشی را حذف می کند. |
| جزئیات یک ایموجی سفارشی را برمی‌گرداند. |
| ایموجی های سفارشی قابل مشاهده برای کاربر احراز هویت شده را فهرست می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eThis documentation outlines the \u003ccode\u003eCustomEmoji\u003c/code\u003e resource, representing a custom emoji within Google Chat, including its properties and JSON representation.\u003c/p\u003e\n"],["\u003cp\u003eIt describes the \u003ccode\u003eCustomEmojiPayload\u003c/code\u003e, detailing the data required for creating a custom emoji, specifically focusing on image content and filename.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the provided methods to create, delete, retrieve, or list custom emojis using the Google Chat API.\u003c/p\u003e\n"],["\u003cp\u003eThese functionalities are currently part of the Google Workspace Developer Preview Program, granting early access for testing and development purposes.\u003c/p\u003e\n"]]],["Custom emojis, part of the Google Workspace Developer Preview, are defined by a name, unique identifier (`uid`), and user-provided `emojiName` that must be enclosed in colons. A `temporaryImageUri` is provided. The `payload` contains the image's `fileContent` (under 256 KB) and `filename` (.png, .jpg, .gif). Key actions include: creating custom emojis, deleting them, retrieving details, and listing all visible custom emojis. All these actions are performed through the corresponding methods.\n"],null,["# REST Resource: customEmojis\n\n- [Resource: CustomEmoji](#CustomEmoji)\n - [JSON representation](#CustomEmoji.SCHEMA_REPRESENTATION)\n - [CustomEmojiPayload](#CustomEmoji.CustomEmojiPayload)\n - [JSON representation](#CustomEmoji.CustomEmojiPayload.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CustomEmoji\n---------------------\n\nRepresents a [custom emoji](https://support.google.com/chat/answer/12800149).\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"uid\": string, \"emojiName\": string, \"temporaryImageUri\": string, \"payload\": { object (/workspace/chat/api/reference/rest/v1/customEmojis#CustomEmoji.CustomEmojiPayload) } } ``` |\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}` |\n| `uid` | `string` Output only. Unique key for the custom emoji resource. |\n| `emojiName` | `string` Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:` |\n| `temporaryImageUri` | `string` Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created. |\n| `payload` | `object (`[CustomEmojiPayload](/workspace/chat/api/reference/rest/v1/customEmojis#CustomEmoji.CustomEmojiPayload)`)` Optional. Input only. Payload data. Required when the custom emoji is created. |\n\n### CustomEmojiPayload\n\nPayload data for the custom emoji.\n\n| JSON representation |\n|-------------------------------------------------------|\n| ``` { \"fileContent\": string, \"filename\": string } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `fileContent` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` Required. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change. |\n| `filename` | `string` Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------|--------------------------------------------------------|\n| ### [create](/workspace/chat/api/reference/rest/v1/customEmojis/create) | Creates a custom emoji. |\n| ### [delete](/workspace/chat/api/reference/rest/v1/customEmojis/delete) | Deletes a custom emoji. |\n| ### [get](/workspace/chat/api/reference/rest/v1/customEmojis/get) | Returns details about a custom emoji. |\n| ### [list](/workspace/chat/api/reference/rest/v1/customEmojis/list) | Lists custom emojis visible to the authenticated user. |"]]
