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, Sohbet uygulamasının bir 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:

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

1. Kullanıcı, Chat'te bir Chat uygulamasına doğrudan mesaj veya Chat alanında mesaj gönderir.
2. Chat uygulaması mantığını içeren bir bulut veya şirket içi sistem olan bir web sunucusuna HTTP isteği gönderilir.
3. İsteğe bağlı olarak Chat uygulaması mantığı, Google Workspace hizmetleri (Takvim ve E-Tablolar gibi), diğer Google hizmetleri (Haritalar, YouTube ve Vertex AI gibi) veya diğer web hizmetleri (proje yönetimi sistemi ya da destek kaydı aracı gibi) ile 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ı, mesajları asynkron olarak yayınlamak veya başka işlemler yapmak 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

• Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı
• Faturalandırmanın etkin olduğu bir Google Cloud projesi. Mevcut bir projede faturalandırmanın etkinleştirilip etkinleştirilmediğini kontrol etmek için Projelerinizin faturalandırma durumunu doğrulama başlıklı makaleyi inceleyin. Proje oluşturmak ve faturalandırmayı ayarlamak için Google Cloud projesi oluşturma başlıklı makaleyi inceleyin.

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 Console'da 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 gidin

   Chat uygulamanızın projesinin 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'da Cloud Run İşlevi'ni seçin.
   2. İşlev adı alanına QuickStartChatApp yazın.
   3. Bölge'de 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 kod bölümünde Satır içi düzenleyici'yi seçin.

