פיתוח אפליקציית HTTP ב-Google Chat (original) (raw)

דילוג לתוכן הראשי

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

באמצעות הארכיטקטורה הזו, אתם יכולים להגדיר את Chat כך שישתלב עם Google Cloud או עם שרת מקומי באמצעות HTTP, כמו שמוצג בתרשים הבא:

ארכיטקטורה של אפליקציית Chat שמשתמשת בשירות אינטרנט בשרת מקומי.

בתרשים שלמעלה, משתמש שמקיים אינטראקציה עם אפליקציית צ'אט HTTP, נהנה מזרימת המידע הבאה:

  1. משתמש שולח הודעה באפליקציית Chat, בצ'אט ישיר או במרחב ב-Chat.
  2. בקשת HTTP נשלחת לשרת אינטרנט שהוא מערכת בענן או מערכת מקומית שמכילה את הלוגיקה של אפליקציית Chat.
  3. אופציונלית, אפשר לשלב את הלוגיקה של אפליקציית Chat עם שירותי Google Workspace (כמו יומן ו-Sheets), עם שירותים אחרים של Google (כמו מפות Google,‏ YouTube ו-Vertex AI) או עם שירותי אינטרנט אחרים (כמו מערכת לניהול פרויקטים או כלי לניהול כרטיסי תמיכה).
  4. שרת האינטרנט שולח תגובת HTTP בחזרה לשירות של אפליקציית Chat ב-Chat.
  5. התשובה מועברת למשתמש.
  6. אופציונלית, אפליקציית הצ'אט יכולה להתקשר אל Chat API כדי לפרסם הודעות באופן אסינכרוני או לבצע פעולות אחרות.

הארכיטקטורה הזו מאפשרת לכם להשתמש בספריות ובמרכיבים קיימים שכבר נמצאים במערכת, כי אפשר לעצב את אפליקציות הצ'אט האלה באמצעות שפות תכנות שונות.

מטרות

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

הגדרת הסביבה

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

יצירה ופריסה של פונקציית Cloud Run

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

כדי ליצור ולפרוס את הפונקציה לאפליקציית Chat, פועלים לפי השלבים הבאים:

Node.js

  1. במסוף Google API, עוברים לדף Cloud Run:
    כניסה ל-Cloud Run
    מוודאים שהפרויקט של אפליקציית Chat נבחר.
  2. לוחצים על כתיבת פונקציה.
  3. בדף Create service (יצירת שירות), מגדירים את הפונקציה:
    1. בשדה שם השירות מזינים quickstartchatapp.
    2. ברשימה Region, בוחרים אזור.
    3. ברשימה Runtime (סביבת זמן ריצה), בוחרים את הגרסה העדכנית ביותר של Node.js.
    4. בקטע Authentication, בוחרים באפשרות Require authentication.
    5. לוחצים על Create (יצירה) ומחכים ש-Cloud Run ייצור את השירות. המסוף מפנה אתכם לכרטיסייה מקור.
  4. בכרטיסייה מקור:
    1. בקטע נקודת כניסה, מוחקים את טקסט ברירת המחדל ומזינים avatarApp.
    2. מחליפים את התוכן של index.js בקוד הבא:
    3. לוחצים על שמירה ופריסה מחדש.

Python

  1. במסוף Google API, עוברים לדף Cloud Run:
    כניסה ל-Cloud Run
    מוודאים שהפרויקט של אפליקציית Chat נבחר.
  2. לוחצים על כתיבת פונקציה.
  3. בדף Create service (יצירת שירות), מגדירים את הפונקציה:
    1. בשדה שם השירות מזינים quickstartchatapp.
    2. ברשימה Region, בוחרים אזור.
    3. ברשימה Runtime (סביבת זמן ריצה), בוחרים את הגרסה העדכנית ביותר של Python.
    4. בקטע Authentication, בוחרים באפשרות Require authentication.
    5. לוחצים על Create (יצירה) ומחכים ש-Cloud Run ייצור את השירות. המסוף מפנה אתכם לכרטיסייה מקור.
  4. בכרטיסייה מקור:
    1. בקטע נקודת כניסה, מוחקים את טקסט ברירת המחדל ומזינים avatar_app.
    2. מחליפים את התוכן של main.py בקוד הבא:
    3. לוחצים על שמירה ופריסה מחדש.

Java

  1. במסוף Google API, עוברים לדף Cloud Run:
    כניסה ל-Cloud Run
    מוודאים שהפרויקט של אפליקציית Chat נבחר.
  2. לוחצים על כתיבת פונקציה.
  3. בדף Create service (יצירת שירות), מגדירים את הפונקציה:
    1. בשדה שם השירות מזינים quickstartchatapp.
    2. ברשימה Region, בוחרים אזור.
    3. ברשימה Runtime בוחרים בגרסה העדכנית ביותר של Java.
    4. בקטע Authentication, בוחרים באפשרות Require authentication.
    5. לוחצים על Create (יצירה) ומחכים ש-Cloud Run ייצור את השירות. המסוף מפנה אתכם לכרטיסייה מקור.
  4. בכרטיסייה מקור:
    1. בקטע נקודת כניסה, מוחקים את טקסט ברירת המחדל ומזינים App.
    2. שינוי השם של src/main/java/com/example/Example.java ל-src/main/java/AvatarApp.java.
    3. מחליפים את התוכן של AvatarApp.java בקוד הבא:
    4. מחליפים את התוכן של pom.xml בקוד הבא:
    5. לוחצים על שמירה ופריסה מחדש.

