Method: customEmojis.get
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בקשת HTTP
GET https://chat.googleapis.com/v1/{name=customEmojis/*}
כתובת ה-URL משתמשת בתחביר של Transcoding של 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
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\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)."]]