สร้างแอป Google Chat ด้วยฟังก์ชัน Google Cloud

หน้านี้อธิบายวิธีสร้างและโต้ตอบกับแอป Google Chat โดยใช้ Google Cloud Functions

ในการสร้างแอป Chat คุณต้องเขียนและทำให้ Cloud Function ใช้งานได้ที่แอป Chat ใช้เพื่อตอบกลับข้อความของผู้ใช้ การตอบกลับของแอป Chat มีข้อความการ์ดที่แสดงชื่อและรูปโปรไฟล์ของผู้ส่งดังที่แสดงในรูปภาพต่อไปนี้

แอปแชทที่ตอบกลับด้วยการ์ดที่แสดงชื่อที่แสดงและรูปโปรไฟล์ของผู้ส่ง

วัตถุประสงค์

  • ตั้งค่าสภาพแวดล้อมของคุณ
  • สร้างและทำให้ Cloud Function ใช้งานได้
  • เผยแพร่แอปไปยัง Google Chat
  • ทดสอบแอป

ข้อกำหนดเบื้องต้น

  • บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat ในองค์กร Google Workspace ซึ่งอนุญาตการเรียกใช้ Google Cloud Function ที่ไม่ผ่านการตรวจสอบสิทธิ์

ตั้งค่าสภาพแวดล้อม

ก่อนใช้ Google API คุณต้องเปิดใช้งานในโปรเจ็กต์ Google Cloud คุณเปิด API ได้อย่างน้อย 1 รายการในโปรเจ็กต์ Google Cloud โปรเจ็กต์เดียว
  • ในคอนโซล Google Cloud ให้เปิดใช้ Google Chat API, Cloud Build API, Cloud Functions API, Cloud Pub/Sub API และ Cloud Logging API

    เปิดใช้ API

สร้างและทำให้ Cloud Function ใช้งานได้

สร้างและทำให้ Cloud Function ที่สร้างการ์ดแชทพร้อมชื่อที่แสดงและรูปโปรไฟล์ของผู้ส่ง เมื่อ Chat ได้รับข้อความ แอปจะเรียกใช้ฟังก์ชันและ ตอบกลับด้วยการ์ด

หากต้องการสร้างและทำให้ฟังก์ชันใช้งานได้สำหรับแอป Chat โปรดทำตามขั้นตอนต่อไปนี้

Node.js

  1. ในคอนโซล Google Cloud ให้ไปที่หน้า Cloud Functions ดังนี้

    ไปที่ Cloud Function

    ตรวจสอบว่าได้เลือกโปรเจ็กต์สำหรับแอป Chat แล้ว

  2. คลิก สร้างฟังก์ชัน

  3. ตั้งค่าฟังก์ชันในหน้าสร้างฟังก์ชันดังนี้

    1. ป้อน "QuickStartChatApp" ในชื่อฟังก์ชัน
    2. ในประเภททริกเกอร์ ให้เลือก HTTP
    3. ในส่วนการตรวจสอบสิทธิ์ ให้เลือกอนุญาตการเรียกใช้ที่ไม่ผ่านการตรวจสอบสิทธิ์

      โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์ใน Google Workspace ที่หัวข้อ ตรวจสอบสิทธิ์และให้สิทธิ์แอป Chat และคำขอ API

    4. คลิกบันทึก

    5. คลิกถัดไป

  4. เลือก Node.js 10 ในรันไทม์

  5. ในซอร์สโค้ด ให้เลือกตัวแก้ไขในบรรทัด

  6. ในจุดแรกเข้า ให้ลบข้อความเริ่มต้นและป้อน helloChat

  7. แทนที่เนื้อหาของ index.js ด้วยโค้ดต่อไปนี้

    Node/Avatar-app/index.js
    /**
     * Google Cloud Function that responds to messages sent from a
     * Google Chat room.
     *
     * @param {Object} req Request sent from Google Chat room
     * @param {Object} res Response to send back
     */
    exports.helloChat = function helloChat(req, res) {
      if (req.method === 'GET' || !req.body.message) {
        res.send('Hello! This function is meant to be used in a Google Chat ' +
          'Room.');
      }
    
      const sender = req.body.message.sender.displayName;
      const image = req.body.message.sender.avatarUrl;
    
      const data = createMessage(sender, image);
    
      res.send(data);
    };
    
    /**
     * Creates a card with two widgets.
     * @param {string} displayName the sender's display name
     * @param {string} imageUrl the URL for the sender's avatar
     * @return {Object} a card with the user's avatar.
     */
    function createMessage(displayName, imageUrl) {
      const cardHeader = {
        title: `Hello ${displayName}!`,
      };
    
      const avatarWidget = {
        textParagraph: {text: 'Your avatar picture: '},
      };
    
      const avatarImageWidget = {
        image: {imageUrl},
      };
    
      const avatarSection = {
        widgets: [
          avatarWidget,
          avatarImageWidget,
        ],
      };
    
      return {
        cardsV2: [{
          cardId: 'avatarCard',
          card: {
            name: 'Avatar Card',
            header: cardHeader,
            sections: [avatarSection],
          }
        }],
      };
    }

  8. คลิกทำให้ใช้งานได้

