בקטע הזה מוסבר איך אפליקציית Google Chat יכולה להתקשר ל-Chat API, שמאפשר לאפליקציות ל-Chat לבצע פעולות כמו: ליצור מרחב, להוסיף אליו אנשים ולפרסם הודעה בלי שתתבקשו אירוע אינטראקציה של אפליקציית Chat.
אימות
כדי לשלוח קריאה ל-Chat API באופן אסינכרוני, צריך לבצע אימות. כל אחד רכיב ה-method של Chat API מחייב אימות משתמש (כדי לבצע פעולות או לגשת נתונים מטעם משתמש) או אימות אפליקציות (כדי לבצע פעולות או לגשת לנתונים בתור אפליקציית Chat). במידה מסוימת שיטות שתומכות גם באימות משתמשים וגם באימות אפליקציות.
למידע נוסף על אימות ב-Chat: סקירה כללית על אימות
משאבים ושיטות של API
משאבים ושיטות ב-REST נותנים גישה אסינכרונית ל-Chat מרחבים, משתמשים במרחב המשותף, הודעות, תגובות להודעות וקבצים מצורפים להודעות.
- מרחבים משותפים
מרחבים משותפים הם מקומות שבהם אנשים ואפליקציות יכולים לשוחח ולשתף קבצים. יש יש כמה סוגים של מרחבים. צ'אטים אישיים (DM) הם שיחות אישיות. בין שני משתמשים או משתמש ל-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מייצג את מצב הקריאה של משתמש בשרשור הודעות.מצבי הקריאה של המשתמש תומכים בשיטות הבאות:
- קבלת מצב קריאת מרחב כדי להחזיר פרטים על מצב הקריאה של המשתמש במרחב משותף.
- איך משנים את מצב הקריאה של המרחב המשותף כדי לעדכן את מצב הקריאה של המשתמש במרחב המשותף.
- קבלת מצב 'קריאת שרשור' כדי להחזיר פרטים על מצב הקריאה של משתמש בשרשור.