REST Resource: customEmojis
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: CustomEmoji
Representación JSON |
{
"name": string,
"uid": string,
"emojiName": string,
"temporaryImageUri": string,
"payload": {
object (CustomEmojiPayload )
}
} |
Campos |
name |
string
Identificador. Es el nombre del recurso del emoji personalizado que asigna el servidor. Formato: customEmojis/{customEmoji}
|
uid |
string
Solo salida. Clave única para el recurso de emoji personalizado.
|
emojiName |
string
Opcional. Inmutable. Es el nombre que proporciona el usuario para el emoji personalizado, que es único dentro de la organización. Es obligatorio cuando se crea el emoji personalizado; de lo contrario, solo se muestra la salida. Los nombres de los emojis deben comenzar y terminar con dos puntos, deben escribirse en minúsculas y solo pueden incluir caracteres alfanuméricos, guiones y guiones bajos. Los guiones y guiones bajos deben usarse para separar palabras y no pueden usarse consecutivamente. Ejemplo: :valid-emoji-name:
|
temporaryImageUri |
string
Solo salida. Es una URL de imagen temporal para el emoji personalizado, válida durante al menos 10 minutos. Ten en cuenta que no se propaga en la respuesta cuando se crea el emoji personalizado.
|
payload |
object (CustomEmojiPayload )
Opcional. Solo entrada. Datos de carga útil Obligatorio cuando se crea el emoji personalizado.
|
CustomEmojiPayload
Datos de carga útil para el emoji personalizado.
Representación JSON |
{
"fileContent": string,
"filename": string
} |
Campos |
fileContent |
string (bytes format)
Obligatorio. Solo entrada. Es la imagen que se usa para el emoji personalizado. La carga útil debe ser inferior a 256 KB y la dimensión de la imagen debe ser cuadrada y tener entre 64 y 500 píxeles. Las restricciones están sujetas a cambios.
|
filename |
string
Obligatorio. Solo entrada. Es el nombre del archivo de imagen. Extensiones de archivo compatibles: .png , .jpg , .gif .
|
Métodos |
|
Crea un emoji personalizado. |
|
Borra un emoji personalizado. |
|
Muestra detalles sobre un emoji personalizado. |
|
Muestra una lista de los emojis personalizados visibles para el usuario autenticado. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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. |"]]