פיתוח באמצעות Google Chat
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מפורטת סקירה כללית על Google Chat API ועל אפליקציות ל-Google Chat.
סקירה כללית על Google Chat API
Chat API מורכב משירותי gRPC או משיטות ומשאבי REST שמאפשרים גישה ל-Chat, כולל מרחבים, משתתפים במרחבים, הודעות, תגובות להודעות, קבצים שמצורפים להודעות, אירועים במרחבים ומצבי קריאה של משתמשים.
מושגים
בקטע הבא מוגדרים השירותים, המשאבים והשיטות של Chat API:
- מרחבים
מרחבים הם מקומות שבהם אנשים ואפליקציות יכולים לנהל שיחות ולשתף קבצים. יש כמה סוגים של מרחבים. צ'אטים ישירים הם שיחות אישיות בין שני משתמשים או בין משתמש לאפליקציית Chat. צ'אטים קבוצתיים הם שיחות בין שלושה משתמשים או יותר לבין אפליקציות Chat. מרחבים משותפים הם מקומות קבועים שבהם אנשים יכולים לשלוח הודעות, לשתף קבצים ולעבוד יחד.
הפניה למשאבים:
לדוגמה לשימוש, אפשר לעיין במאמר:
- חברים
משתתפים הם משתמשים ואפליקציות ל-Chat שהצטרפו למרחב או הוזמנו אליו.
הפניה למשאבים:
לדוגמה לשימוש, אפשר לעיין במאמר:
- הודעות
הודעות כוללות
טקסט
ו
כרטיסים
שפורסמו במרחבים. אפשר לצרף קבצים להודעות.
אנשים יכולים להגיב להודעות באמצעות אמוג'י.
הפניה למשאבים:
לדוגמה לשימוש, אפשר לעיין במאמר:
- תגובות
תגובות הן האמוג'י שאנשים משתמשים בהם כדי להגיב להודעה, כמו 👍, 🚲 ו-🌞.
הפניה למשאבים:
לדוגמה לשימוש, אפשר לעיין במאמר:
- סמלי אמוג'י מותאמים אישית
אמוג'י בהתאמה אישית מייצגים אמוג'י בהתאמה אישית שנוצרו וששותפו בארגון ב-Google Chat. אפשר לכלול אמוג'י בהתאמה אישית בתוכן של הודעה או להשתמש בו כדי להגיב להודעה.
הפניה למשאבים:
לדוגמה לשימוש, אפשר לעיין במאמר:
- מדיה וקבצים מצורפים
Media מייצג קובץ שהועלה ל-Google Chat, כמו תמונות, סרטונים ומסמכים.
הפניה למשאב מדיה (לא זמין ב-RPC):
קבצים מצורפים הם מקרים של מדיה (קבצים) שמצורפים להודעות.
הפניה למשאבים:
לדוגמה לשימוש, אפשר לעיין במאמר:
- אירועים ב-Spaces
אירועים במרחב מייצגים שינויים במרחב או במשאבי הצאצא שלו, כולל המשתתפים, ההודעות והתגובות.
הפניה למשאבים:
לדוגמה לשימוש, אפשר לעיין במאמר:
- מצבי קריאה של משתמשים
מצבי קריאה של משתמשים הם משאבים יחידים שמייצגים פרטים על ההודעה האחרונה שמשתמש מסוים קרא במרחב ב-Google Chat או בשרשור הודעות.
הפניה למשאב של סטטוס קריאה במרחב:
הפניה למשאב של מצב קריאת השרשור:
לדוגמה לשימוש, אפשר לעיין במאמר:
- הגדרות ההתראות של המשתמשים במרחבים
הגדרות ההתראות של המרחב המשותף של המשתמש הן משאבים יחידים שמייצגים את הגדרות ההתראות של משתמש מסוים במרחב ב-Google Chat.
הפניה למשאבים:
אימות
כדי לשלוח קריאה ל-Chat API צריך לבצע אימות. כל שיטה ב-Chat API דורשת אימות משתמש (כדי לבצע פעולות או לגשת לנתונים בשם משתמש) או אימות אפליקציה (כדי לבצע פעולות או לגשת לנתונים כאפליקציה ל-Chat). חלק מהשיטות תומכות באימות משתמשים ובאימות אפליקציות.
למידע נוסף על אימות ב-Chat, קראו את הסקירה הכללית על אימות.
ספריות לקוח
הדרך המומלצת לרוב המפתחים לקרוא ל-Google Chat API היא באמצעות ספריות הלקוח של Cloud שנתמכות באופן רשמי בשפה המועדפת עליכם, כמו Python, Java או Node.js.
אם אתם כותבים קוד באמצעות Google Apps Script, אתם יכולים להשתמש בשירות המתקדם של Chat במקום להתקין ספריית לקוח.
פיתוח אפליקציות ל-Chat
Chat API מאפשר לכם לבנות אפליקציות ל-Google Chat שמשלבות את השירותים והמשאבים שלכם ישירות ב-Google Chat. אתם יכולים ליצור אפליקציות ל-Chat כדי לבצע כל אחת מהפעולות הבאות:
- אחזור מידע על סמך שאילתות של טקסט חופשי או מובנה שהמשתמש הזין.
- יצירת דוחות על אירועים או פריטים אחרים, על סמך מידע שהמשתמש סיפק.
- לשפר את שיתוף הפעולה בצוות, למשל על ידי יצירת "זיכרון צוותי" או תזמון משאבים.
אתם יכולים לעצב את אפליקציית Chat באמצעות סגנונות ארכיטקטורה שונים, כולל:
- אפליקציות אינטראקטיביות: מגיבות לאינטראקציה של המשתמשים, כמו תיוגים עם @או פקודות עם לוכסן (/), ומציגות מידע או מדריכות את המשתמשים בתהליך עבודה באמצעות כרטיסים ודיאלוגים.
- אפליקציות של שורת פקודה או וווב-הוקים: שליחת הודעות יזומות, כמו אזעקות או התראות, ממערכת אחרת למרחב. המשתמשים לא יכולים ליצור אינטראקציה ישירה עם סוג האפליקציה הזה.
- אפליקציות מבוססות-אירועים: אפשר להירשם לפעילות במרחב ב-Chat ולהגיב לה, למשל כשמשתמש חדש מצטרף למרחב. בתגובה לאירוע, האפליקציה יכולה לשלוח הודעה או לבצע פעולה אחרת.
פרטים על תכנון אפליקציה ל-Chat זמינים במאמר בחירת ארכיטקטורה של אפליקציה ל-Google Chat.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-04 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-04 (שעון UTC)."],[[["\u003cp\u003eGoogle Chat apps integrate services directly into chats, enabling users to access information and take action without leaving the conversation.\u003c/p\u003e\n"],["\u003cp\u003eThese apps support various functionalities, including workflow management, data collection, and interactive elements like dialogs and slash commands.\u003c/p\u003e\n"],["\u003cp\u003eChoose from interactive, non-interactive, or event-driven architectures to build apps that cater to your specific needs and use cases.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Chat apps can be built using various platforms like AppSheet, Google Apps Script, and Dialogflow.\u003c/p\u003e\n"],["\u003cp\u003eAccess to user data beyond basic identity requires authentication and user consent, ensuring privacy and security.\u003c/p\u003e\n"]]],["Google Chat apps integrate services directly into conversations, allowing users to access information and perform actions without leaving the chat. These apps can send text or card messages within spaces or direct messages. They can be interactive, responding to mentions and commands, or non-interactive, sending messages without user interaction. Apps can retrieve information, file tickets, and coordinate team efforts. Developers can build these apps using diverse platforms, manage deployments, and publish them on the Google Workspace Marketplace.\n"],null,["# Develop with Google Chat\n\nThis page provides an overview of the Google Chat API and Google Chat apps.\n\nGoogle Chat API overview\n------------------------\n\nThe Chat API consists of\n[gRPC services or REST resources and methods](https://cloud.google.com/apis/docs/client-libraries-explained)\nthat grant access to Chat, including spaces, space members,\nmessages, message reactions, message attachments, space events, and user read\nstates.\n\n### Concepts\n\nThe following section defines the services, resources, and methods for the\nChat API:\n\n*Spaces*\n\n: *Spaces* are places where people and apps can converse and share files. There\n are several types of spaces. Direct messages (DMs) are 1:1 conversations\n between two users or a user and a Chat app. Group\n chats are conversations between three or more users and\n Chat apps. Named spaces are persistent places where people send\n messages, share files, and collaborate.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Space)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces)\n\n: For example usage, see:\n\n - [Create a space](/workspace/chat/create-spaces)\n - [Set up a space](/workspace/chat/set-up-spaces)\n - [Get a space](/workspace/chat/get-spaces)\n - [List spaces](/workspace/chat/list-spaces)\n - [Update a space](/workspace/chat/update-spaces)\n - [Delete a space](/workspace/chat/delete-spaces)\n - [Find a direct message (DM)](/workspace/chat/find-direct-message-in-spaces)\n\n*Members*\n\n: *Members* are users and Chat apps that have joined or are\n invited to a space.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Membership)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.members)\n\n: For example usage, see:\n\n - [Create a membership](/workspace/chat/create-members)\n - [Get a membership](/workspace/chat/get-members)\n - [List memberships](/workspace/chat/list-members)\n - [Update a membership](/workspace/chat/update-members)\n - [Delete a membership](/workspace/chat/delete-members)\n\n*Messages*\n\n: *Messages* include\n [text](/workspace/chat/api/reference/rest/v1/spaces.messages)\n and\n [card](/workspace/chat/api/reference/rest/v1/cards)\n communications posted in spaces. Messages can have files attached to them.\n People can react to messages by appending emoji to them.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Message)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.messages)\n\n: For example usage, see:\n\n - [Create a message](/workspace/chat/create-messages)\n - [Get a message](/workspace/chat/get-messages)\n - [List messages](/workspace/chat/list-messages)\n - [Update a message](/workspace/chat/update-messages)\n - [Delete a message](/workspace/chat/delete-messages)\n\n*Reactions*\n\n: *Reactions* represent the emoji people use to react to a message, such as\n 👍, 🚲, and 🌞.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Reaction)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.messages.reactions)\n\n: For example usage, see:\n\n - [Create a reaction](/workspace/chat/create-reactions)\n - [List reactions](/workspace/chat/list-reactions)\n - [Delete a reaction](/workspace/chat/delete-reactions)\n\n*Custom emoji*\n\n: *Custom emoji* represent custom emoji created and shared within the\n organization in Google Chat. Custom emoji can be included in the content of\n a message or used to react to a message.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.CustomEmoji)\n - [REST reference](/workspace/chat/api/reference/rest/v1/customEmojis)\n\n: For example usage, see:\n\n - [Create a custom emoji](/workspace/chat/create-custom-emoji)\n - [Delete a custom emoji](/workspace/chat/delete-custom-emoji)\n - [Get details about a custom emoji](/workspace/chat/get-custom-emoji)\n - [List custom emojis in an organization](/workspace/chat/list-custom-emojis)\n\n*Media and attachments*\n\n: *Media* represents a file uploaded to Google Chat, like images, videos, and\n documents.\n\n: Media resource reference (Unavailable in RPC):\n\n - [REST reference](/workspace/chat/api/reference/rest/v1/media)\n\n: *Attachments* are instances of media (files) attached to messages.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Attachment)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.messages.attachments)\n\n: For example usage, see:\n\n - [Upload media as an attachment](/workspace/chat/upload-media-attachments)\n - [Download media as an attachment](/workspace/chat/download-media-attachments)\n - [Get an attachment](/workspace/chat/get-media-attachments)\n\n*Space events*\n\n: *Space events* represent changes to a space or its\n child resources, including its members, messages, and reactions.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceEvent)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.spaceEvents)\n\n: For example usage, see:\n\n - [Get space read state](/workspace/chat/get-space-read-state)\n - [Update space read state](/workspace/chat/update-space-read-state)\n - [Get thread read state](/workspace/chat/get-thread-read-state)\n\n*User read states*\n\n: *User read states* are singleton resources that represent details about a\n specified user's last read message in a Google Chat space or a message\n thread.\n\n: Space read state resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceReadState)\n - [REST reference](/workspace/chat/api/reference/rest/v1/users.spaces)\n\n: Thread read state resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ThreadReadState)\n - [REST reference](/workspace/chat/api/reference/rest/v1/users.spaces.threads)\n\n: For example usage, see:\n\n - [Get space read state](/workspace/chat/get-space-read-state)\n - [Update space read state](/workspace/chat/update-space-read-state)\n - [Get thread read state](/workspace/chat/get-thread-read-state)\n\n*User space notification settings*\n\n: *User space notification settings* are singleton resources that represent a\n specified user notification settings in a Google Chat space.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceNotificationSetting)\n - [REST reference](/workspace/chat/api/reference/rest/v1/users.spaces.spaceNotificationSetting)\n\n### Authentication\n\nCalling the Chat API requires authentication. Each\nChat API method requires either\n[user authentication](/workspace/chat/authenticate-authorize-chat-user)\n(to perform actions or access\ndata on behalf of a user) or\n[app authentication](/workspace/chat/authenticate-authorize-chat-app)\n(to perform actions or access data as a Chat app). Some\nmethods support both user authentication and app authentication.\n\nTo learn more about authentication in Chat, see\n[Authentication overview](/workspace/chat/authenticate-authorize).\n\n### Client libraries\n\nThe recommended way for most developers to call the Google Chat API\nis with our officially supported\n[Cloud Client Libraries](/workspace/chat/libraries)\nfor your preferred language, like Python, Java, or Node.js.\n\nIf you're coding with Google Apps Script, use the\n[Advanced Chat service](/apps-script/advanced/chat)\ninstead of installing a client library.\n\nBuild Chat apps\n---------------\n\nThe Chat API lets you build Google Chat apps that bring your\nservices and resources right into Google Chat. You can build\nChat apps to do any of the following:\n\n- Retrieve information based on structured or free text queries entered by the user.\n- Generate incident reports or other artifacts, using information provided by the user.\n- Enhance team collaboration, such as providing \"team memory\" or scheduling resources.\n\nYou can design your Chat app using several different\narchitecture styles, including the following:\n\n- **Interactive apps**: Respond to user interaction, such as @mentions or slash commands, and present information or guide users through a workflow with cards and dialogs.\n- **Command-line apps or webhooks**: Send proactive messages, such as alarms or notifications, from another system into a space. Users can't directly interact with this type of app.\n- **Event-driven apps**: Subscribe to and react to activity in a Chat space, such as a new member joining. In response to an event, the app can send a message or perform another action.\n\nFor details about designing your Chat app, see\n[Choose a Google Chat app architecture](/workspace/chat/structure).\n\nRelated topics\n--------------\n\n- [Explore Google Chat app samples](/workspace/chat/samples).\n- [Build interactive Google Chat apps](/workspace/chat/interact-users-overview).\n- [Choose a Google Chat app architecture](/workspace/chat/structure).\n\n|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | Want to see the Google Chat API in action? The Google Workspace Developers channel offers videos about tips, tricks, and the latest features. [Subscribe now](https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw) |"]]
