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 kullanabilir. Bu hızlı başlangıç kılavuzunda bir Cloud Functions İşlevi Kullanıcının mesajına yanıt vermek için Chat uygulaması tarafından kullanılır.

Bu mimari sayesinde Chat'i, mevcut kullanıcılarla entegrasyon sağlamak için HTTP kullanılarak Google Cloud ya da şirket içi bir sunucu üzerinden şu şemayı kullanın:

Yukarıdaki şemada, HTTP ile etkileşimde bulunan bir kullanıcı Chat uygulamasında aşağıdaki bilgi akışı bulunur:

1. Bir kullanıcı Chat'te bir kullanıcıya mesaj gönderir: doğrudan mesajla veya Chat alanı
2. Bulut veya Chat uygulamasını içeren şirket içi sistem mantığıyla başlayalım.
3. İsteğe bağlı olarak, Chat uygulaması mantığı Google Workspace hizmetleri (ör. Takvim ve E-Tablolar), diğer Google hizmetleri (ör. Haritalar, YouTube ve Vertex AI) veya diğer web hizmetleri (ör. yönetim sistemi veya bilet işlemleri aracı).
4. Web sunucusu, Search Ads 360'a bir HTTP yanıtı Chat'te Chat uygulaması hizmeti.
5. Yanıt kullanıcıya iletilir.
6. İsteğe bağlı olarak, Chat uygulaması Eşzamansız olarak mesaj göndermek veya diğer işlemleri gerçekleştirmek için Chat API operations.

Bu mimari, mevcut kitaplıkları kullanma ve zaten mevcut olan bileşenleri Chat uygulamaları farklı programlama dilleri kullanılarak tasarlanabilir.

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

• CEVAP Google Workspace şu hesaba erişimi olan hesap: Google Chat ve Google Cloud Functions.
• Bir Google Cloud projesi.
• Cloud projeniz için faturalandırmayı etkinleştirdiğinizden emin olun. Öğren nasıl yapılır? projelerinizin faturalandırma durumunu doğrulayın.

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'yi ve Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API ve Cloud Run API.

  API'leri etkinleştirme

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

Chat kartı oluşturan bir Cloud Functions işlevi oluşturup dağıtma görünen adı ve avatar resmi ile birlikte girin. Chat uygulaması bir mesaj alır, işlevi çalıştırır ve yanıt olarak kartla yanıt verir.

Chat uygulamanızda işlevi 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ın projesinin seçili.

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

   GitHub'da göster

   /**
    * 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ın projesinin seçili.

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

   GitHub'da göster

   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ın projesinin seçili.

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 adlı cihazın adını şu şekilde değiştir: src/main/java/HelloChat.java.

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

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

   GitHub'da göster

   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

   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>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şleviniz iki biri derleme, diğeri hizmet için olan ilerleme göstergeleri. Her ikisi de ilerleme göstergeleri kaybolur ve yerine bir onay işareti eklenirse, dağıtıldı ve hazır.

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

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

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

   Cloud Run'a git

2. Cloud Run hizmetleri listesinde alıcı hizmet sağlayıcısının yanındaki onay kutusunu işaretleyin. işlevini kullanın. (İş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 [e-mail] yazın.

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

7. Kaydet'i tıklayın.

Uygulamayı Google Chat'te yayınlama

Cloud Functions işlevi dağıtıldıktan sonra aşağıdaki adımları uygulayarak Cloud Functions işlevine dönüştürün Google Chat uygulaması:

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

   Cloud Functions'a git

   Cloud Functions'ı etkinleştirdiğiniz projenin seçili.

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" araması yapı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 şunu girin: https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. Açıklama alanına Quickstart app yazın.
   4. İşlevsellik bölümünde Bire bir mesajlar al'ı seçin ve Alanlara ve grup görüşmelerine katılabilirsiniz.
   5. Bağlantı ayarları bölümünde Uygulama URL'si'ni seçin ve şu uygulamanın URL'sini yapıştırın: Cloud Functions işlevi tetikleyicisini kutuya yerleştirin.
   6. Kimlik Doğrulama Kitlesi bölümünde Uygulama URL'si'ni seçin.
   7. Görünürlük altında Bu Google Chat uygulamasını belirli kişilerin kullanımına sunun ve gruplarına gidip 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ı mesajları almaya ve yanıtlamaya hazır mesajları görebilir.

Chat uygulamanızı test etme

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

1. Oluşturduğunuz Google Workspace hesabını kullanarak Google Chat'i açın ve kendinizi güvenilir test kullanıcısı olarak eklediğinizde sağlanan bir değerdir.

   Google Chat'e git

2. Yeni sohbet'i tıklayın.
3. 1 veya daha fazla kişi ekle alanına eklemek istediğiniz kişinin adını Chat uygulaması.

4. Sonuçlar arasından Chat uygulamanızı seçin. Doğrudan mesajı açılır.

   Not: emin olmak için, Google Workspace hesabınızı Chat API Yapılandırması'nın görünürlük ayarları sayfasını kontrol edin.
5. Uygulamayı içeren yeni doğrudan mesajda Hello yazın ve şuna basın: enter.

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

Güvenilir test kullanıcıları eklemek ve etkileşimli özellikleri test etme hakkında daha fazla bilgi edinmek için bkz. Şunun için etkileşimli özellikleri test edin: Google Chat uygulamaları.

Sorun giderme

Bir Google Chat uygulaması veya card bir hata döndürürse Chat arayüzünde "Bir sorun oluştu" mesajı gösteriliyor. veya "İsteğiniz işlenemiyor." Chat kullanıcı arayüzü herhangi bir hata mesajı görüntülenmiyor ancak Chat uygulaması veya kart beklenmeyen bir sonuç veriyorsa; Örneğin karttaki bir mesajda görünür.

Chat kullanıcı arayüzünde hata mesajı görüntülenmese de Hataları düzeltmenize yardımcı olmak için açıklayıcı hata mesajları ve günlük verileri sunulur Chat uygulamaları için hata günlük kaydı etkinleştirildiğinde. Görüntüleme konusunda yardım için ve hataları düzeltme ile ilgili daha fazla bilgi edinmek için Google Chat hatalarını giderme ve düzeltme

Temizleme

Aşağıdaki işlem için Google Cloud hesabınızdan ücret alınmasını önlemek amacıyla: kaynaklardan yararlanabilmeniz için Cloud projesi.

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 proje içindeki seçili kaynakları silin.

Birden fazla eğiticiyi ve hızlı başlangıç kılavuzunu keşfetmeyi planlıyorsanız projeleri yeniden kullanarak proje kota sınırlarını aşmaktan kaçınabilirsiniz.

1. Google Cloud konsolunda Kaynakları yönetin sayfasına gidin. Sonraki slayta geçin Menü > IAM ve Yönetici > Kaynakları Yönetin.

   Resource Manager'a git 'nı inceleyin.

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

İlgili konular

• Chat uygulamanıza daha fazla özellik eklemek için: takip etmek için:

  • 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