Python

  1. ในคอนโซล Google Cloud ให้ไปที่หน้า Cloud Functions ดังนี้

    ไปที่ Cloud Function

    ตรวจสอบว่าได้เลือกโปรเจ็กต์สำหรับแอป Chat แล้ว

  2. คลิก สร้างฟังก์ชัน

  3. ตั้งค่าฟังก์ชันในหน้าสร้างฟังก์ชันดังนี้

    1. ป้อน "QuickStartChatApp" ในชื่อฟังก์ชัน
    2. ในประเภททริกเกอร์ ให้เลือก HTTP
    3. ในส่วนการตรวจสอบสิทธิ์ ให้เลือกอนุญาตการเรียกใช้ที่ไม่ผ่านการตรวจสอบสิทธิ์

      โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์ใน Google Workspace ที่หัวข้อ ตรวจสอบสิทธิ์และให้สิทธิ์แอป Chat และคำขอ API

    4. คลิกบันทึก

    5. คลิกถัดไป

  4. ในรันไทม์ ให้เลือก Python 3.10

  5. ในซอร์สโค้ด ให้เลือกตัวแก้ไขในบรรทัด

  6. ในจุดแรกเข้า ให้ลบข้อความเริ่มต้นและป้อน hello_chat

  7. แทนที่เนื้อหาของ main.py ด้วยโค้ดต่อไปนี้

    Python/Avatar-app/main.py
    from typing import Any, Mapping
    
    import flask
    import functions_framework
    
    
    # Google Cloud Function that responds to messages sent in
    # Google Chat.
    #
    # @param {Object} req Request sent from Google Chat.
    # @param {Object} res Response to send back.
    @functions_framework.http
    def hello_chat(req: flask.Request) -> Mapping[str, Any]:
      if req.method == "GET":
        return "Hello! This function must be called from Google Chat."
    
      request_json = req.get_json(silent=True)
    
      display_name = request_json["message"]["sender"]["displayName"]
      avatar = request_json["message"]["sender"]["avatarUrl"]
    
      response = create_message(name=display_name, image_url=avatar)
    
      return response
    
    
    # Creates a card with two widgets.
    # @param {string} name the sender's display name.
    # @param {string} image_url the URL for the sender's avatar.
    # @return {Object} a card with the user's avatar.
    def create_message(name: str, image_url: str) -> Mapping[str, Any]:
      avatar_image_widget = {"image": {"imageUrl": image_url}}
      avatar_text_widget = {"textParagraph": {"text": "Your avatar picture:"}}
      avatar_section = {"widgets": [avatar_text_widget, avatar_image_widget]}
    
      header = {"title": f"Hello {name}!"}
    
      cards = {
          "cardsV2": [
              {
                  "cardId": "avatarCard",
                  "card": {
                      "name": "Avatar Card",
                      "header": header,
                      "sections": [avatar_section],
                  },
              }
          ]
      }
    
      return cards
    
    

  8. คลิกทำให้ใช้งานได้

