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