הגדרת Google Chat API

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    מעבר לדף ההגדרה של Chat API

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

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

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

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

איך נותנים לאנשים אחרים הרשאה להגדיר את Chat API

אתם יכולים לתת למשתמשים ספציפיים גישה לדף ההגדרות של אפליקציות ל-Chat על ידי הקצאת תפקיד בממשק לניהול זהויות והרשאות גישה (IAM) ב-Google Cloud: בעלים של אפליקציות ל-Chat או צפייה באפליקציות ל-Chat. משתמשים שהתפקידים האלה הוקצו להם לא יכולים לעבור לדף ההגדרות של אפליקציות ל-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.