הגדרת Google Chat API

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

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

איך בוחרים שם מוצג, דמות ותיאור באפליקציית Chat

כשמפעילים את Chat API, אפשר להגדיר את הפרטים של אפליקציית Chat שיוצגו למשתמשים ב-Chat, כולל שם מוצג, תמונת פרופיל ותיאור. הפרטים האלה מופיעים רק ב-Chat. כדי לפרסם את אפליקציית Chat ב-Marketplace, צריך גם לציין את הפרטים שיופיעו בדף האפליקציה ב-Marketplace.

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

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

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

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

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

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

  • כדי להפעיל את אפליקציית Chat, כותבים את שם האפליקציה עם סימן @.
  • מחפשים את האפליקציה של Chat ומתחילים צ'אט אישי. בתפריט Apps (אפליקציות), הצ'אטים האישיים מוצגים עם השם והסמל של אפליקציית Chat.
  • בסרגל הכתיבה, המשתמשים יכולים לעיין באפליקציות של Chat ולראות את השם, הדמות והתיאור שלהם.

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

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

  1. נכנסים לדף Chat API במסוף Google Cloud ולוחצים על הדף Configuration:

    כניסה לדף ההגדרות של Chat API

  2. בקטע Application info (פרטי האפליקציה), ממלאים את השדות App name (שם האפליקציה), Avatar URL (כתובת ה-URL של הדמות) ו-Description (תיאור).

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

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

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

מתן הרשאה לאנשים אחרים להגדיר את Chat API

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

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

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