Method: customEmojis.get
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
傳回自訂表情符號的詳細資料。
自訂表情符號僅適用於 Google Workspace 帳戶,且管理員必須為機構開啟自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。
需要使用下列其中一個授權範圍進行使用者驗證:
https://www.googleapis.com/auth/chat.customemojis.readonly
https://www.googleapis.com/auth/chat.customemojis
HTTP 要求
GET https://chat.googleapis.com/v1/{name=customEmojis/*}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
name |
string
必要欄位。自訂表情符號的資源名稱。 格式:customEmojis/{customEmoji} 您可以使用表情符號名稱做為 {customEmoji} 的別名。例如 customEmojis/:example-emoji: ,其中 :example-emoji: 是自訂表情符號的表情符號名稱。
|
回應主體
如果成功,回應主體會包含 CustomEmoji
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/chat.customemojis
https://www.googleapis.com/auth/chat.customemojis.readonly
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[[["\u003cp\u003eThis feature lets you retrieve details about a specific custom emoji using the emoji name or ID.\u003c/p\u003e\n"],["\u003cp\u003eYou can access this feature during the Google Workspace Developer Preview Program and it requires user authentication.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made via a \u003ccode\u003eGET\u003c/code\u003e method to a specific URL with the emoji name or ID.\u003c/p\u003e\n"],["\u003cp\u003eThe response will contain information on the custom emoji in the \u003ccode\u003eCustomEmoji\u003c/code\u003e format.\u003c/p\u003e\n"],["\u003cp\u003eYou'll need specific authorization scopes related to custom emojis to use this functionality.\u003c/p\u003e\n"]]],["This document outlines how to retrieve details about a custom emoji via the Google Chat API. It utilizes a `GET` HTTP request to `https://chat.googleapis.com/v1/{name=customEmojis/*}`, requiring a resource name in the path parameter `name`. The request body must be empty. A successful response returns a `CustomEmoji` instance. User authentication is mandatory, needing one of the specified OAuth scopes, and the process is part of the Google Workspace Developer Preview Program.\n"],null,["# Method: customEmojis.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns details about a custom emoji.\n\nCustom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085).\n\nRequires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):\n\n- `https://www.googleapis.com/auth/chat.customemojis.readonly`\n- `https://www.googleapis.com/auth/chat.customemojis`\n\n### HTTP request\n\n`GET https://chat.googleapis.com/v1/{name=customEmojis/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the custom emoji. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [CustomEmoji](/workspace/chat/api/reference/rest/v1/customEmojis#CustomEmoji).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.customemojis`\n- `https://www.googleapis.com/auth/chat.customemojis.readonly`\n\nFor more information, see the [Authorization guide](/workspace/chat/authenticate-authorize)."]]