Java

  1. ในคอนโซล Google Cloud ให้ไปที่หน้า Cloud Functions ดังนี้

    ไปที่ Cloud Function

    ตรวจสอบว่าได้เลือกโปรเจ็กต์สำหรับแอป Chat แล้ว

  2. คลิก สร้างฟังก์ชัน

  3. ตั้งค่าฟังก์ชันในหน้าสร้างฟังก์ชันดังนี้

    1. ป้อน "QuickStartChatApp" ในชื่อฟังก์ชัน
    2. ในประเภททริกเกอร์ ให้เลือก HTTP
    3. ในส่วนการตรวจสอบสิทธิ์ ให้เลือกอนุญาตการเรียกใช้ที่ไม่ผ่านการตรวจสอบสิทธิ์

      โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์ใน Google Workspace ที่หัวข้อ ตรวจสอบสิทธิ์และให้สิทธิ์คำขอ API และ Chat

    4. คลิกบันทึก

    5. คลิกถัดไป

  4. ในรันไทม์ ให้เลือก Java 11

  5. ในซอร์สโค้ด ให้เลือกตัวแก้ไขในบรรทัด

  6. ในจุดแรกเข้า ให้ลบข้อความเริ่มต้นและป้อน HelloChat

  7. เปลี่ยนชื่อ src/main/java/com/example/Example.java เป็น src/main/java/HelloChat.java

  8. แทนที่เนื้อหาของ HelloChat.java ด้วยโค้ดต่อไปนี้

    Java/Avatar-app/src/main/java/HelloChat.java
    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;
    import java.util.List;
    
    public class HelloChat 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("message")) {
          response.getWriter().write("Hello! This function must be called from Google Chat.");
          return;
        }
    
        JsonObject sender = body.getAsJsonObject("message").getAsJsonObject("sender");
        String displayName = sender.has("displayName") ? sender.get("displayName").getAsString() : "";
        String avatarUrl = sender.has("avatarUrl") ? sender.get("avatarUrl").getAsString() : "";
        Message message = createMessage(displayName, avatarUrl);
    
        response.getWriter().write(gson.toJson(message));
      }
    
      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("previewLink");
        cardWithId.setCard(card);
    
        Message message = new Message();
        message.setCardsV2(List.of(cardWithId));
    
        return message;
      }
    }

  9. แทนที่เนื้อหาของ pom.xml ด้วยโค้ดต่อไปนี้

    Java/Avatar-app/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>cloudfunctions</groupId>
      <artifactId>http-function</artifactId>
      <version>1.0-SNAPSHOT</version>
    
      <properties>
        <maven.compiler.target>11</maven.compiler.target>
        <maven.compiler.source>11</maven.compiler.source>
      </properties>
    
      <dependencies>
        <dependency>
          <groupId>com.google.cloud.functions</groupId>
          <artifactId>functions-framework-api</artifactId>
          <version>1.0.1</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 11 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 จะเปิดขึ้นและฟังก์ชันจะปรากฏขึ้นพร้อมสัญญาณบอกสถานะความคืบหน้าในการทำให้ใช้งานได้ข้างชื่อฟังก์ชัน เมื่อสัญญาณบอกสถานะความคืบหน้าหายไปและเครื่องหมายถูกปรากฏขึ้น แสดงว่าฟังก์ชันใช้งานได้แล้ว

เผยแพร่แอปใน Google Chat

