בסעיף הזה מוסבר איך אפליקציות Google Chat יכולות לקרוא ל-Chat API. ה-API הזה מאפשר לאפליקציות ל-Chat, כמו ליצור מרחב משותף, להוסיף אליו אנשים ולפרסם הודעות בלי שאירוע אינטראקציה באפליקציית Chat ייפתח.
אימות
כדי להפעיל את Chat API צריך לבצע אימות באופן אסינכרוני. כדי להשתמש בכל שיטה של Chat API צריך אימות משתמשים (כדי לבצע פעולות או לגשת לנתונים בשם המשתמש) או אימות אפליקציות (כדי לבצע פעולות או לגשת לנתונים בתור אפליקציית Chat). חלק מהשיטות תומכות גם באימות משתמשים וגם באימות אפליקציות.
למידע נוסף על אימות ב-Chat, תוכלו לקרוא את הסקירה הכללית על אימות.
משאבים ושיטות לשימוש ב-API
המשאבים והשיטות של REST מעניקים גישה אסינכרונית למרחבים משותפים ב-Chat, משתמשים במרחב המשותף, הודעות, תגובות להודעות וקבצים מצורפים להודעות.
- מרחבים משותפים
מרחבים משותפים הם מקומות שבהם אנשים ואפליקציות יכולים לשוחח ולשתף קבצים. יש כמה סוגים של מרחבים משותפים. צ'אטים אישיים (DM) הם שיחות אישיות בין שני משתמשים או משתמש לבין אפליקציית Chat. צ'אטים קבוצתיים הם שיחות בין שלושה משתמשים או יותר לבין אפליקציות של Chat. מרחבים משותפים עם שמות הם מקומות קבועים שבהם אנשים שולחים הודעות, משתפים קבצים ועובדים יחד.
המשאב
spacesמייצג מרחב משותף.אפשר להשתמש במרחבים משותפים בדרכים הבאות:
- יוצרים מרחב משותף, שבו אנשים ואפליקציות יכולים לשוחח ולשתף קבצים.
- להגדיר מרחב משותף כדי ליצור את המרחב המשותף ולהוסיף אליו אנשים ואפליקציות של Chat.
- בחירת מרחב משותף כדי להציג את הפרטים שלו.
- הצגת רשימה של מרחבים משותפים כדי לראות רשימה של מרחבים משותפים עם עימוד.
- אפשר לעדכן את המרחב המשותף כדי לשנות את המאפיינים שלו, למשל השם המוצג, התיאור וההנחיות.
- אפשר למחוק מרחב משותף שכבר לא צריך.
- חיפוש צ'אט אישי (DM) כדי להחזיר צ'אט אישי בין שני משתמשים או צ'אט אישי בין שני משתמשים לאפליקציית הצ'אט.
- חברים
משתתפים הם משתמשים ואפליקציות ב-Chat שהצטרפו למרחב המשותף או הוזמנו אליו.
המשאב
spaces.membersמייצג חבר.חברי המועדון תומכים בשיטות הבאות:
- תוכלו ליצור מינוי כדי להוסיף משתמש או אפליקציה למרחב המשותף.
- בלחיצה על רכישת מינוי תוכלו לראות את פרטי המינוי.
- הצגת רשימה של חברויות במרחב המשותף כדי לראות את רשימת החברויות בחלוקה לפי דפים.
- אפשר לעדכן את פרטי החברות כדי לשנות את מאפייני החברות במרחב המשותף. למשל, שינוי התפקיד למנהל או שינוי המנהל של המרחב המשותף למשתמש.
- מחיקת מינוי כדי להסיר משתמש או אפליקציה ממרחב משותף.
- הודעות
הודעות כוללות טקסט וכרטיסים שמפורסמים במרחבים משותפים. אפשר לצרף קבצים להודעות. אנשים יכולים להוסיף אמוג'י כדי להגיב להודעות.
המשאב
spaces.messagesמייצג מסר.אפשר לשלוח הודעות באמצעות השיטות הבאות:
- צור הודעה כדי לפרסם הודעת טקסט או כרטיס. אפשר גם להתחיל שרשור הודעות או להשיב לו.
- קבלת הודעה כדי לקבל פרטים על הודעה מסוימת, כמו מועד שליחתה או מה שנכתב בה.
- הצגת רשימת הודעות כדי לראות רשימה של הודעות מחולקת לדפים וניתנת לסינון.
- תוכלו לעדכן הודעה כדי לשנות את המאפיינים שלה, כמו מה כתוב בה. אפשר גם לצרף טקסט להודעת כרטיס או לכרטיס להודעת טקסט.
- מחקו הודעה כשאין בה יותר צורך.
- תגובות
תגובות מייצגות את האמוג'י שאנשים משתמשים בו כדי להגיב להודעה, למשל 👍, 🚲 ו-🌞.
המשאב
spaces.messages.reactionsמייצג תגובה.אפשר להשתמש בתגובות בשיטות הבאות:
- תוכלו ליצור תגובה כדי לצרף אמוג'י להודעה.
- הצגת רשימה של תגובות כדי להציג רשימה של תגובות להודעה מחולקת, שניתן לסנן.
- מחיקת תגובה כדי להסיר אמוג'י מההודעה.
- מדיה וקבצים מצורפים
Media - קובץ שהועלה ל-Google Chat, כמו תמונות, סרטונים ומסמכים.
המשאב
mediaמייצג את המדיה שמצורפת להודעות.קבצים מצורפים הם מופעים של מדיה (קבצים) שמצורפים להודעות.
המשאב
spaces.messages.attachmentsמייצג קובץ מצורף. קובץ מצורף כולל את המדיה ואת המטא-נתונים המשויכים אליה, שמצורפים להודעה.אפשר להשתמש בשיטות הבאות במדיה ובקבצים מצורפים:
- אפשר להעלות מדיה כקובץ מצורף כדי להעלות מדיה ל-Google Chat ואז לצרף אותה להודעה.
- הורדת מדיה כקובץ מצורף כדי להוריד מדיה מ-Google Chat כקובץ בינארי.
- קבלת קובץ מצורף כדי לאחזר מטא-נתונים של קובץ מצורף של הודעה.
- אירועים בחלל
אירועים במרחב משותף מייצגים שינויים במרחב המשותף או במשאבים הצאצאים שלו, כולל המשתתפים, ההודעות והתגובות.
המשאב
spaces.spaceEventמייצג אירוע במרחב משותף.באירועי חלל אפשר להשתמש בשיטות הבאות:
- יצירת אירוע במרחב המשותף עם מידע על אירועים שקרה במרחב המשותף.
- הצגת רשימת אירועים בחלל משותף כדי לקבל את רשימת האירועים שהתרחשו במרחב המשותף.
- מצבי קריאה של משתמשים
מצבי קריאה של משתמשים הם משאבים בודדים שמייצגים פרטים על ההודעה האחרונה שנקראה על ידי משתמש במרחב משותף ב-Google Chat או בשרשור של הודעות.
המשאב
users.spacesמייצג את מצב הקריאה של משתמש במרחב משותף.המשאב
users.spaces.threadsמייצג את מצב הקריאה של משתמש בשרשור הודעות.מצבי הקריאה של המשתמשים תומכים בשיטות הבאות:
- קבלת מצב קריאה של המרחב המשותף כדי להחזיר פרטים על מצב הקריאה של המשתמש במרחב משותף.
- עדכון מצב הקריאה של המרחב המשותף כדי לעדכן את מצב הקריאה של המשתמש במרחב המשותף.
- קבלת מצב קריאת שרשור כדי להחזיר פרטים על מצב הקריאה של משתמש בתוך שרשור.