בדף הזה מוסבר איך יוצרים אפליקציית Chat באמצעות Pub/Sub הסוג הזה של ל-Chat היא שימושית אם לארגון שלך יש חומת אש, שעלולה למנוע מ-Chat לשלוח הודעות לאפליקציית Chat. אפליקציית Chat משתמשת Google Workspace Event API אבל יש את המגבלות הבאות, אפליקציות צ'אט יכולות רק לשלוח ולקבל הודעות אסינכרוניות:
- לא ניתן להשתמש בתיבות דו-שיח בהודעות. במקום זאת, השתמשו הודעה בכרטיס.
- לא ניתן לעדכן כרטיסים בודדים עם תגובה מסונכרנת. במקום זאת, צריך לעדכן
את ההודעה כולה באמצעות קריאה
patch
.
בתרשים הבא מוצגת הארכיטקטורה של אפליקציית Chat שנוצרה באמצעות Pub/Sub:
בתרשים הקודם, משתמש יוצר אינטראקציה עם Pub/Sub אפליקציית Chat כוללת את הפרטים הבאים:
משתמש שולח הודעה ב-Chat אל אפליקציית Chat, בצ'אט אישי או מרחב ב-Chat או אירוע שמתרחש במרחב משותף ב-Chat שבאפליקציית Chat יש אפליקציות פעילות מינוי.
ההודעה נשלחת מ-Chat לנושא Pub/Sub.
שרת אפליקציות, שהוא מערכת ענן או מערכת מקומית מכיל את הלוגיקה של אפליקציית Chat, נרשם נושא Pub/Sub כדי לקבל את ההודעה דרך חומת האש.
(אופציונלי) אפליקציית Chat יכולה לקרוא Chat API כדי לפרסם הודעות באופן אסינכרוני או לבצע ב-AI.
דרישות מוקדמות
Java
- עסק או ארגון חשבון Google Workspace עם גישה אל Google Chat.
- פרויקט ב-Google Cloud שמופעל בו חיוב. כדי לבדוק אם החיוב מופעל בפרויקט קיים: ראה אימות סטטוס החיוב של הפרויקטים שלכם. כדי ליצור פרויקט ולהגדיר חיוב: יוצרים פרויקט ב-Google Cloud.
- Java 11 ואילך
- הכלי לניהול חבילות של Maven
Python
- עסק או ארגון חשבון Google Workspace עם גישה אל Google Chat.
- פרויקט ב-Google Cloud שמופעל בו חיוב. כדי לבדוק אם החיוב מופעל בפרויקט קיים: ראה אימות סטטוס החיוב של הפרויקטים שלכם. כדי ליצור פרויקט ולהגדיר חיוב: יוצרים פרויקט ב-Google Cloud.
- Python 3.6 ומעלה
- הכלי לניהול חבילות pip
Node.js
- עסק או ארגון חשבון Google Workspace עם גישה אל Google Chat.
- פרויקט ב-Google Cloud שמופעל בו חיוב. כדי לבדוק אם החיוב מופעל בפרויקט קיים: ראה אימות סטטוס החיוב של הפרויקטים שלכם. כדי ליצור פרויקט ולהגדיר חיוב: יוצרים פרויקט ב-Google Cloud.
- Node.js 14 ומעלה
- ה-npm כלי לניהול חבילות
-
פרויקט Node.js מאותחל. כדי לאתחל פרויקט חדש, צריך ליצור
לעבור לתיקייה חדשה ואז להריץ את הפקודה הבאה בממשק שורת הפקודה:
npm init
הגדרת הסביבה
לפני שמשתמשים ב-Google APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.במסוף Google Cloud, מפעילים את Google Chat API ואת Pub/Sub API.
הגדרת Pub/Sub
יצירת נושא Pub/Sub שה-API של Chat יכול לשלוח אליו הודעות. מומלץ להשתמש נושא אחד לכל אפליקציית Chat.
איך מעניקים הרשאה לפרסום ב-Chat לנושא על ידי הקצאה של התפקיד פרסום הודעות ב-Pub/Sub לתפקיד הבא חשבון שירות:
chat-api-push@system.gserviceaccount.com
יצירה של חשבון שירות שאפליקציית Chat תאשר בעזרת Pub/Sub מדברים בצ'אט ושומרים את קובץ המפתח הפרטי בספריית העבודה.
יצירת מינוי pull לנושא.
הקצאת התפקיד מנוי ב-Pub/Sub במינוי לחשבון השירות שיצרתם קודם.
כתיבת התסריט
Java
ב-CLI, מספקים פרטי כניסה לחשבון שירות:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
ב-CLI, מציינים את מזהה הפרויקט ב-Google Cloud:
export PROJECT_ID=PROJECT_ID
ב-CLI, צריך לציין את מזהה המינוי של מינוי Pub/Sub ש יצרת בעבר:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
בספריית העבודה, יוצרים קובץ בשם
pom.xml
.בקובץ
pom.xml
, מדביקים את הקוד הבא:בספריית העבודה, יוצרים את מבנה הספרייה
src/main/java
.בספרייה
src/main/java
, יוצרים קובץ בשםMain.java
.ב-
Main.java
, מדביקים את הקוד הבא:
Python
ב-CLI, מספקים פרטי כניסה לחשבון שירות:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
ב-CLI, מציינים את מזהה הפרויקט ב-Google Cloud:
export PROJECT_ID=PROJECT_ID
ב-CLI, צריך לציין את מזהה המינוי של מינוי Pub/Sub ש יצרת בעבר:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
בספריית העבודה, יוצרים קובץ בשם
requirements.txt
.בקובץ
requirements.txt
, מדביקים את הקוד הבא:בספריית העבודה, יוצרים קובץ בשם
app.py
.ב-
app.py
, מדביקים את הקוד הבא:
Node.js
ב-CLI, מספקים פרטי כניסה לחשבון שירות:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
ב-CLI, מציינים את מזהה הפרויקט ב-Google Cloud:
export PROJECT_ID=PROJECT_ID
ב-CLI, צריך לציין את מזהה המינוי של מינוי Pub/Sub ש יצרת בעבר:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
בספריית העבודה, יוצרים קובץ בשם
package.json
.בקובץ
package.json
, מדביקים את הקוד הבא:בספריית העבודה, יוצרים קובץ בשם
index.js
.ב-
index.js
, מדביקים את הקוד הבא:
פרסום האפליקציה ב-Chat
במסוף Google Cloud, נכנסים אל תפריט > ממשקי API Services (שירותים) > ממשקי API מופעלים ו Services (שירותים) > Google Chat API > הגדרה.
מגדירים את אפליקציית Chat ל-Pub/Sub:
- בשדה App name, מזינים
Quickstart App
. - בשדה כתובת URL של הדמות, מזינים
https://developers.google.com/chat/images/quickstart-app-avatar.png
. - בשדה Description, מזינים
Quickstart app
. - בקטע פונקציונליות, בוחרים באפשרות קבלת הודעות אישיות והצטרפות למרחבים משותפים ולשיחות קבוצתיות.
- בקטע Connection settings (הגדרות חיבור), בוחרים באפשרות Cloud Pub/Sub ומדביקים את שם נושא ה-Pub/Sub שיצרתם קודם.
- בקטע חשיפה, בוחרים באפשרות הפיכת האפליקציה הזו ל-Google Chat זמינה לאנשים ולקבוצות ספציפיים בדומיין ומזינים את כתובת האימייל שלכם.
- בקטע Logs (יומנים), בוחרים באפשרות Log errors to Logging (רישום שגיאות ביומן).
- בשדה App name, מזינים
לוחצים על שמירה.
האפליקציה מוכנה לקבל הודעות ב-Chat ולענות להן.
מריצים את הסקריפט
ב-CLI, עוברים לספריית העבודה ומריצים את הסקריפט:
Java
mvn compile exec:java -Dexec.mainClass=Main
Python
python -m venv env
source env/bin/activate
pip install -r requirements.txt -U
python app.py
Node.js
npm install
npm start
כשמריצים את הקוד, האפליקציה מתחילה להאזין להודעות שפורסמו לנושא Pub/Sub.
בדיקת האפליקציה של Chat
כדי לבדוק את אפליקציית Chat, צריך לפתוח מרחב בצ'אט אישי עם אפליקציית Chat ושולחים הודעה:
פותחים את Google Chat באמצעות חשבון Google Workspace שבו אתם משתמשים. שקיבלת כשהוספת את עצמך כבודק נאמן.
- לוחצים על צ'אט חדש.
- בשדה אפשר לצרף אנשים, מקלידים את השם של מי שרוצים לצרף אפליקציית Chat.
בוחרים את אפליקציית Chat הרצויה מהתוצאות. A ההודעה תיפתח.
- בצ'אט האישי החדש עם האפליקציה, מקלידים
Hello
ומקישים עלenter
.
כדי להוסיף בודקים נאמנים ולקבל מידע נוסף על בדיקת תכונות אינטראקטיביות: בדיקת תכונות אינטראקטיביות עבור אפליקציות ב-Google Chat.
פתרון בעיות
כשאפליקציית Google Chat או אפליקציית Google Chat הפונקציה card מחזירה שגיאה, בממשק של Chat מוצגת ההודעה "משהו השתבש". או "לא ניתן לעבד את הבקשה שלך". לפעמים בממשק המשתמש של Chat לא מציגה הודעות שגיאה, אבל אפליקציית Chat או והכרטיס מפיק תוצאה לא צפויה: לדוגמה, הודעה בכרטיס יופיעו.
יכול להיות שלא תופיע הודעת שגיאה בממשק המשתמש של Chat, אבל יש הודעות שגיאה תיאוריות ונתוני יומן זמינים כדי לעזור לכם לתקן שגיאות כשמופעלת רישום שגיאות ביומן של אפליקציות ל-Chat. לקבלת עזרה בצפייה, לניפוי באגים ולתיקון שגיאות: פתרון בעיות ותיקון שגיאות ב-Google Chat
הסרת המשאבים
כדי להימנע מצבירת חיובים בחשבון Google Cloud עבור במשאבים שנעשה בהם שימוש במדריך הזה, מומלץ למחוק את פרויקט בענן.
- במסוף Google Cloud, עוברים לדף Manage resources. לוחצים על תפריט > IAM & Admin (אדמין) > לניהול משאבים
- ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על הסמל. מחיקה של .
- כדי למחוק, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down. את הפרויקט.
נושאים קשורים
כדי להוסיף עוד פיצ'רים לאפליקציית Chat, כדאי לבדוק את הבאים: