Cloud Functions ile HTTP Google Chat uygulaması oluşturma

Bu sayfada, HTTP Chat uygulamasının nasıl oluşturulacağı açıklanmaktadır. Bu mimariyi uygulamanın farklı yolları vardır. Google Cloud'da Cloud Functions, Cloud Run ve App Engine'i kullanabilirsiniz. Bu hızlı başlangıç kılavuzunda, Chat uygulamasının kullanıcının mesajına yanıt vermek için kullandığı bir Cloud Functions işlevi yazıp dağıtacaksınız.

Bu mimari sayesinde Chat'i, HTTP kullanarak aşağıdaki şemada gösterildiği gibi Google Cloud veya şirket içi bir sunucu ile entegre olacak şekilde yapılandırırsınız:

Şirket içi sunucuda web hizmeti kullanan bir Chat uygulaması mimarisi.

Önceki şemada, HTTP Chat uygulamasıyla etkileşimde bulunan bir kullanıcı aşağıdaki bilgi akışına sahiptir:

  1. Kullanıcı, Chat'teki bir Chat uygulamasına doğrudan mesaj veya bir Chat alanında mesaj gönderir.
  2. Chat uygulaması mantığını içeren bulut veya şirket içi sistem olan bir web sunucusuna HTTP isteği gönderilir.
  3. İsteğe bağlı olarak, Chat uygulama mantığı Google Workspace hizmetleri (Takvim ve E-Tablolar gibi), diğer Google hizmetleri (Haritalar, YouTube ve Vertex AI gibi) veya diğer web hizmetleriyle (ör. proje yönetim sistemi veya bilet işlemleri aracı) entegre edilebilir.
  4. Web sunucusu, Chat'teki Chat uygulaması hizmetine bir HTTP yanıtı gönderir.
  5. Yanıt kullanıcıya iletilir.
  6. İsteğe bağlı olarak, Chat uygulaması eşzamansız olarak mesaj yayınlamak veya başka işlemler gerçekleştirmek için Chat API'yi çağırabilir.

Chat uygulamaları farklı programlama dilleri kullanılarak tasarlanabileceği için bu mimari, sisteminizde zaten bulunan mevcut kitaplıkları ve bileşenleri kullanma esnekliği sağlar.

Hedefler

  • Ortamınızı ayarlayın.
  • Cloud Functions işlevi oluşturma ve dağıtma
  • Uygulamayı Chat'te yayınlayın.
  • Uygulamayı test edin.

Ön koşullar

Ortamı ayarlama

Google API'lerini kullanmadan önce bir Google Cloud projesinde etkinleştirmeniz gerekir. Tek bir Google Cloud projesinde bir veya daha fazla API'yi etkinleştirebilirsiniz.
  • Google Cloud konsolunda Google Chat API, Cloud Build API, Cloud Functions API, Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API ve Cloud Run API'yi etkinleştirin.

    API'leri etkinleştirme

Cloud Functions işlevi oluşturma ve dağıtma

Gönderenin görünen adı ve avatar resmiyle Chat kartı oluşturan bir Cloud Functions işlevi oluşturup dağıtın. Chat uygulaması bir mesaj aldığında işlevi çalıştırır ve kartla yanıt verir.

İşlevi Chat uygulamanızda oluşturup dağıtmak için aşağıdaki adımları tamamlayın:

Node.js

  1. Google Cloud Console'da Cloud Functions sayfasına gidin:

    Cloud Functions'a git

    Chat uygulamanız için projenin seçili olduğundan emin olun.

  2. İşlev Oluştur'u tıklayın.

  3. İşlev oluştur sayfasında işlevinizi ayarlayın:

    1. Ortam bölümünde 2. nesil'i seçin.
    2. İşlev adı alanına QuickStartChatApp yazın.
    3. Bölge'den bir bölge seçin.
    4. Kimlik doğrulama bölümünde Kimlik doğrulaması iste'yi seçin.
    5. İleri'yi tıklayın.
  4. Çalışma zamanı'nda, Node.js'nin en son sürümünü seçin.

  5. Kaynak kodu bölümünde Satır içi düzenleyici'yi seçin.

  6. Giriş noktası bölümünde varsayılan metni silin ve helloChat yazın.

  7. index.js içeriğini aşağıdaki kodla değiştirin:

    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 {
        text: 'Here\'s your avatar',
        cardsV2: [{
          cardId: 'avatarCard',
          card: {
            name: 'Avatar Card',
            header: cardHeader,
            sections: [avatarSection],
          }
        }],
      };
    }

  8. Dağıt'ı tıklayın.

Python

  1. Google Cloud Console'da Cloud Functions sayfasına gidin:

    Cloud Functions'a git

    Chat uygulamanız için projenin seçili olduğundan emin olun.

  2. İşlev Oluştur'u tıklayın.

  3. İşlev oluştur sayfasında işlevinizi ayarlayın:

    1. Ortam bölümünde 2. nesil'i seçin.
    2. İşlev adı alanına QuickStartChatApp yazın.
    3. Bölge'den bir bölge seçin.
    4. Kimlik doğrulama bölümünde Kimlik doğrulaması iste'yi seçin.
    5. İleri'yi tıklayın.
  4. Çalışma zamanı'nda, Python'un en son sürümünü seçin.

  5. Kaynak kodu bölümünde Satır içi düzenleyici'yi seçin.

  6. Giriş noktası bölümünde varsayılan metni silin ve hello_chat yazın.

  7. main.py içeriğini aşağıdaki kodla değiştirin:

    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 = {
          "text": "Here's your avatar",
          "cardsV2": [
              {
                  "cardId": "avatarCard",
                  "card": {
                      "name": "Avatar Card",
                      "header": header,
                      "sections": [avatar_section],
                  },
              }
          ]
      }
    
      return cards

  8. Dağıt'ı tıklayın.

Java

  1. Google Cloud Console'da Cloud Functions sayfasına gidin:

    Cloud Functions'a git

    Chat uygulamanız için projenin seçili olduğundan emin olun.

  2. İşlev Oluştur'u tıklayın.

  3. İşlev oluştur sayfasında işlevinizi ayarlayın:

    1. Ortam bölümünde 2. nesil'i seçin.
    2. İşlev adı alanına QuickStartChatApp yazın.
    3. Bölge'den bir bölge seçin.
    4. Kimlik doğrulama bölümünde Kimlik doğrulaması iste'yi seçin.
    5. İleri'yi tıklayın.
  4. Çalışma zamanı'nda, Java'nın en son sürümünü seçin.

  5. Kaynak kodu bölümünde Satır içi düzenleyici'yi seçin.

  6. Giriş noktası bölümünde varsayılan metni silin ve HelloChat yazın.

  7. src/main/java/com/example/Example.java öğesinin adını src/main/java/HelloChat.java olarak değiştirin.

  8. HelloChat.java içeriğini aşağıdaki kodla değiştirin:

    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.setText("Here's your avatar");
        message.setCardsV2(List.of(cardWithId));
    
        return message;
      }
    }

  9. pom.xml içeriğini aşağıdaki kodla değiştirin:

    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. Dağıt'ı tıklayın.

Cloud Functions ayrıntılar sayfası açılır ve işlevinizde biri derleme, diğeri hizmet için olmak üzere iki ilerleme göstergesi gösterilir. Her iki ilerleme göstergesi de kaybolduğunda ve yerine bir onay işareti konulduğunda işleviniz dağıtılır ve hazır olur.

Google Chat'e işlevinizi çağırma yetkisi verme

Google Chat'e işlevinizi çağırma yetkisi vermek için Cloud Run Çağırıcısı rolüne sahip Google Chat hizmet hesabını ekleyin.

  1. Google Cloud Console'da Cloud Run sayfasına gidin:

    Cloud Run'a git

  2. Cloud Run hizmetleri listesinde alıcı işlevinin yanındaki onay kutusunu seçin. (İşlevi tıklamayın.)

  3. İzinler'i tıklayın. İzinler paneli açılır.

  4. Ana hesap ekle'yi tıklayın.

  5. New principals (Yeni ana hesaplar) alanına chat@system.gserviceaccount.com yazın.

  6. Rol seçin bölümünde Cloud Run > Cloud Run Çağırıcısı'nı seçin.

  7. Kaydet'i tıklayın.

Uygulamayı Google Chat'te yayınlama

Cloud Functions işlevi dağıtıldıktan sonra Google Chat uygulamasına dönüştürmek için aşağıdaki adımları uygulayın:

  1. Google Cloud konsolunda Menü > Cloud Functions'ı tıklayın.

    Cloud Functions'a git

    Cloud Functions'ı etkinleştirdiğiniz projenin seçildiğinden emin olun.

  2. İşlevler listesinde QuickStartChatApp'i tıklayın.

  3. Tetikleyiciler sekmesini tıklayın.

  4. HTTPS'nin altındaki URL'yi kopyalayın.

  5. "Google Chat API" ifadesini aratıp Google Chat API'yi, ardından Yönet'i tıklayın.

    Chat API'ye git

  6. Yapılandırma'yı tıklayın ve Google Chat uygulamasını ayarlayın:

    1. Uygulama adı alanına Quickstart App yazın.
    2. Avatar URL'sine https://developers.google.com/chat/images/quickstart-app-avatar.png yazın.
    3. Açıklama alanına Quickstart app yazın.
    4. İşlevler bölümünde, Bire bir mesaj al ve Alanlara ve grup görüşmelerine katıl'ı seçin.
    5. Bağlantı ayarları bölümünde Uygulama URL'si'ni seçin ve Cloud Functions işlevi tetikleyicisinin URL'sini kutuya yapıştırın.
    6. Kimlik Doğrulama Kitlesi bölümünde Uygulama URL'si'ni seçin.
    7. Görünürlük bölümünde, Bu Google Chat uygulamasını alanınızdaki belirli kişiler ve gruplar için kullanılabilir yap'ı seçin ve e-posta adresinizi girin.
    8. Günlükler bölümünde, Hataları günlüğe kaydetme'yi seçin.
  7. Kaydet'i tıklayın.

Chat uygulaması, Chat'te mesaj almaya ve mesajları yanıtlamaya hazırdır.

Chat uygulamanızı test etme

Chat uygulamanızı test etmek için Chat uygulamasıyla bir doğrudan mesaj alanı açın ve mesaj gönderin:

  1. Kendinizi Güvenilir Test Kullanıcısı olarak eklerken sağladığınız Google Workspace hesabını kullanarak Google Chat'i açın.

    Google Chat'e git

  2. Yeni sohbet'i tıklayın.
  3. 1 veya daha fazla kişi ekle alanına Chat uygulamanızın adını yazın.
  4. Sonuçlar arasından Chat uygulamanızı seçin. Bir doğrudan mesaj açılır.

  5. Uygulamayı içeren yeni doğrudan mesajda Hello yazıp enter tuşuna basın.

Chat uygulamasının yanıtı, aşağıdaki resimde gösterildiği gibi, gönderenin adını ve avatar resmini gösteren bir kart mesajı içerir:

Gönderenin görünen adını ve avatar resmini gösteren bir kartla yanıt veren Chat uygulaması

Güvenilir test kullanıcıları eklemek ve etkileşimli özellikleri test etme hakkında daha fazla bilgi edinmek için Google Chat uygulamaları için etkileşimli özellikleri test etme başlıklı makaleyi inceleyin.

Sorun giderme

Google Chat uygulaması veya kartı hata döndürdüğünde Chat arayüzünde "Bir sorun oluştu" mesajı gösterilir. veya "İsteğiniz işlenemiyor." Bazı durumlarda Chat kullanıcı arayüzünde herhangi bir hata mesajı gösterilmez ancak Chat uygulaması veya kartı beklenmedik bir sonuç verir. Örneğin, kart mesajı görünmeyebilir.

Chat kullanıcı arayüzünde hata mesajı görüntülenmese de Chat uygulamaları için hata günlük kaydı etkinleştirildiğinde hataları düzeltmenize yardımcı olmak amacıyla açıklayıcı hata mesajları ve günlük verileri sunulur. Hataları görüntüleme, hata ayıklama ve düzeltme konusunda yardım almak için Google Chat hatalarını giderme ve düzeltme başlıklı makaleyi inceleyin.

Temizleme

Bu eğiticide kullanılan kaynaklar için Google Cloud hesabınızın ücretlendirilmesini istemiyorsanız Cloud projesini silmenizi öneririz.

  1. Google Cloud konsolunda Kaynakları yönetin sayfasına gidin. Menü > IAM ve Yönetici > Kaynakları Yönet'i tıklayın.

    Resource Manager'a git

  2. Proje listesinde, silmek istediğiniz projeyi seçin ve ardından Sil simgesini tıklayın.
  3. İletişim kutusuna proje kimliğini yazın ve projeyi silmek için Kapat'ı tıklayın.