פיתוח אפליקציית HTTP ב-Google Chat

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

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

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

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

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

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

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

מטרות

  • מגדירים את הסביבה.
  • יצירה ופריסה של פונקציה ב-Cloud Functions.
  • מגדירים תוסף של Google Workspace לאפליקציית Chat.
  • בודקים את האפליקציה.

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

הגדרת הסביבה

לפני שמשתמשים ב-Google APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.
  • במסוף Google Cloud, מפעילים את Google Chat API,‏ Cloud Build API,‏ Cloud Functions API,‏ Cloud Pub/Sub API,‏ Cloud Logging API,‏ Artifact Registry API ו-Cloud Run API.

    הפעלת ממשקי ה-API

יצירה ופריסה של פונקציה ב-Cloud Functions

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

כדי ליצור ולפרוס את הפונקציה לאפליקציית Chat:

Node.js

  1. נכנסים לדף Cloud Functions במסוף Google Cloud:

    כניסה לדף Cloud Functions

    מוודאים שבחרתם את הפרויקט של אפליקציית Chat.

  2. לוחצים על Create Function.

  3. בדף Create function, מגדירים את הפונקציה:

    1. בקטע Environment, בוחרים באפשרות Cloud Run Function.
    2. בשדה Function name, מזינים AddOnChatApp.
    3. בקטע אזור, בוחרים אזור.
    4. בקטע 'אימות', בוחרים באפשרות דרישת אימות.
    5. לוחצים על הבא.
  4. בקטע Runtime, בוחרים את הגרסה האחרונה של Node.js.

  5. בקטע קוד מקור, בוחרים באפשרות עורך בשורה.

  6. בקטע Entry point (נקודת כניסה), מוחקים את טקסט ברירת המחדל ומזינים avatarApp.

  7. מחליפים את התוכן של index.js בקוד הבא:

    /**
     * Google Cloud Function that responds to messages sent from a
     * Google Chat space.
     *
     * @param {Object} req Request sent from Google Chat space
     * @param {Object} res Response to send back
     */
    exports.avatarApp = function avatarApp(req, res) {
        if (req.method === 'GET' || !req.body.chat) {
            return res.send('Hello! This function is meant to be used ' +
                'in a Google Chat Space.');
        }
    
        // Stores the Google Chat event as a variable.
        const chatMessage = req.body.chat.messagePayload.message;
    
        // Replies with the sender's avatar in a card.
        const displayName = chatMessage.sender.displayName;
        const avatarUrl = chatMessage.sender.avatarUrl;
        res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
            text: 'Here\'s your avatar',
            cardsV2: [{
                cardId: 'avatarCard',
                card: {
                    name: 'Avatar Card',
                    header: {
                        title: `Hello ${displayName}!`,
                    },
                    sections: [{
                        widgets: [{
                            textParagraph: { text: 'Your avatar picture: ' }
                        }, {
                            image: { imageUrl: avatarUrl }
                        }]
                    }]
                }
            }]
        }}}}});
    };
    
  8. לוחצים על פריסת.

Python

  1. נכנסים לדף Cloud Functions במסוף Google Cloud:

    כניסה לדף Cloud Functions

    מוודאים שבחרתם את הפרויקט של אפליקציית Chat.

  2. לוחצים על Create Function.

  3. בדף Create function, מגדירים את הפונקציה:

    1. בקטע Environment, בוחרים באפשרות Cloud Run Function.
    2. בשדה Function name, מזינים AddOnChatApp.
    3. בקטע אזור, בוחרים אזור.
    4. בקטע 'אימות', בוחרים באפשרות דרישת אימות.
    5. לוחצים על הבא.
  4. בקטע Runtime, בוחרים את הגרסה האחרונה של Python.

  5. בקטע קוד מקור, בוחרים באפשרות עורך בשורה.

  6. בקטע Entry point (נקודת כניסה), מוחקים את טקסט ברירת המחדל ומזינים avatar_app.

  7. מחליפים את התוכן של main.py בקוד הבא:

    from typing import Any, Mapping
    
    import flask
    import functions_framework
    
    @functions_framework.http
    def avatar_app(req: flask.Request) -> Mapping[str, Any]:
        """Google Cloud Function that handles requests from Google Chat
    
        Args:
            flask.Request: the request
    
        Returns:
            Mapping[str, Any]: the response
        """
        if req.method == "GET":
            return "Hello! This function must be called from Google Chat."
    
        request_json = req.get_json(silent=True)
    
        # Stores the Google Chat event as a variable.
        chat_message = request_json["chat"]["messagePayload"]["message"]
    
        # Replies with the sender's avatar in a card.
        display_name = chat_message["sender"]["displayName"]
        avatar_url = chat_message["sender"]["avatarUrl"]
        return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": { "message": {
            "text": "Here's your avatar",
            "cardsV2": [{
                "cardId": "avatarCard",
                "card": {
                    "name": "Avatar Card",
                    "header": { "title": f"Hello {display_name}!" },
                    "sections": [{
                        "widgets": [{
                            "textParagraph": { "text": "Your avatar picture:" }
                        }, {
                            "image": { "imageUrl": avatar_url }
                        }]
                    }]
                }
            }]
        }}}}}
    
  8. לוחצים על פריסת.

