הגדרת Google Chat API

לכל אפליקציית Google Chat שיוצרים צריך משלה פרויקט ב-Google Cloud עם Chat API מופעל ומוגדר. הדף הזה מראים איך להגדיר את Chat API.

דרישות מוקדמות

כאן בוחרים שם לתצוגה, דמות ותיאור לאפליקציית Chat.

כדי לשלוח קריאה ל-Chat API, צריך להגדיר אפליקציית Google Chat עם הפרטים הבאים:

שדה תיאור פורמט
שם האפליקציה השם המוצג של אפליקציית Chat. עד 25 תווים אלפאנומריים
כתובת ה-URL של הדמות התמונה שמוצגת בתור אפליקציית Chat הדמות. כתובת URL מסוג HTTPS שמפנה לתמונה גרפית ריבועית (PNG או JPEG). הגודל המומלץ הוא 256 על 256 פיקסלים או יותר.
תיאור תיאור קצר שהמטרה של אפליקציית Chat. עד 40 תווים אלפאנומריים

השם, הדמות והתיאור של אפליקציית Chat. שמוצגות למשתמשים בממשק המשתמש של Chat. בחלק מה-Chat API של בקשות כתיבה, Chat משתמש במידע הזה כדי לשייך הפעולות שאפליקציית Chat מבצעת ב-Chat.

לדוגמה, אם קוראים ל-method spaces.create(), Chat כולל את השם של אפליקציית Chat תיאור של מי שיצר את המרחב המשותף, כפי שמוצג בתמונה הבאה:

אפליקציית Google Chat יוצרת מרחב למשתמש.
איור 1. הודעת השיוך (Attribution) ב-Chat מוצגת כשה-method spaces.create() משמשת ליצירת מרחב בשם משתמש.

למשתמשים ב-Chat יש אפשרות גם לראות את האפליקציה הזו או להשתמש בה את המידע בדרכים הבאות:

  • כדי להפעיל את אפליקציית Chat, אפשר להזכיר את השם שלה באמצעות @.
  • מוצאים ומתחילים צ'אט אישי עם אפליקציית Chat. בתפריט אפליקציות, הצ'אטים האישיים מוצגים. השם והדמות של אפליקציית Chat.
  • בשורת הכתיבה, המשתמשים יכולים לדפדף באפליקציות של Chat ולראות את השם, הדמות והתיאור שלהם.

איך מגדירים את אפליקציית Chat במסוף Google Cloud

אחרי שמקבלים את הפרטים של אפליקציית Chat, פותחים את פרויקט בענן ומגדירים את ה-API ל-Chat:

  1. במסוף Google Cloud, נכנסים לדף של Chat API ולוחצים על דף הגדרות אישיות:

    לדף ההגדרה של Chat API

  2. בקטע פרטי האפליקציה, ממלאים את הפרטים הבאים: שם האפליקציה, כתובת ה-URL של הדמות. ותיאור.

  3. בקטע 'תכונות אינטראקטיביות', לוחצים על המתג הפעלת תכונות אינטראקטיביות. למצב מושבת כדי להשבית תכונות אינטראקטיביות אפליקציית Chat. אפשר להגדיר זאת מאוחר יותר. כדי ללמוד על הגדרה ופיתוח של תכונות אינטראקטיביות, לקבל אינטראקציות של משתמשים ולהגיב להן

  4. אופציונלי: בקטע Logs (יומנים), מסמנים את התיבה Log errors to Logging כדי להשתמש ב-Google Cloud Logging. מידע נוסף זמין במאמר הבא: שאילתות על יומני שגיאה של אפליקציות ל-Chat.

  5. לוחצים על שמירה.

איך נותנים לאנשים אחרים הרשאה להגדיר אפליקציות ל-Chat

אפשר הענקת גישה למשתמשים מסוימים לדף ההגדרה של אפליקציית Chat. משתמשים ב IAM של בעלים של אפליקציות צ'אט וצפייה באפליקציות צ'אט תפקידים. משתמשים עם התפקידים האלה לא יכולים להיכנס לאפליקציות ל-Chat דף תצורה באמצעות הממשקי API את מרכז הבקרה של השירותים, אבל נכנסים לדף ההגדרות האישיות על ידי מעבר למסוף Google Cloud, הפרויקט בענן שמארח את אפליקציית Chat:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

כאשר PROJECT_ID הוא מזהה הפרויקט פרויקט ב-Google Cloud שמתארח באפליקציית Chat.