6. Giriş noktası alanında varsayılan metni silin ve avatarApp yazın.

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

   node/avatar-app/index.js

   GitHub'da göster
   // The ID of the slash command "/about".
   // It's not enabled by default, set to the actual ID to enable it. You need to
   // use the same ID as set in the Google Chat API configuration.
   const ABOUT_COMMAND_ID = "";
   
   /**
    * 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.message) {
       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 event = req.body;
   
     // Checks for the presence of a slash command in the message.
     if (event.message.slashCommand) {
       // Executes the slash command logic based on its ID.
       // Slash command IDs are set in the Google Chat API configuration.
       switch (event.message.slashCommand.commandId) {
         case ABOUT_COMMAND_ID:
           return res.send({
             privateMessageViewer: event.user,
             text: 'The Avatar app replies to Google Chat messages.'
           });
       }
     }
   
     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} avatarUrl the URL for the sender's avatar
    * @return {Object} a card with the user's avatar.
    */
   function createMessage(displayName, avatarUrl) {
     return {
       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. Dağıt'ı tıklayın.

Python

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

   Cloud Functions'a gidin

   Chat uygulamanızın projesinin 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'da Cloud Run İşlevi'ni seçin.
   2. İşlev adı alanına QuickStartChatApp yazın.
   3. Bölge'de 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ı bölümünde, Python'ın en son sürümünü seçin.

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

6. Giriş noktası alanında varsayılan metni silin ve avatar_app yazın.

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

   python/avatar-app/main.py

   GitHub'da göster
   from typing import Any, Mapping
   
   import flask
   import functions_framework
   
   # The ID of the slash command "/about".
   # It's not enabled by default, set to the actual ID to enable it. You need to
   # use the same ID as set in the Google Chat API configuration.
   ABOUT_COMMAND_ID = ""
   
   @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)
   
     # Checks for the presence of a slash command in the message.
     if "slashCommand" in request_json["message"]:
       # Executes the slash command logic based on its ID.
       # Slash command IDs are set in the Google Chat API configuration.
       if request_json["message"]["slashCommand"]["commandId"] == ABOUT_COMMAND_ID:
         return {
           "privateMessageViewer": request_json["user"],
           "text": 'The Avatar app replies to Google Chat messages.'
         }
   
     display_name = request_json["message"]["sender"]["displayName"]
     avatar = request_json["message"]["sender"]["avatarUrl"]
     response = create_message(name=display_name, image_url=avatar)
     return response
   
   
   def create_message(name: str, image_url: str) -> Mapping[str, Any]:
     """Google Cloud Function that handles requests from Google Chat
   
     Args:
         str name: the sender's display name.
         str image_url: the URL for the sender's avatar.
   
     Returns:
         Mapping[str, Any]: a card with the user's avatar.
     """
     return {
       "text": "Here's your avatar",
       "cardsV2": [{
         "cardId": "avatarCard",
         "card": {
             "name": "Avatar Card",
             "header": { "title": f"Hello {name}!" },
             "sections": [{
               "widgets": [{
                 "textParagraph": { "text": "Your avatar picture:" }
               }, {
                 "image": { "imageUrl": image_url }
               }]
             }]
         }
       }]
     }

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

Java

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

   Cloud Functions'a gidin

   Chat uygulamanızın projesinin 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'da Cloud Run İşlevi'ni seçin.
   2. İşlev adı alanına QuickStartChatApp yazın.
   3. Bölge'de 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ı bölümünde, Java'nın en son sürümünü seçin.

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

6. Giriş noktası alanında varsayılan metni silin ve App yazın.

7. src/main/java/com/example/Example.java'ü src/main/java/App.java olarak yeniden adlandırın.

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

   java/avatar-app/src/main/java/App.java

   GitHub'da göster
   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.api.services.chat.v1.model.User;
   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 App implements HttpFunction {
     private static final Gson gson = new Gson();
   
     // The ID of the slash command "/about".
     // It's not enabled by default, set to the actual ID to enable it. You need to
     // use the same ID as set in the Google Chat API configuration.
     private static final String ABOUT_COMMAND_ID = "";
   
     @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;
       }
   
       // Checks for the presence of a slash command in the message.
       if (body.getAsJsonObject("message").has("slashCommand")) {
         // Executes the slash command logic based on its ID.
         // Slash command IDs are set in the Google Chat API configuration.
         JsonObject slashCommand = body.getAsJsonObject("message").getAsJsonObject("slashCommand");
         switch (slashCommand.get("commandId").getAsString()) {
           case ABOUT_COMMAND_ID:
             Message aboutMessage = new Message();
             aboutMessage.setText("The Avatar app replies to Google Chat messages.");
             aboutMessage.setPrivateMessageViewer(new User()
               .setName(body.getAsJsonObject("user").get("name").getAsString()));
             response.getWriter().write(gson.toJson(aboutMessage));
             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) {
       return new Message()
         .setText("Here's your avatar")
         .setCardsV2(List.of(new CardWithId()
           .setCardId("previewLink")
           .setCard(new GoogleAppsCardV1Card()
             .setName("Avatar Card")
             .setHeader(new GoogleAppsCardV1CardHeader()
               .setTitle(String.format("Hello %s!", displayName)))
             .setSections(List.of(new GoogleAppsCardV1Section().setWidgets(List.of(
               new GoogleAppsCardV1Widget()
                 .setTextParagraph(new GoogleAppsCardV1TextParagraph()
                   .setText("Your avatar picture: ")),
               new GoogleAppsCardV1Widget()
                 .setImage(new GoogleAppsCardV1Image().setImageUrl(avatarUrl)))))))));
     }
   }

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

   java/avatar-app/pom.xml

   GitHub'da göster
   <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.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-rev20241008-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 kaybolup onay işaretiyle değiştirildiğinde işleviniz dağıtılmış ve kullanıma hazır olur.

İşlevinizi çağırması için Google Chat'e yetki verme

Google Chat'i işlevinizi çağırmaya yetkilendirmek için Google Chat hizmet hesabını Cloud Run Çağırıcı rolüyle ekleyin.

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

   Cloud Run'a gidin

2. Cloud Run hizmetleri listesinde, alıcı işlevin yanındaki onay kutusunu işaretleyin. (İşlevin kendisini tıklamayın.)

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

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

5. Yeni ana hesaplar alanına [e-mail] girin.

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 Console'da Menü > Cloud Functions'ı tıklayın.

   Cloud Functions'a gidin

   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 bölümünde URL'yi kopyalayın.

5. "Google Chat API"yi arayın ve 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'si alanına https://developers.google.com/chat/images/quickstart-app-avatar.png yazın.
   3. Açıklama alanına Quickstart app yazın.
   4. İşlevsellik bölümünde 1:1 mesaj alma ve Alanlara ve grup görüşmelerine katılma'yı seçin.
   5. Bağlantı ayarları bölümünde HTTP uç noktası URL'si'ni seçin ve Cloud Function tetikleyicisinin URL'sini kutuya yapıştırın.
   6. Kimlik doğrulama kitlesi bölümünde HTTP uç noktası URL'si'ni seçin.
   7. Görünürlük bölümünde, alanınızda Bu Google Chat uygulamasını belirli kişilere ve gruplara sun'u seçin ve e-posta adresinizi girin.
   8. Günlükler bölümünde Günlüğe hata kaydet'i seçin.

7. Kaydet'i tıklayın.

Chat uygulaması, Chat'te mesaj almaya ve yanıt vermeye 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 gidin

2. Yeni sohbet'i tıklayın.
3. 1 veya daha fazla kullanıcı ekle alanına Chat uygulamanızın adını yazın.

4. Sonuçlardan Chat uygulamanızı seçin. Bir doğrudan mesaj açılır.

   Not: Chat uygulamanızı sonuç listesinde görmüyorsanız Google Workspace hesabınızı, Google Cloud Console'daki Chat API Yapılandırması sayfasının Görünürlük ayarlarına eklediğinizden emin olun.
5. Uygulamayla olan yeni doğrudan mesajda Hello yazın ve 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ü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

Bir Google Chat uygulaması veya kartı hata döndürdüğünde Chat arayüzünde "Bir hata oluştu" mesajı gösterilir. veya "İsteğiniz işlenemiyor." Bazen Chat kullanıcı arayüzünde 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österilmeyebilir ancak Chat uygulamaları için hata günlüğü etkinleştirildiğinde hataları düzeltmenize yardımcı olacak açıklayıcı hata mesajları ve günlük verileri kullanılabilir. 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.

Dikkat: Proje silmenin aşağıdaki etkileri vardır:

• Projedeki her şey silinir. Bu eğitim için mevcut bir projeyi kullandıysanız bu projeyi sildiğinizde, projede yaptığınız diğer çalışmaları da silmiş olursunuz.
• Özel proje kimlikleri kaybolur. Bu projeyi oluştururken, gelecekte kullanmak istediğiniz özel bir proje kimliği oluşturmuş olabilirsiniz. Proje kimliğini kullanan URL'leri (ör. appspot.com'daki bir URL) korumak için projenin tamamını silmek yerine projedeki seçili kaynakları silin.

Birden fazla eğitim ve hızlı başlangıç kılavuzunu keşfetmeyi planlıyorsanız projeleri yeniden kullanmak, proje kotası sınırlarını aşmanızı önleyebilir.

1. Google Cloud Console'da 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'i tıklayın.
3. İletişim kutusuna proje kimliğini yazın ve projeyi silmek için Kapat'ı tıklayın.

İlgili konular

• Chat uygulamanıza daha fazla özellik eklemek için aşağıdakileri inceleyin:

  • Etkileşimli kart mesajları oluşturma
  • Eğik çizgi komutlarına yanıt verme
  • İletişim kutularını açma ve yanıtlama

• Chat uygulaması mimarisi seçme

• Google Chat isteklerini doğrulama