Google Chat API'yi yapılandırma

Oluşturduğunuz her Google Chat uygulaması için Chat API'nin etkinleştirildiği ve yapılandırıldığı ayrı bir Google Cloud projesi gerekir.

Kullanıcı kimlik doğrulaması ile salt okuma API çağrıları (ör. alanları alma ve mesajları listeleme) gerçekleştirmek için yalnızca API'yi etkinleştirmeniz ve OAuth istemcisi oluşturmanız gerekir.

Oluşturma, güncelleme ve silme API çağrıları yapmak ya da etkileşimli bir Chat uygulamasını (Chat'i genişleten bir Google Workspace eklentisi olarak oluşturulmuş) dağıtıp test etmek için Chat API'yi de yapılandırmanız gerekir. Chat API yapılandırma ayarları, görünen adı, avatarı, dağıtım uç noktaları ve etkileşimli özellikleri dahil olmak üzere Chat uygulamasıyla ilgili tüm ayrıntıları belirttiğiniz yerdir.

Ön koşullar

• Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.
• Google Cloud projesi oluşturun.
• OAuth kullanıcı rızası ekranını yapılandırın.
• Google Chat API'yi etkinleştirin.

Chat uygulamanız için görünen ad, avatar ve açıklama seçme

Chat API'yi etkinleştirdiğinizde, Chat'teki kullanıcılara gösterilen Chat uygulamanızla ilgili ayrıntıları (görünen ad, avatar ve açıklama gibi) yapılandırırsınız. Bu ayrıntılar yalnızca Chat'te görünür. Chat uygulamanızı Marketplace'te yayınlamak için Chat uygulamanızın Marketplace girişinde gösterilen ayrıntıları da belirtmeniz gerekir.

Bir Chat uygulamasını yapılandırmadan önce aşağıdaki bilgileri hazırlayın:

Alan	Açıklama	Biçim
Uygulama adı	Chat uygulamasının görünen adı.	En fazla 25 alfanümerik karakter
Avatar URL'si	Chat uygulamanızın avatarı olarak gösterilen resim.	Kare grafik resmini (PNG veya JPEG) gösteren bir HTTPS URL'si. Önerilen boyut 256 x 256 piksel veya daha fazladır.
Açıklama	Chat uygulamasının amacının kısa bir açıklaması.	En fazla 40 alfanümerik karakter

Chat uygulamasının adı, avatarı ve açıklaması, Chat kullanıcı arayüzünde kullanıcılara gösterilir. Chat, bazı Chat API yazma isteklerinde Chat uygulamasının Chat'te gerçekleştirdiği işlemleri ilişkilendirmek için bu bilgileri kullanır.

Örneğin, spaces.create() yöntemini çağırırsanız Chat, aşağıdaki resimde gösterildiği gibi alanı kimin oluşturduğunun açıklamasında Chat uygulamasının adını içerir:

Şekil 1. Chat'in, bir kullanıcı adına alan oluşturmak için spaces.create() yöntemi kullanıldığında gösterdiği ilişkilendirme mesajı.

Kullanıcılar, Chat uygulamalarıyla etkileşimde bulunmak için bu bilgileri aşağıdaki şekillerde de görür veya kullanır:

• Bir alana eklemek veya mesaj göndermek için Chat uygulamasından @bahsedin.
• Chat uygulamasıyla doğrudan mesajlaşma özelliğini bulup kullanmaya başlayın. Uygulamalar menüsünde, doğrudan mesajlarda Chat uygulamasının adı ve avatarı gösterilir.
• Kullanıcılar, oluşturma çubuğundan Chat uygulamalarına göz atabilir ve adlarını, avatarlarını ve açıklamalarını görebilir.

Google Cloud Console'da Chat uygulamanızı yapılandırma

Chat uygulaması ayrıntılarınız hazır olduğunda Cloud projenizi açın ve Chat API'yi yapılandırın:

1. Google Cloud Console'da Chat API sayfasına gidin ve Yapılandırma sayfasını tıklayın:

   Chat API Yapılandırma sayfasına gidin

2. Uygulama bilgileri bölümünde Uygulama adı, Avatar URL'si ve Açıklama alanlarını doldurun.

3. Etkileşimli özellikler bölümünde, sohbet uygulamanızın kullanıcı etkileşimlerine yanıt verip vermeyeceğini yapılandırın:

   Not: Sohbet uygulamanız yalnızca Chat API'yi çağırıyor ve kullanıcı etkileşimlerini almıyor veya bunlara yanıt vermiyorsa Etkileşimli özellikleri etkinleştir'i devre dışı bırakın ve sonraki adıma geçin.

   Etkileşimli bir Chat uygulaması oluşturmak için Etkileşimli özellikleri etkinleştir'i açın ve aşağıdakileri tamamlayın:

   1. İşlevsellik bölümünde:
      • İsteğe bağlı: Chat uygulamasıyla bire bir doğrudan mesajların Ana Sayfa sekmesinde ana sayfa kartı göstermek için Destek Uygulaması Ana Sayfası'nı seçin.
      • Chat uygulamanızın yüklenip kullanılabilmesi için Alanlara ve grup görüşmelerine katıl'ı seçin. Kullanıcılar, varsayılan olarak kullanıcı ile Chat uygulaması arasında özel bir alanda Chat uygulamasını yükleyip bu uygulamayla mesajlaşabilir. Ayrıca, birden fazla kişinin bulunduğu alanlara Chat uygulamasını ekleyip bu uygulamayla etkileşimde bulunabilir.

   2. Bağlantı ayarları bölümünde, Chat'ten etkinlik nesneleri almak için kullanmak istediğiniz mimariyi seçin:

      • HTTP hizmeti kullanmak için HTTP uç noktası URL'si'ni seçip bir URL girin.
      • Google Apps Komut Dosyası projesi kullanmak için Apps Komut Dosyası'nı seçin ve proje için bir dağıtım kimliği girin.
      • Dialogflow temsilcisi kullanmak için Dialogflow'u, Dialogflow CX veya Dialogflow ES'i seçin ve temsilcinin kaynak adını girin.
      • Pub/Sub'ı kullanmak için Cloud Pub/Sub'ı seçin ve konu adını girin.
      Uyarı: Apps Komut Dosyası dağıtım kimliği zaten doluysa Cloud projesi mevcut bir Google Workspace eklentisine bağlıdır. Chat API'sinde dağıtım kimliğini güncellerseniz dağıtım kimliği eklentiniz için güncellenir ve Google Workspace Marketplace'teki girişinizi etkileyebilir. Eklenti yapılandırmanızı incelemek için Google Workspace Marketplace SDK'sında uygulamanızı yapılandırma başlıklı makaleyi inceleyin.

   3. İsteğe bağlı: Etkinlik nesnelerini belirli uç noktalara veya işlevlere yönlendirmek için Bağlantı ayarları > Tetikleyiciler'e gidin ve aşağıdaki sohbet tetikleyicileri için geri çağırma uç noktalarını veya işlevlerini sağlayın ya da güncelleyin:

      Not: Apps Komut Dosyası için tetikleyicileri güncellemezseniz bu bölümde doldurulan varsayılan geri çağırma işlevlerini (ör. onMessage, onAddedToSpace, onRemovedFromSpace, onAppCommand ve onAppHome) uygulamanız gerekir.
      • Uygulama ana sayfası (Uygulama ana sayfasını destekle etkinse): Kullanıcı, Chat uygulamasıyla bire bir doğrudan mesajlaşmada Ana Sayfa sekmesini açar.
      • Alana eklendi: Bir kullanıcı, Chat uygulamasını grup görüşmesine veya alana ekler ya da bire bir mesajlar için Chat uygulamasını yükler.
      • Mesaj: Bir kullanıcı, Chat uygulamasına mesaj gönderir. Örneğin, kullanıcı Chat uygulamasına doğrudan mesaj gönderir veya birden fazla kişinin bulunduğu bir alanda Chat uygulamasından @bahseder.
      • Alandan kaldırıldı: Bir kullanıcı, Chat uygulamasını kaldırır veya bir alandan kaldırır.
      • Uygulama komutu: Kullanıcı, Chat uygulamasından hızlı komut, eğik çizgi komutu veya mesaj işlemi çağırır.

   4. İsteğe bağlı: Başlangıç istemleri, komutlar (hızlı komutlar, eğik çizgi komutları ve mesaj işlemleri) veya bağlantı önizlemeleri gibi diğer etkileşimli özellikleri ekleyin.

   5. Görünürlük bölümünde, Google Workspace Marketplace'te yayınlamadan önce Chat uygulamasını yükleyip test edebilmeniz için e-posta adresinizi belirtin. Google Workspace kuruluşunuzdan en fazla beş kişi veya bir ya da daha fazla Google Grubu belirtebilirsiniz.

4. İsteğe bağlı: Google Cloud Logging'i kullanmak için Günlükler bölümünde Günlük hatalarını Logging'e onay kutusunu işaretleyin. Daha fazla bilgi için Chat uygulamaları için sorgu hatası günlükleri başlıklı makaleyi inceleyin.

5. Kaydet'i tıklayın.

Yapılandırmayı kaydettikten sonra, Chat API'nin Görünürlük ayarında belirttiğiniz herkes Chat uygulamasını yükleyebilir, test edebilir veya kullanabilir. Chat uygulamanızı test etmeye ve hatalarını ayıklamaya başlamak için Google Chat uygulamaları için etkileşimli özellikleri test etme başlıklı makaleyi inceleyin.

Mevcut Google Workspace eklentileriyle ilgili dikkat edilmesi gereken noktalar

Chat uygulamaları, diğer Google Workspace uygulamalarını genişleten Google Workspace eklentilerine kıyasla farklı bir yapılandırma gerektirir. Eklentiniz diğer Google Workspace uygulamalarını genişletiyorsa Chat uygulamasını yapılandırmak için aşağıdaki şartları göz önünde bulundurun:

• Hem bireyler hem de Google Workspace yöneticileri, eklentinizi Marketplace'ten yükleyebilmelidir. Bu yükleme ayarlarını Google Workspace Marketplace SDK'sında yapılandırabilirsiniz.
• Chat uygulamaları, manifest dosyasının addons.common nesnesinde diğer Google Workspace uygulamaları için yapılandırdığınız adı ve logoyu kullanmaz.
• Google Workspace Marketplace'te yayınlanan eklentiler için Google Chat API yapılandırma ayarlarında yapılan değişikliklerin taslağını kaydedemezsiniz. Chat API yapılandırma ayarlarını güncelleyip kaydettikten sonra güncellenen Chat uygulaması, mevcut tüm kullanıcılar tarafından hemen kullanılabilir. Pazar yeri listelemenizi güncellemek için değişiklikleri göndermeden önce taslak oluşturabilirsiniz.
• Eklentinizi Apps Komut Dosyası'nı kullanarak oluşturduysanız:
  • Eklenti yapılandırmanızın geri kalanı için kullandığınız Apps Komut Dosyası dağıtım kimliğini kullanmanız gerekir.
  • Chat'te test dağıtımlarını yüklemek için Apps Komut Dosyası Düzenleyicisi'ni kullanamazsınız. Bunun yerine doğrudan Chat kullanıcı arayüzünden yüklemeniz gerekir.
• Eklentinizi bir HTTP hizmeti kullanarak oluşturduysanız Google Workspace eklentileri API'si ile oluşturduğunuz manifest ve dağıtımlarda Chat uygulaması yapılandırma ayrıntılarını atlayın. Google Workspace Marketplace SDK'sında belirttiğiniz HTTP dağıtımları yalnızca diğer Google Workspace uygulamaları için kullanılır.

Diğer kullanıcılara Chat API'yi yapılandırma izni verme

Belirli kullanıcılara Chat uygulamaları sahibi veya Chat uygulamaları görüntüleyicisi Google Cloud Identity Access Management (IAM) rolünü vererek Chat uygulaması yapılandırma sayfasına erişmelerini sağlayabilirsiniz. Bu rollere sahip kullanıcılar, API'ler ve Hizmetler kontrol panelini kullanarak Chat uygulamaları yapılandırma sayfasına gidemez ancak Chat uygulamasının barındırıldığı Cloud projesi için Google Cloud Console'a giderek yapılandırma sayfasına erişebilir.

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

Burada PROJECT_ID, Chat uygulamasını barındıran Google Cloud projesinin proje kimliğidir.

Proje rollerine sahip kullanıcılar da uygulama yapılandırma sayfasına erişebilir.

resourcemanager.projects.(get|update) izinlerini içeren özel rollere sahip kullanıcılar, Chat uygulaması yapılandırmasına erişemez. Özel roller için bunun yerine chat.bots.(get|update) izinlerini kullanın.

İlgili konular

• Chat uygulaması mimarisi seçme
• Kullanıcı etkileşimlerini alma ve yanıtlama
• Google Chat uygulamaları için etkileşimli özellikleri test etme

Eklenti olmayan Chat uygulamaları: Google Chat API'yi yapılandırma

Google Workspace eklentisi olmayan bir Chat uygulaması kullanıyorsanız yapılandırmanız, etkinlik başına tetikleyiciler yerine tüm etkileşim etkinlikleri için tek bir uç nokta kullanır:

1. Google Cloud Console'da Chat API Yapılandırma sayfasına gidin:

   Chat API Yapılandırma sayfasına gitme

2. Etkileşimli özellikler bölümünde Etkileşimli özellikleri etkinleştir'i açın.

3. Bu Chat uygulamasını Google Workspace eklentisi olarak oluştur seçeneğinin işaretini kaldırın. Onaylamanızı isteyen bir iletişim kutusu açılır. İletişim kutusunda Devre dışı bırak'ı tıklayın.

4. İşlevsellik bölümünde, ihtiyacınıza göre Uygulama ana sayfasını destekle veya Alanlara ve grup görüşmelerine katıl'ı seçin.

5. Bağlantı ayarları bölümünde, sohbet uygulamanız için tek bir uç nokta belirtin (HTTP uç nokta URL'si, Apps Komut Dosyası dağıtım kimliği, Cloud Pub/Sub konu adı veya Dialogflow).

6. İsteğe bağlı Komutlar, Bağlantı önizlemeleri, Görünürlük ve Günlükler'i yapılandırın, ardından Kaydet'i tıklayın.

Eklenti olmayan bir Chat uygulamasını, Google Chat'i genişleten bir Google Workspace eklentisine yükseltmek için Google Chat uygulamasını Google Workspace eklentisine dönüştürme başlıklı makaleyi inceleyin.