Java

  1. נכנסים לדף Cloud Functions במסוף Google Cloud:

    כניסה לדף Cloud Functions

    מוודאים שבחרתם את הפרויקט של אפליקציית Chat.

  2. לוחצים על Create Function.

  3. בדף Create function, מגדירים את הפונקציה:

    1. בקטע Environment, בוחרים באפשרות Cloud Run Function.
    2. בשדה Function name, מזינים AddOnChatApp.
    3. בקטע אזור, בוחרים אזור.
    4. בקטע 'אימות', בוחרים באפשרות דרישת אימות.
    5. לוחצים על הבא.
  4. בקטע Runtime, בוחרים את הגרסה האחרונה של Java.

  5. בקטע קוד מקור, בוחרים באפשרות עורך בשורה.

  6. בקטע Entry point (נקודת כניסה), מוחקים את טקסט ברירת המחדל ומזינים AvatarApp.

  7. משנים את שם קובץ ברירת המחדל של Java ל-src/main/java/AvatarApp.java.

  8. מחליפים את התוכן של AvatarApp.java בקוד הבא:

    import java.util.List;
    
    import com.google.api.services.chat.v1.model.CardWithId;
    import com.google.api.services.chat.v1.model.GoogleAppsCardV1Card;
    import com.google.api.services.chat.v1.model.GoogleAppsCardV1CardHeader;
    import com.google.api.services.chat.v1.model.GoogleAppsCardV1Image;
    import com.google.api.services.chat.v1.model.GoogleAppsCardV1Section;
    import com.google.api.services.chat.v1.model.GoogleAppsCardV1TextParagraph;
    import com.google.api.services.chat.v1.model.GoogleAppsCardV1Widget;
    import com.google.api.services.chat.v1.model.Message;
    import com.google.cloud.functions.HttpFunction;
    import com.google.cloud.functions.HttpRequest;
    import com.google.cloud.functions.HttpResponse;
    import com.google.gson.Gson;
    import com.google.gson.JsonObject;
    
    public class AvatarApp implements HttpFunction {
        private static final Gson gson = new Gson();
    
        @Override
        public void service(HttpRequest request, HttpResponse response) throws Exception {
            JsonObject body = gson.fromJson(request.getReader(), JsonObject.class);
            if (request.getMethod().equals("GET") || !body.has("chat")) {
                response.getWriter().write("Hello! This function is meant to be used " +
                    "in a Google Chat Space..");
                return;
            }
    
            // Stores the Google Chat event as a variable.
            JsonObject chatMessage = body.getAsJsonObject("chat")
                .getAsJsonObject("messagePayload").getAsJsonObject("message");
    
            // Replies with the sender's avatar in a card.
            String displayName = chatMessage.getAsJsonObject("sender").get("displayName").getAsString();
            String avatarUrl = chatMessage.getAsJsonObject("sender").get("avatarUrl").getAsString();
            Message message = createMessage(displayName, avatarUrl);
    
            JsonObject createMessageAction = new JsonObject();
            createMessageAction.add("message", gson.fromJson(gson.toJson(message), JsonObject.class));
    
            JsonObject chatDataAction = new JsonObject();
            chatDataAction.add("createMessageAction", createMessageAction);
    
            JsonObject hostAppDataAction = new JsonObject();
            hostAppDataAction.add("chatDataAction", chatDataAction);
    
            JsonObject dataActions = new JsonObject();
            dataActions.add("hostAppDataAction", hostAppDataAction);
            response.getWriter().write(gson.toJson(dataActions));
        }
    
        Message createMessage(String displayName, String avatarUrl) {
            GoogleAppsCardV1CardHeader cardHeader = new GoogleAppsCardV1CardHeader();
            cardHeader.setTitle(String.format("Hello %s!", displayName));
    
            GoogleAppsCardV1TextParagraph textParagraph = new GoogleAppsCardV1TextParagraph();
            textParagraph.setText("Your avatar picture: ");
    
            GoogleAppsCardV1Widget avatarWidget = new GoogleAppsCardV1Widget();
            avatarWidget.setTextParagraph(textParagraph);
    
            GoogleAppsCardV1Image image = new GoogleAppsCardV1Image();
            image.setImageUrl(avatarUrl);
    
            GoogleAppsCardV1Widget avatarImageWidget = new GoogleAppsCardV1Widget();
            avatarImageWidget.setImage(image);
    
            GoogleAppsCardV1Section section = new GoogleAppsCardV1Section();
            section.setWidgets(List.of(avatarWidget, avatarImageWidget));
    
            GoogleAppsCardV1Card card = new GoogleAppsCardV1Card();
            card.setName("Avatar Card");
            card.setHeader(cardHeader);
            card.setSections(List.of(section));
    
            CardWithId cardWithId = new CardWithId();
            cardWithId.setCardId("avatarCard");
            cardWithId.setCard(card);
    
            Message message = new Message();
            message.setText("Here's your avatar");
            message.setCardsV2(List.of(cardWithId));
    
            return message;
        }
    }
    
  9. מחליפים את התוכן של pom.xml בקוד הבא:

    <project xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.google.chat</groupId>
        <artifactId>avatar-app</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <properties>
            <maven.compiler.target>17</maven.compiler.target>
            <maven.compiler.source>17</maven.compiler.source>
        </properties>
    
        <dependencies>
            <dependency>
            <groupId>com.google.cloud.functions</groupId>
            <artifactId>functions-framework-api</artifactId>
            <version>1.0.4</version>
            </dependency>
    
            <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
            <dependency>
                <groupId>com.google.code.gson</groupId>
                <artifactId>gson</artifactId>
                <version>2.9.1</version>
            </dependency>
    
            <!-- https://mvnrepository.com/artifact/com.google.apis/google-api-services-chat -->
            <dependency>
                <groupId>com.google.apis</groupId>
                <artifactId>google-api-services-chat</artifactId>
                <version>v1-rev20230115-2.0.0</version>
            </dependency>
        </dependencies>
    
        <!-- Required for Java functions in the inline editor -->
        <build>
            <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                <excludes>
                    <exclude>.google/</exclude>
                </excludes>
                </configuration>
            </plugin>
            </plugins>
        </build>
    </project>
    
  10. לוחצים על פריסת.