כדי לתת ל-Google Chat הרשאה להפעיל את הפונקציה, צריך להוסיף את חשבון השירות של Google Chat עם התפקיד Cloud Run Invoker.

  1. במסוף Google API, עוברים לדף Cloud Run:
    כניסה ל-Cloud Run
  2. ברשימת שירותי Cloud Run, מסמנים את התיבה לצד הפונקציה המקבלת. (לא לוחצים על הפונקציה עצמה).
  3. לוחצים על הרשאות. נפתחת החלונית הרשאות.
  4. לוחצים על Add principal.
  5. בשדה New principals, מזינים chat@system.gserviceaccount.com.
  6. ברשימת התפקידים Select a role בוחרים באפשרות Cloud Run > Cloud Run Invoker.
  7. לוחצים על שמירה.

הגדרת אפליקציית Chat

אחרי שפורסים את פונקציית Cloud Run, פועלים לפי השלבים הבאים כדי להפוך אותה לאפליקציית Google Chat:

  1. במסוף Google API, עוברים לדף Cloud Run:
    כניסה ל-Cloud Run
    מוודאים שהפרויקט שבו הפעלתם את Cloud Run נבחר.
  2. ברשימת השירותים, לוחצים על quickstartchatapp.
  3. בדף פרטי השירות, מעתיקים את כתובת ה-URL של הפונקציה.
  4. מחפשים את Google Chat API, לוחצים על Google Chat API ואז על ניהול.
    ל-Chat API
  5. לוחצים על הגדרה ומגדירים את אפליקציית Google Chat:
    1. מבטלים את הסימון של Build this Chat app as a Google Workspace add-on (פיתוח אפליקציית Chat כתוסף ל-Google Workspace). תיפתח תיבת דו-שיח שבה תתבקשו לאשר את הפעולה. בתיבת הדו-שיח, לוחצים על השבתה.
    2. בשדה App name, מזינים Quickstart App.
    3. בקטע כתובת ה-URL של הדמות, מזינים את הערך https://developers.google.com/chat/images/quickstart-app-avatar.png.
    4. בשדה תיאור, מזינים Quickstart app.
    5. בקטע פונקציונליות, בוחרים באפשרות הצטרפות למרחבים ולשיחות קבוצתיות.
    6. בקטע Connection settings (הגדרות חיבור), בוחרים באפשרות HTTP endpoint URL (כתובת URL של נקודת קצה בפרוטוקול HTTP).
    7. בקטע Triggers (טריגרים), בוחרים באפשרות Use a common HTTP endpoint URL for all triggers (שימוש בכתובת URL משותפת של נקודת קצה מסוג HTTP לכל הטריגרים) ומדביקים את כתובת ה-URL של הטריגר של פונקציית Cloud Run בתיבה.
    8. בקטע Visibility (חשיפה), בוחרים באפשרות Make this Chat app available to specific people and groups (הפיכת אפליקציית Chat הזו לזמינה לאנשים ולקבוצות ספציפיים) בדומיין ומזינים את כתובת האימייל.
    9. בקטע יומנים, בוחרים באפשרות רישום שגיאות ביומן.
  6. לוחצים על שמירה.

אפליקציית Chat מוכנה לקבל הודעות ב-Chat ולענות להן.

בדיקת אפליקציית Chat

כדי לבדוק את אפליקציית Chat, פותחים מרחב לצ'אט ישיר עם אפליקציית Chat ושולחים הודעה:

  1. פותחים את Google Chat באמצעות חשבון Google Workspace שציינתם כשנוספתם כבודקים מהימנים.
    מעבר אל Google Chat
  2. לוחצים על צ'אט חדש.
  3. בשדה הוספת אדם אחד או יותר, מקלידים את השם של אפליקציית Chat.
  4. בוחרים את אפליקציית Chat מתוך התוצאות. ייפתח צ'אט ישיר.
  5. בצ'אט הישיר החדש עם האפליקציה, כותבים Hello ולוחצים עלenter.

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

אפליקציית Chat מגיבה בכרטיס עם השם המוצג ותמונת האווטאר של השולח

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

פתרון בעיות

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

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

הסרת המשאבים

כדי להימנע מחיובים בחשבון Google Cloud בגלל השימוש במשאבים שנעשה במסגרת המדריך הזה, מומלץ למחוק את פרויקט Cloud.

  1. במסוף Google API, עוברים לדף Manage resources. לוחצים עלתפריט > IAM & Admin > Manage Resources.
    כניסה ל-מנהל המשאבים
  2. ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על Delete .
  3. כדי למחוק את הפרויקט, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down.

אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers‏.‏ Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.

עדכון אחרון: 2026-04-01 (שעון UTC).