שירות Advanced Chat מאפשר לכם להשתמש ב-Google Chat API ב-Apps Script. ה-API הזה מאפשר לסקריפטים למצוא, ליצור ולשנות מרחבים ב-Chat, לצרף אנשים למרחבים או להסיר אותם מהם, ולקרוא או לפרסם הודעות עם טקסט, כרטיסים, קבצים מצורפים ותגובות.
דרישות מוקדמות
- אפליקציית Google Chat ב-Apps Script שהוגדרה בדף ההגדרות של Chat API במסוף Google Cloud. בפרויקט Apps Script של האפליקציה צריך להשתמש בפרויקט Google Cloud רגיל במקום בפרויקט ברירת המחדל שנוצר אוטומטית לפרויקטים של Apps Script. כדי ליצור אפליקציה תואמת ל-Google Chat, אפשר לעיין במאמר בנושא יצירת אפליקציה ל-Google Chat באמצעות Google Apps Script.
- האימות מוגדר לאפליקציית Chat. כדי לבצע פעולה בשם משתמש נדרש אימות משתמש. כדי לבצע פעולה כאפליקציית Chat, צריך לאמת את האפליקציה באמצעות חשבון שירות. כדי לבדוק באיזה סוג אימות תומכת שיטה של Chat API, אפשר לעיין במאמר סוגי האימות הנדרשים לקריאות ל-Google Chat API.
חומרי עזר
מידע נוסף על השירות הזה זמין במאמרי העזרה של Chat API. בדומה לכל השירותים המתקדמים ב-Apps Script, שירות Chat משתמש באותם אובייקטים, שיטות ופרמטרים כמו ה-API הציבורי.
קוד לדוגמה
בדוגמאות האלה מוצגות דרכים לביצוע פעולות נפוצות ב-Google Chat API באמצעות השירות המתקדם.
פרסום הודעה עם פרטי כניסה של משתמש
בדוגמה הבאה אפשר לראות איך מפרסמים הודעה במרחב ב-Chat בשם המשתמש.
מוסיפים את היקף ההרשאות
chat.messages.create
לקובץappsscript.json
של פרויקט Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages.create" ]
מוסיפים פונקציה כמו זו לקוד של פרויקט Apps Script:
פרסום הודעה עם פרטי הכניסה של האפליקציה
בדוגמה הבאה מוסבר איך לפרסם הודעה במרחב ב-Chat בשם האפליקציה. כשמשתמשים בשירות המתקדם של Chat עם חשבון שירות, לא צריך לציין היקפי הרשאה ב-appsscript.json
. לפרטים על אימות באמצעות חשבונות שירות, ראו אימות כאפליקציית Google Chat.
איך יוצרים מרחבים
בדוגמה הבאה מוסבר איך לקבל מידע על מרחב ב-Chat.
מוסיפים את היקף ההרשאות
chat.spaces.readonly
לקובץappsscript.json
של פרויקט Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.spaces.readonly" ]
מוסיפים פונקציה כמו זו לקוד של פרויקט Apps Script:
יצירת מרחב
בדוגמה הבאה מוסבר איך ליצור מרחב ב-Chat.
מוסיפים את היקף ההרשאות
chat.spaces.create
לקובץappsscript.json
של פרויקט Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.spaces.create" ]
מוסיפים פונקציה כמו זו לקוד של פרויקט Apps Script:
הצגת רשימת המינויים
בדוגמה הבאה מוסבר איך מציגים את כל המשתתפים במרחב ב-Chat.
מוסיפים את היקף ההרשאות
chat.memberships.readonly
לקובץappsscript.json
של פרויקט Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.memberships.readonly" ]
מוסיפים פונקציה כמו זו לקוד של פרויקט Apps Script:
פתרון בעיות
אם מופיעה השגיאה Error 400: invalid_scope
עם הודעת השגיאה
Some requested scopes cannot be shown
,
זה אומר שלא ציינתם היקפי הרשאות בקובץ appsscript.json
של פרויקט Apps Script. ברוב המקרים, Apps Script קובע באופן אוטומטי את ההיקפים שנדרשים לסקריפט, אבל כשמשתמשים בשירות המתקדם של Chat, צריך להוסיף באופן ידני את היקפי ההרשאות שהסקריפט משתמש בהם לקובץ המניפסט של פרויקט Apps Script. מידע נוסף על הגדרת היקפים מפורשים
כדי לפתור את השגיאה, צריך להוסיף את היקפי ההרשאה המתאימים לקובץ appsscript.json
של פרויקט Apps Script כחלק מהמערך oauthScopes
. לדוגמה, כדי להפעיל את השיטה spaces.messages.create
, מוסיפים את הפרטים הבאים:
"oauthScopes": [
"https://www.googleapis.com/auth/chat.messages.create"
]
מגבלות ושיקולים
שירות הצ'אט המתקדם לא תומך ב:
- השיטה של Chat API:
media.download
. - שיטות Chat API שזמינות בתצוגה מקדימה למפתחים
כדי להוריד קובץ מצורף להודעה או להתקשר לשיטה של גרסת טרום-השקה למפתחים, צריך להשתמש ב-UrlFetchApp
.