Method: customEmojis.get
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
درخواست HTTP
GET https://chat.googleapis.com/v1/{name=customEmojis/*}
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
name | string مورد نیاز. نام منبع ایموجی سفارشی. قالب: customEmojis/{customEmoji} می توانید از نام emoji به عنوان نام مستعار برای {customEmoji} استفاده کنید. به عنوان مثال، customEmojis/:example-emoji: که در آن :example-emoji: نام ایموجی برای یک ایموجی سفارشی است. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از CustomEmoji است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/chat.customemojis -
https://www.googleapis.com/auth/chat.customemojis.readonly
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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)."]]
