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