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)
חובה. קלט בלבד. התמונה שבה נעשה שימוש באמוג'י המותאם אישית. עומס העבודה חייב להיות קטן מ-256KB והתמונה חייבת להיות ריבועית בגודל של 64 עד 500 פיקסלים. ההגבלות עשויות להשתנות.
|
filename |
string
חובה. קלט בלבד. שם קובץ התמונה. סיומות הקובץ הנתמכות: .png, .jpg, .gif.
|
Methods |
|
|
יצירת אמוג'י בהתאמה אישית. |
|
|
מחיקה של אמוג'י בהתאמה אישית. |
|
|
הפונקציה מחזירה פרטים על אמוג'י מותאם אישית. |
|
|
רשימה של אמוג'י מותאמים אישית שגלויים למשתמש המאומת. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\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. |"]]