דף הפרטים של Cloud Functions נפתח, והפונקציה מופיעה עם שני מדדי התקדמות: אחד ל-build ואחד לשירות. כששני מדדי ההתקדמות נעלמים ומוחלפים בסימן וי, הפונקציה פרוסה ומוכנה לשימוש.

מתן הרשאה ל-Google Chat להפעיל את הפונקציה

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

  1. נכנסים לדף Cloud Run במסוף Google Cloud:

    כניסה אל Cloud Run

  2. ברשימה של שירותי Cloud Run, מסמנים את התיבה שלצד הפונקציה המקבלת. (לא לוחצים על הפונקציה עצמה).

  3. לוחצים על הרשאות. החלונית Permissions (הרשאות) נפתחת.

  4. לוחצים על Add principal.

  5. בשדה New principals, מזינים את כתובת האימייל של חשבון השירות של התוסף ל-Google Workspace שמשויך לפרויקט.

  6. בקטע Select a role, בוחרים באפשרות Cloud Run > Cloud Run Invoker.

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

הגדרת התוסף

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

  1. במסוף Google Cloud, לוחצים על סמל התפריט > Cloud Functions.

    כניסה אל Cloud Functions

    מוודאים שבחרתם את הפרויקט שבו הפעלתם את Cloud Functions.

  2. ברשימת הפונקציות, לוחצים על AddOnChatApp.

  3. לוחצים על הכרטיסייה טריגרים.

  4. בקטע HTTPS, מעתיקים את כתובת ה-URL.

  5. מחפשים את 'Google Chat API' ולוחצים על Google Chat API ואז על ניהול.

    לדף Chat API

  6. לוחצים על הגדרה ומגדירים את אפליקציית Google Chat:

    1. בשדה App name, מזינים Add-on Chat app.
    2. בקטע Avatar URL, מזינים את הערך https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. בשדה Description, מזינים Add-on Chat app.
    4. בקטע פונקציונליות, בוחרים באפשרויות קבלת הודעות בצ'אט אישי והצטרפות למרחבים משותפים ולשיחות קבוצתיות.
    5. בקטע Connection settings, בוחרים באפשרות HTTP endpoint URL ומדביקים את כתובת ה-URL של הטריגר של Cloud Function בתיבה.
    6. בקטע Authentication Audience, בוחרים באפשרות HTTP endpoint URL.
    7. בקטע Visibility (חשיפה), בוחרים באפשרות Make this Google Chat app available to specific people and groups (האפליקציה של Google Chat תהיה זמינה לאנשים ולקבוצות ספציפיים) בדומיין ומזינים את כתובת האימייל.
    8. בקטע יומנים, בוחרים באפשרות רישום שגיאות ביומן.
  7. לוחצים על שמירה.

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

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

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

  1. פותחים את Google Chat באמצעות חשבון Google Workspace שסיפקתם כשהוספת את עצמכם כבודקים מהימנים.

    כניסה ל-Google Chat

  2. לוחצים על צ'אט חדש.
  3. בשדה Add 1 or more people, מקלידים את שם אפליקציית Chat.
  4. בוחרים את אפליקציית Chat בתוצאות. ייפתח צ'אט אישי.

  5. בצ'אט האישי החדש עם האפליקציה, מקלידים Hello ומקישים על enter.

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

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

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

פתרון בעיות

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

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

הסרת המשאבים

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

  1. במסוף Google Cloud, עוברים לדף Manage resources. לוחצים על תפריט > IAM & Admin > Manage Resources.

    כניסה ל-Resource Manager

  2. ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על Delete .
  3. כדי למחוק את הפרויקט, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down.