หลังจากทำให้ Cloud Function ใช้งานได้แล้ว ให้ทำตามขั้นตอนต่อไปนี้เพื่อเปลี่ยนให้เป็นแอป Google Chat

  1. ในคอนโซล Google Cloud ให้คลิกเมนู > Cloud Functions

    ไปที่ Cloud Function

    ตรวจสอบว่าได้เลือกโปรเจ็กต์ที่คุณเปิดใช้ Cloud Functions แล้ว

  2. คลิก QuickStartChatApp ในรายการฟังก์ชัน

  3. ในหน้ารายละเอียดฟังก์ชัน ให้คลิกทริกเกอร์

  4. ในส่วน ทริกเกอร์ URL ให้คัดลอก URL

  5. ค้นหา "Google Chat API" แล้วคลิก Google Chat API จากนั้นคลิกจัดการ

    ไปที่ Chat API

  6. คลิกการกำหนดค่าและตั้งค่าแอป Google Chat โดยทำดังนี้

    1. ป้อน Quickstart App ในชื่อแอป
    2. ใน URL ของรูปโปรไฟล์ ให้ป้อน https://developers.google.com/chat/images/quickstart-app-avatar.png
    3. ในคำอธิบาย ให้ป้อน Quickstart app
    4. ในส่วนฟังก์ชันการทำงาน ให้เลือกรับข้อความ 1:1 เข้าร่วมพื้นที่ทำงานและการสนทนากลุ่ม และบันทึกข้อผิดพลาดไปยัง Cloud Logging
    5. ในส่วนการตั้งค่าการเชื่อมต่อ ให้เลือก URL ของแอป แล้ววาง URL สำหรับทริกเกอร์ Cloud Function ลงในช่อง
    6. เลือกบุคคลและกลุ่มเฉพาะในโดเมนในส่วนสิทธิ์ แล้วป้อนอีเมลของคุณ
  7. คลิกบันทึก

แอปพร้อมที่จะรับและตอบข้อความใน Google Chat แล้ว

ทดสอบแอป Chat

หากต้องการทดสอบแอป Chat ให้ส่งข้อความส่วนตัวถึงแอปโดยทำดังนี้

  1. เปิด Google Chat
  2. หากต้องการส่งข้อความส่วนตัวถึงแอป ให้คลิกเริ่มแชท แล้วคลิกค้นหาแอปในหน้าต่างที่ปรากฏขึ้น
  3. ในกล่องโต้ตอบค้นหาแอป ให้ค้นหา "แอปเริ่มต้นอย่างรวดเร็ว"
  4. หากต้องการเปิดข้อความส่วนตัวด้วยแอป ให้ค้นหา แอป Quickstart และคลิกเพิ่ม > แชท
  5. ในข้อความส่วนตัว ให้พิมพ์ Hello แล้วกด enter

แอปจะแสดงการ์ดที่มีชื่อที่แสดงและรูปโปรไฟล์

แก้ไขข้อผิดพลาด

หากต้องการแก้ปัญหาและแก้ไขข้อบกพร่องของแอป Chat โปรดดูหัวข้อแก้ปัญหาและแก้ไขข้อผิดพลาดของแอป Google Chat

หากต้องการเพิ่มฟังก์ชันการทำงานในแอป Chat โปรดดูคำแนะนำต่อไปนี้

  • สร้างข้อความการ์ดแบบอินเทอร์แอกทีฟ - ข้อความการ์ดจะรองรับเลย์เอาต์ที่กำหนดไว้และองค์ประกอบ UI แบบอินเทอร์แอกทีฟ เช่น ปุ่ม และสื่อสมบูรณ์อย่างรูปภาพ ใช้ข้อความบนการ์ดเพื่อนำเสนอข้อมูลโดยละเอียด รวบรวมข้อมูลจากผู้ใช้ และแนะนำผู้ใช้ให้ไปยังขั้นตอนถัดไป
  • คําสั่งเครื่องหมายทับ - คําสั่งเครื่องหมายทับช่วยให้คุณลงทะเบียนและโฆษณาคําสั่งที่เจาะจงซึ่งผู้ใช้ส่งแอปได้โดยพิมพ์คําสั่งที่ขึ้นต้นด้วยเครื่องหมายทับ (/) เช่น /help
  • กล่องโต้ตอบการเปิดใช้ — กล่องโต้ตอบคืออินเทอร์เฟซแบบการ์ดที่มีหน้าต่างซึ่งแอปของคุณสามารถเปิดเพื่อโต้ตอบกับผู้ใช้ได้ สามารถต่อบัตรหลายใบเข้าด้วยกันตามลำดับได้ ซึ่งช่วยให้ผู้ใช้ทำตามขั้นตอนที่มีหลายขั้นตอน เช่น การกรอกข้อมูลในแบบฟอร์ม

หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับ Google Chat API โปรดดูเอกสารอ้างอิง