REST Resource: customEmojis
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
リソース: CustomEmoji
JSON 表現 |
{
"name": string,
"uid": string,
"emojiName": string,
"temporaryImageUri": string,
"payload": {
object (CustomEmojiPayload )
}
} |
フィールド |
name |
string
ID。サーバーが割り当てたカスタム絵文字のリソース名。 形式: 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 KB 未満で、画像のサイズは正方形で 64 ~ 500 ピクセルの範囲でなければなりません。制限は変更される可能性があります。
|
filename |
string
必須。入力のみの画像ファイル名。 サポートされているファイル拡張子: .png 、.jpg 、.gif 。
|
メソッド |
|
カスタム絵文字を作成します。 |
|
カスタム絵文字を削除します。 |
|
カスタム絵文字の詳細を返します。 |
|
認証済みユーザーに表示されるカスタム絵文字を一覧表示します。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 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. |"]]