Package google.chat.v1

Dizin

ChatService

Geliştiricilerin Google Chat Platformu'nda Chat uygulamaları ve entegrasyonları oluşturmasına olanak tanır.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Belirtilen alan için içe aktarma işlemini tamamlar ve alanı kullanıcılara görünür hâle getirir.

Yetkilendirme kapsamı ile kullanıcı kimlik doğrulaması ve alan genelinde yetki gerektirir:

  • https://www.googleapis.com/auth/chat.import

Daha fazla bilgi için Google Chat uygulamalarını veri içe aktarmak üzere yetkilendirme başlıklı makaleyi inceleyin.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/chat.import

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Özel emoji oluşturur.

Özel emojiler yalnızca Google Workspace hesaplarında kullanılabilir ve yöneticinin kuruluş için özel emojileri etkinleştirmesi gerekir. Daha fazla bilgi için Google Chat'teki özel emojiler hakkında ve Özel emoji izinlerini yönetme başlıklı makaleleri inceleyin.

Yetkilendirme kapsamı ile kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.customemojis
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/chat.customemojis

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Arama için Chat uygulaması, kullanıcı veya Google Grubu için üyelik oluşturur. Diğer Chat uygulamaları için üyelik oluşturma desteklenmez. Üyelik oluştururken belirtilen üyenin otomatik kabul etme politikası devre dışıysa bu üye davet edilir ve katılmadan önce alan davetini kabul etmesi gerekir. Aksi takdirde, üyelik oluşturulduğunda üye doğrudan belirtilen alana eklenir.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Geliştirici Önizlemesi'nde yönetici onayı ile uygulama kimlik doğrulaması ve yetkilendirme kapsamı:

    • https://www.googleapis.com/auth/chat.app.memberships
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (Arama uygulamasını alana eklemek için)
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında, use_admin_access true olduğunda ve aşağıdaki yetkilendirme kapsamı kullanıldığında yönetici ayrıcalıkları verir:
      • https://www.googleapis.com/auth/chat.admin.memberships

Uygulama kimlik doğrulaması aşağıdaki kullanım alanlarında desteklenmez:

  • Alanın sahibi olan Workspace kuruluşunun dışındaki kullanıcıları davet etme
  • Alana Google Grubu ekleme
  • Alana Chat uygulaması ekleme

Örnek kullanım için bkz.:

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Google Chat alanında mesaj oluşturur. Örnek için Mesaj gönderme başlıklı makaleye bakın.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Yetkilendirme kapsamıyla uygulama kimlik doğrulaması:
    • https://www.googleapis.com/auth/chat.bot
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)

Chat, isteğinizde kullandığınız kimlik doğrulama türüne bağlı olarak ileti gönderenini farklı şekilde ilişkilendirir.

Aşağıdaki resimde, uygulama kimlik doğrulaması kullandığınızda Chat'in bir mesajı nasıl ilişkilendirdiği gösterilmektedir. Chat, mesaj göndereni Chat uygulaması olarak gösterir. Mesajın içeriğinde metin (text), kart (cardsV2) ve aksesuar widget'ları (accessoryWidgets) bulunabilir.

Uygulama kimlik doğrulamasıyla gönderilen ileti

Aşağıdaki resimde, kullanıcı kimlik doğrulamayı kullandığınızda Chat'in bir mesajı nasıl ilişkilendirdiği gösterilmektedir. Chat, kullanıcıyı mesaj gönderen olarak gösterir ve adını görüntüleyerek Chat uygulamasını mesajla ilişkilendirir. İleti içeriği yalnızca metin (text) içerebilir.

Kullanıcı kimlik doğrulamasıyla gönderilen ileti

İleti içeriği de dahil olmak üzere maksimum ileti boyutu 32.000 bayttır.

Webhook isteklerinde yanıt, mesajın tamamını içermiyor. Yanıt, istekte yer alan bilgilere ek olarak yalnızca name ve thread.name alanlarını dolduruyor.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Tepki oluşturup mesaja ekler. Örnek için Mesajlara tepki ekleme başlıklı makaleyi inceleyin.

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Alan oluşturur. Import mode içinde adlandırılmış bir alan veya grup sohbeti oluşturmak için kullanılabilir. Örnek için Alan oluşturma başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

Uygulama olarak kimlik doğrulaması yapılırken istekte space.customer alanı ayarlanmalıdır.

Uygulama olarak kimlik doğrularken Chat uygulaması, alanın üyesi olarak eklenir. Ancak insan kimlik doğrulamasının aksine, Chat uygulaması alan yöneticisi olarak eklenmez. Varsayılan olarak, Chat uygulaması tüm alan üyeleri tarafından alandan kaldırılabilir. Uygulamayı alandan yalnızca alan yöneticilerinin kaldırmasına izin vermek için space.permission_settings.manage_apps seçeneğini managers_allowed olarak ayarlayın.

Oluşturulduktan sonra alana üye olma durumu, alanın Import mode içinde oluşturulup oluşturulmadığına bağlıdır:

  • İçe aktarma modu: Üye oluşturulmaz.
  • Diğer tüm modlar: Arayan kullanıcı üye olarak eklenir. Bu:
    • Uygulama kimlik doğrulaması kullanılırken uygulamanın kendisi.
    • Kullanıcı kimlik doğrulaması kullanılırken insan kullanıcı.

Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Özel bir emojiyi siler. Varsayılan olarak, kullanıcılar yalnızca kendi oluşturdukları özel emojileri silebilir. Yönetici tarafından atanan emoji yöneticileri, kuruluştaki tüm özel emojileri silebilir. Google Chat'teki özel emojiler hakkında başlıklı makaleyi inceleyin.

Özel emojiler yalnızca Google Workspace hesaplarında kullanılabilir ve yöneticinin kuruluş için özel emojileri etkinleştirmesi gerekir. Daha fazla bilgi için Google Chat'teki özel emojiler hakkında ve Özel emoji izinlerini yönetme başlıklı makaleleri inceleyin.

Yetkilendirme kapsamı ile kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.customemojis
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/chat.customemojis

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Üyeliği siler. Örnek için Bir kullanıcıyı veya Google Chat uygulamasını alandan kaldırma başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Geliştirici Önizlemesi'nde yönetici onayı ile uygulama kimlik doğrulaması ve yetkilendirme kapsamı:

    • https://www.googleapis.com/auth/chat.app.memberships
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (Arama uygulamasını alandan kaldırmak için)
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında, use_admin_access true olduğunda ve aşağıdaki yetkilendirme kapsamı kullanıldığında yönetici ayrıcalıkları verir:
      • https://www.googleapis.com/auth/chat.admin.memberships

Uygulama kimlik doğrulaması aşağıdaki kullanım alanlarında desteklenmez:

  • Google Grubu'nu alandan çıkarma
  • Bir sohbet uygulamasını alandan kaldırma

Alan yöneticilerinin üyeliklerini silmek için isteği gönderen kullanıcının alan yöneticisi olması gerekir. Uygulama kimlik doğrulaması kullanıyorsanız alanı Chat uygulaması oluşturmalıdır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Mesajları siler. Örnek için İleti silme başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Yetkilendirme kapsamıyla uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.bot
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)

Uygulama kimlik doğrulaması kullanılırken istekler yalnızca arayan Chat uygulaması tarafından oluşturulan mesajları silebilir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Mesajlara verilen tepkileri siler. Örnek için Tepki silme başlıklı makaleyi inceleyin.

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Adlandırılmış bir alanı siler. Her zaman kademeli silme işlemi gerçekleştirir. Bu nedenle, alanın alt kaynakları (ör. alanda yayınlanan mesajlar ve alandaki üyelikler) da silinir. Örnek için Alan silme başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Geliştirici Önizlemesi'nde yönetici onayı ile uygulama kimlik doğrulaması ve yetkilendirme kapsamı:

    • https://www.googleapis.com/auth/chat.app.delete (yalnızca uygulamanın oluşturduğu alanlarda)
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında, use_admin_access true olduğunda ve aşağıdaki yetkilendirme kapsamı kullanıldığında yönetici ayrıcalıkları verir:
      • https://www.googleapis.com/auth/chat.admin.delete
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Belirtilen kullanıcıyla mevcut doğrudan mesajı döndürür. Doğrudan mesaj alanı bulunamazsa 404 NOT_FOUND hatası döndürülür. Örnek için Doğrudan mesaj bulma başlıklı makaleyi inceleyin.

Uygulama kimlik doğrulaması ile belirtilen kullanıcı ve arayan Chat uygulaması arasındaki doğrudan mesaj alanını döndürür.

Kullanıcı kimlik doğrulaması ile belirtilen kullanıcı ile kimliği doğrulanmış kullanıcı arasındaki doğrudan mesaj alanını döndürür.

Aşağıdaki kimlik doğrulama türlerini destekler:

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

İleti ekinin meta verilerini alır. Ek verileri, Media API kullanılarak getirilir. Örnek için İleti ekiyle ilgili meta verileri alma başlıklı makaleyi inceleyin.

Yetkilendirme kapsamı ile uygulama kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.bot
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/chat.bot

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Özel emoji hakkında ayrıntılar döndürür.

Özel emojiler yalnızca Google Workspace hesaplarında kullanılabilir ve yöneticinin kuruluş için özel emojileri etkinleştirmesi gerekir. Daha fazla bilgi için Google Chat'teki özel emojiler hakkında ve Özel emoji izinlerini yönetme başlıklı makaleleri inceleyin.

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Bir üyelikle ilgili ayrıntıları döndürür. Örnek için Kullanıcı veya Google Chat uygulaması üyeliği hakkında ayrıntılı bilgi edinme başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Yetkilendirme kapsamıyla uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.bot
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında yönetici ayrıcalıkları verir, use_admin_access true olur ve aşağıdaki yetkilendirme kapsamlarından biri kullanılır:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Bir iletiyle ilgili ayrıntıları döndürür. Örnek için İleti hakkında ayrıntılı bilgi edinme başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

Not: Engellenen bir üyeden veya alandan gelen mesajı döndürebilir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Bir alanla ilgili ayrıntıları döndürür. Örnek için Alanlarla ilgili ayrıntıları alma başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Aşağıdaki yetkilendirme kapsamlarından biriyle uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.spaces Yönetici onayıyla
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında yönetici ayrıcalıkları verir, use_admin_access true olur ve aşağıdaki yetkilendirme kapsamlarından biri kullanılır:
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

Uygulama kimlik doğrulamasıyla ilgili sınırlamalar:

  • space.access_settings yalnızca chat.app.spaces kapsamı kullanılırken doldurulur.
  • space.predefind_permission_settings ve space.permission_settings yalnızca chat.app.spaces kapsamı kullanılırken ve yalnızca uygulamanın oluşturduğu alanlar için doldurulur.
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Google Chat alanındaki bir etkinliği döndürür. Etkinlik yükü, değişen kaynağın en son sürümünü içerir. Örneğin, yeni bir mesajla ilgili etkinlik isteğinde bulunursanız ancak mesaj daha sonra güncellenirse sunucu, etkinlik yükünde güncellenmiş Message kaynağını döndürür.

Not: Bu istek için permissionSettings alanı, Space etkinliği verilerinin Space nesnesinde döndürülmez.

İstenen verilerin okunması için uygun bir yetkilendirme kapsamıyla kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

Etkinlik almak için kimliği doğrulanmış kullanıcının alanın üyesi olması gerekir.

Örnek için Google Chat alanındaki bir etkinlikle ilgili ayrıntıları alma başlıklı makaleyi inceleyin.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Alan bildirim ayarını alır. Örnek için Arayanın alan bildirimi ayarını alma başlıklı makaleyi inceleyin.

Yetkilendirme kapsamı ile kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.users.spacesettings
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Okunmuş ve okunmamış iletileri belirlemek için kullanılan, kullanıcının bir alandaki okuma durumuyla ilgili ayrıntıları döndürür. Örnek için Kullanıcının alan okuma durumu hakkında ayrıntılı bilgi edinme başlıklı makaleyi inceleyin.

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Okunmuş ve okunmamış iletileri belirlemek için kullanılan, bir ileti dizisindeki kullanıcının okuma durumuyla ilgili ayrıntıları döndürür. Örnek için Kullanıcının ileti dizisini okuma durumu hakkında ayrıntılı bilgi edinme başlıklı makaleyi inceleyin.

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Kimliği doğrulanmış kullanıcının görebileceği özel emojileri listeler.

Özel emojiler yalnızca Google Workspace hesaplarında kullanılabilir ve yöneticinin kuruluş için özel emojileri etkinleştirmesi gerekir. Daha fazla bilgi için Google Chat'teki özel emojiler hakkında ve Özel emoji izinlerini yönetme başlıklı makaleleri inceleyin.

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Bir alandaki üyelikleri listeler. Örnek için Bir alandaki kullanıcıları ve Google Chat uygulamalarını listeleme başlıklı makaleyi inceleyin. Uygulama kimlik doğrulaması ile üyelikleri listeleme, Chat uygulamasının erişebildiği alanlardaki üyelikleri listeler ancak kendi üyeliği de dahil olmak üzere Chat uygulaması üyeliklerini hariç tutar. Kullanıcı kimlik doğrulaması ile üyelikleri listeleme, kimliği doğrulanmış kullanıcının erişebildiği alanlardaki üyelikleri listeler.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Yetkilendirme kapsamıyla uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.bot
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında yönetici ayrıcalıkları verir, use_admin_access true olur ve aşağıdaki yetkilendirme kapsamlarından biri kullanılır:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Arayanın üyesi olduğu bir alandaki mesajları (engellenen üyelerden ve alanlardan gelen mesajlar dahil) listeler. Mesaj içermeyen bir alandaki mesajları listelerseniz yanıt boş bir nesne olur. REST/HTTP arayüzü kullanılırken yanıtta boş bir JSON nesnesi ({}) yer alır. Örnek için İletileri listeleme başlıklı makaleyi inceleyin.

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Bir mesaja verilen tepkileri listeler. Örnek için Bir iletiye verilen tepkileri listeleme başlıklı makaleyi inceleyin.

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Google Chat alanındaki etkinlikleri listeler. Her etkinlik için yük, Chat kaynağının en son sürümünü içerir. Örneğin, yeni alan üyeleriyle ilgili etkinlikleri listelerseniz sunucu, en son üyelik ayrıntılarını içeren Membership kaynaklarını döndürür. İstenen dönemde yeni üyeler kaldırıldıysa etkinlik yükünde boş bir Membership kaynağı bulunur.

İstenen verilerin okunması için uygun bir yetkilendirme kapsamıyla kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

Etkinlikleri listelemek için kimliği doğrulanmış kullanıcının alanın üyesi olması gerekir.

Örnek için Google Chat alanındaki etkinlikleri listeleme başlıklı makaleyi inceleyin.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Arayanın üyesi olduğu alanları listeler. Grup sohbetleri ve DM'ler, ilk mesaj gönderilene kadar listelenmez. Örnek için Alanları listeleme başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

Google Workspace kuruluşuna göre tüm adlandırılmış alanları listelemek için bunun yerine Workspace yönetici ayrıcalıklarını kullanarak spaces.search() yöntemini kullanın.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Bir yöneticinin aramasına göre Google Workspace kuruluşundaki alanların listesini döndürür.

Yönetici ayrıcalıklarıyla kullanıcı kimlik doğrulaması ve aşağıdaki yetkilendirme kapsamlarından biri gerekir:

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces

İstekle ilgili olarak use_admin_access değerini true olarak ayarlayın.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

Bir alan oluşturur ve belirtilen kullanıcıları bu alana ekler. Arayan kullanıcı alana otomatik olarak eklenir ve istekte üyelik olarak belirtilmemelidir. Örnek için İlk üyelerle alan oluşturma başlıklı makaleyi inceleyin.

Eklenecek insan üyeleri belirtmek için uygun membership.member.name ile üyelikler ekleyin. Gerçek bir kullanıcı eklemek için users/{user} öğesini kullanın. Burada {user}, kullanıcının e-posta adresi olabilir. Aynı Workspace kuruluşundaki kullanıcılar için {user}, People API'deki kişinin id veya Directory API'deki kullanıcının id de olabilir. Örneğin, user@example.com için People API Kişi profili kimliği 123456789 ise membership.member.name değerini users/user@example.com veya users/123456789 olarak ayarlayarak kullanıcıyı alana ekleyebilirsiniz.

Eklenecek Google gruplarını belirtmek için uygun membership.group_member.name ile üyelikler ekleyin. Google grubu eklemek veya davet etmek için groups/{group} ifadesini kullanın. Burada {group}, Cloud Identity Groups API'den alınan grup id'sıdır. Örneğin, group@example.com grup e-posta adresinin kimliğini 123456789 almak için Cloud Identity Groups lookup API'yi kullanabilirsiniz. Ardından, membership.group_member.name değerini groups/123456789 olarak ayarlayarak grubu alana ekleyebilirsiniz. Grup e-postası desteklenmez ve Google Grupları yalnızca adlandırılmış alanlara üye olarak eklenebilir.

Adlandırılmış bir alan veya grup görüşmesinde, arayan bazı üyeler tarafından engellenirse ya da bazı üyeleri engellerse veya bazı üyeleri ekleme izni yoksa bu üyeler oluşturulan alana eklenmez.

Arayan kullanıcı ile başka bir gerçek kullanıcı arasında doğrudan mesaj (DM) oluşturmak için gerçek kullanıcıyı temsil eden tam olarak bir üyelik belirtin. Bir kullanıcı diğerini engellerse istek başarısız olur ve DM oluşturulmaz.

Arayan kullanıcı ile arayan uygulama arasında DM oluşturmak için Space.singleUserBotDm değerini true olarak ayarlayın ve üyelik belirtmeyin. Bu yöntemi yalnızca arama uygulamasıyla DM oluşturmak için kullanabilirsiniz. Arama uygulamasını bir alanın üyesi olarak veya iki kullanıcı arasındaki mevcut bir DM'ye eklemek için Alana kullanıcı veya uygulama davet etme ya da ekleme başlıklı makaleyi inceleyin.

İki kullanıcı arasında zaten bir DM varsa, istek oluşturulduğu sırada bir kullanıcı diğerini engellemiş olsa bile mevcut DM döndürülür.

Mesaj dizili yanıtların kullanıldığı alanlar desteklenmez. Bir alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Üyeliği günceller. Örnek için Bir kullanıcının alandaki üyeliğini güncelleme başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Geliştirici Önizlemesi'nde yönetici onayı ile uygulama kimlik doğrulaması ve yetkilendirme kapsamı:

    • https://www.googleapis.com/auth/chat.app.memberships (yalnızca uygulamanın oluşturduğu alanlarda)
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında, use_admin_access true olduğunda ve aşağıdaki yetkilendirme kapsamı kullanıldığında yönetici ayrıcalıkları verir:
      • https://www.googleapis.com/auth/chat.admin.memberships
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Bir mesajı günceller. patch ve update yöntemleri arasında fark vardır. patch yöntemi patch isteğini, update yöntemi ise put isteğini kullanır. patch yöntemini kullanmanızı öneririz. Örnek için Mesajı güncelleme başlıklı makaleyi inceleyin.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Yetkilendirme kapsamıyla uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.bot
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)

Uygulama kimlik doğrulaması kullanılırken istekler yalnızca arayan Chat uygulaması tarafından oluşturulan mesajları güncelleyebilir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Bir alanı günceller. Örnek için Alan güncelleme başlıklı makaleye bakın.

displayName alanını güncellerken ALREADY_EXISTS hata mesajını alırsanız farklı bir görünen ad deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Geliştirici Önizlemesi'nde yönetici onayı ile uygulama kimlik doğrulaması ve aşağıdaki yetkilendirme kapsamlarından biri:

    • https://www.googleapis.com/auth/chat.app.spaces
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında, use_admin_access true olduğunda ve aşağıdaki yetkilendirme kapsamları kullanıldığında yönetici ayrıcalıkları verir:
      • https://www.googleapis.com/auth/chat.admin.spaces

Uygulama kimlik doğrulamasıyla ilgili sınırlamalar:

  • space.predefined_permission_settings veya space.permission_settings değerini güncellemek için uygulamanın alan oluşturucu olması gerekir.
  • Uygulama kimlik doğrulaması için space.access_settings.audience güncelleme desteklenmez.
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Alan bildirim ayarını günceller. Örnek için Arayanın alan bildirimi ayarını güncelleme başlıklı makaleyi inceleyin.

Yetkilendirme kapsamı ile kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.users.spacesettings
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Okunmuş ve okunmamış iletileri belirlemek için kullanılan, bir alandaki kullanıcının okunma durumunu günceller. Örnek için Kullanıcının alan okuma durumunu güncelleme başlıklı makaleyi inceleyin.

Yetkilendirme kapsamı ile kullanıcı kimlik doğrulaması gerektirir:

  • https://www.googleapis.com/auth/chat.users.readstate
Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/chat.users.readstate

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

AccessoryWidget

İletinin en altında görünen bir veya daha fazla etkileşimli widget. Ayrıntılar için İletinin en altına etkileşimli widget'lar ekleme başlıklı makaleyi inceleyin.

Alanlar
Birleştirme alanı action. İşlemin türü. action yalnızca aşağıdakilerden biri olabilir:
button_list

ButtonList

Düğme listesi.

ActionResponse

Chat uygulamasının yanıtının nasıl yayınlanacağını yapılandırmak için kullanabileceği parametreler.

Alanlar
type

ResponseType

Yalnızca giriş. Chat uygulaması yanıtının türü.

url

string

Yalnızca giriş. Kullanıcıların kimlik doğrulaması yapacağı veya yapılandıracağı URL. (Yalnızca REQUEST_CONFIG yanıt türleri için geçerlidir.)

dialog_action

DialogAction

Yalnızca giriş. İletişim kutusu ile ilgili bir etkileşim etkinliğine verilen yanıt. ResponseType.Dialog ile birlikte gönderilmelidir.

updated_widget

UpdatedWidget

Yalnızca giriş. Güncellenen widget'ın yanıtı.

ResponseType

Chat uygulaması yanıtının türü.

Sıralamalar
TYPE_UNSPECIFIED NEW_MESSAGE olarak işlenen varsayılan tür.
NEW_MESSAGE Konuda yeni bir ileti olarak yayınlayın.
UPDATE_MESSAGE Chat uygulamasının mesajını güncelleyin. Bu yalnızca, mesaj gönderen türünün BOT olduğu bir CARD_CLICKED etkinliğinde izin verilir.
UPDATE_USER_MESSAGE_CARDS Kullanıcının iletisindeki kartları güncelleyin. Bu yalnızca eşleşen URL'ye sahip bir MESSAGE etkinliğine veya mesaj gönderen türünün HUMAN olduğu bir CARD_CLICKED etkinliğine yanıt olarak izin verilir. Metin yoksayılır.
REQUEST_CONFIG Kullanıcıdan ek kimlik doğrulama veya yapılandırma yapmasını özel olarak isteme
DIALOG İletişim kutusu gösterir.
UPDATE_WIDGET Widget metni otomatik tamamlama seçenekleri sorgusu.

SelectionItems

Widget otomatik tamamlama sonuçlarının listesi.

Alanlar
items[]

SelectionItem

SelectionItem nesneleri dizisi.

UpdatedWidget

selectionInput widget'ları için çoklu seçim menüsünde otomatik tamamlama önerilerini döndürür.

Alanlar
widget

string

Güncellenen widget'ın kimliği. Kimlik, güncelleme isteğini tetikleyen widget'ın kimliğiyle eşleşmelidir.

Birleştirme alanı updated_widget. Widget, kullanıcı işlemine yanıt olarak güncellendi. updated_widget yalnızca aşağıdakilerden biri olabilir:
suggestions

SelectionItems

Widget otomatik tamamlama sonuçlarının listesi

ActionStatus

Bir diyalogu çağırma veya gönderme isteğinin durumunu gösterir.

Alanlar
status_code

Code

Durum kodu.

user_facing_message

string

Kullanıcılara isteklerinin durumu hakkında gönderilecek mesaj. Ayarlanmamışsa status_code temel alınarak genel bir ileti gönderilir.

Not

Yalnızca çıkış. İletinin düz metin gövdesiyle ilişkili ek açıklamalar. Kısa mesajlara temel biçimlendirme eklemek için Kısa mesajları biçimlendirme başlıklı makaleyi inceleyin.

Örnek düz metin ileti gövdesi:

Hello @FooBot how are you!"

İlgili ek açıklamalar meta verileri:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Alanlar
type

AnnotationType

Bu ek açıklamanın türü.

length

int32

Bu ek açıklamanın karşılık geldiği düz metin ileti gövdesindeki alt dizenin uzunluğu.

start_index

int32

Bu açıklamanın karşılık geldiği düz metin ileti gövdesindeki başlangıç dizini (0 tabanlı, dahil).

Birleştirme alanı metadata. Ek açıklama hakkında ek meta veriler. metadata yalnızca aşağıdakilerden biri olabilir:
user_mention

UserMentionMetadata

Kullanıcı bahsetme meta verileri.

slash_command

SlashCommandMetadata

Eğik çizgi komutunun meta verileri.

custom_emoji_metadata

CustomEmojiMetadata

Özel emojinin meta verileri.

AnnotationType

Ek açıklamanın türü.

Sıralamalar
ANNOTATION_TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
USER_MENTION Bir kullanıcıdan bahsedildiğinde
SLASH_COMMAND Bir eğik çizgi komutu çağrıldığında
CUSTOM_EMOJI Özel emoji ek açıklaması.

AppCommandMetadata

Chat uygulaması komutu ile ilgili meta veriler.

Alanlar
app_command_id

int32

Chat API yapılandırmasında belirtilen komutun kimliği.

app_command_type

AppCommandType

Chat uygulaması komutunun türü.

AppCommandType

Chat uygulaması komutunun türü. Ayrıntılı bilgi için Chat uygulaması komut türleri başlıklı makaleyi inceleyin.

Sıralamalar
APP_COMMAND_TYPE_UNSPECIFIED Varsayılan değer. Belirtilmedi.
SLASH_COMMAND Eğik çizgi komutu Kullanıcı, komutu Chat mesajı olarak gönderir.
QUICK_COMMAND Hızlı komut Kullanıcı, mesaj yanıt alanındaki Chat menüsünden komutu seçer.

AttachedGif

URL ile belirtilen bir GIF resmi.

Alanlar
uri

string

Yalnızca çıkış. GIF resmini barındıran URL.

Ek

Google Chat'teki bir ek.

Alanlar
name

string

İsteğe bağlıdır. Ekin kaynak adı, spaces/{space}/messages/{message}/attachments/{attachment} biçiminde.

content_name

string

Yalnızca çıkış. İçeriğin tam yolu değil, orijinal dosya adı.

content_type

string

Yalnızca çıkış. Dosyanın içerik türü (MIME türü).

thumbnail_uri

string

Yalnızca çıkış. Eki bir kullanıcıya önizletmek için kullanılması gereken küçük resim URL'si. Sohbet uygulamaları, ek içeriğini indirmek için bu URL'yi kullanmamalıdır.

download_uri

string

Yalnızca çıkış. Gerçek bir kullanıcının eki indirmesine izin vermek için kullanılması gereken indirme URL'si. Sohbet uygulamaları, ek içeriğini indirmek için bu URL'yi kullanmamalıdır.

source

Source

Yalnızca çıkış. Ekin kaynağı.

Birleştirme alanı data_ref. Eke yapılan veri referansı. data_ref yalnızca aşağıdakilerden biri olabilir:
attachment_data_ref

AttachmentDataRef

İsteğe bağlıdır. Ek verilerine referans. Bu alan, ek içeren mesajlar oluşturmak veya güncellemek ya da ek verilerini indirmek için Media API ile birlikte kullanılır.

drive_data_ref

DriveDataRef

Yalnızca çıkış. Google Drive eki referansı. Bu alan, Google Drive API ile kullanılır.

Kaynak

Ekin kaynağı.

Sıralamalar
SOURCE_UNSPECIFIED Rezervasyon yapıldı.
DRIVE_FILE Dosya, Google Drive dosyasıdır.
UPLOADED_CONTENT Dosya Chat'e yüklenir.

AttachmentDataRef

Ek verilerine referans.

Alanlar
resource_name

string

İsteğe bağlıdır. Ek verilerinin kaynak adı. Bu alan, ek verilerini indirmek için Media API ile birlikte kullanılır.

attachment_upload_token

string

İsteğe bağlıdır. Yüklenen bir eke referans içeren opak jeton. İstemciler tarafından opak bir dize olarak değerlendirilir ve ek içeren Chat mesajları oluşturmak veya güncellemek için kullanılır.

CardWithId

Google Chat mesajındaki kart.

Yalnızca Chat uygulamaları kart oluşturabilir. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa mesaj kart içeremez.

Kart Oluşturucu ile kart tasarlama ve önizleme

Kart Oluşturucu'yu açma

Alanlar
card_id

string

İleti birden fazla kart içeriyorsa zorunludur. İletideki bir kartın benzersiz tanımlayıcısı.

card

Card

Kart. Maksimum boyut 32 KB'tır.

ChatSpaceLinkData

Chat alanı bağlantılarıyla ilgili veriler.

Alanlar
space

string

Bağlı Chat alanı kaynağının alanı.

Biçim: spaces/{space}

thread

string

Bağlı Chat alanı kaynağının mesaj dizisi.

Biçim: spaces/{space}/threads/{thread}

message

string

Bağlı Chat alanı kaynağının mesajı.

Biçim: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

Bir alanın içe aktarma işlemini tamamlamak için istek mesajı.

Alanlar
name

string

Zorunlu. İçe aktarma modundaki alanın kaynak adı.

Biçim: spaces/{space}

CompleteImportSpaceResponse

Bir alanın içe aktarma işlemini tamamlama için yanıt mesajı.

Alanlar
space

Space

İçe aktarma modundaki alan.

ContextualAddOnMarkup

Bu türde alan yok.

Geliştiricilerin, bağlamsal bir eklentinin içeriğini belirtmek için kullandığı işaretleme.

Kart

Kart, metin ve resim gibi kullanıcı arayüzü widget'larını içerebilen bir kullanıcı arayüzü öğesidir.

Alanlar
header

CardHeader

Kartın başlığı. Başlık genellikle bir başlık ve bir resim içerir.

sections[]

Section

Bölümler, çizgiyle ayrılır.

card_actions[]

CardAction

Bu kartın işlemleri.

name

string

Kartın adı.

CardAction

Kart işlemi, kartla ilişkili işlemdir. Fatura kartı için tipik bir işlem şunlar olabilir: faturayı silme, faturayı e-postayla gönderme veya faturayı tarayıcıda açma.

Google Chat uygulamaları tarafından desteklenmez.

Alanlar
action_label

string

Etiket, işlem menüsü öğesinde gösteriliyordu.

on_click

OnClick

Bu işlem öğesi için onclick işlemi.

CardHeader

Alanlar
title

string

Başlık belirtilmelidir. Başlığın yüksekliği sabittir: Hem başlık hem de alt başlık belirtilmişse her biri bir satır kaplar. Yalnızca başlık belirtilirse her iki satırı da kaplar.

subtitle

string

Kart başlığının alt başlığı.

image_style

ImageStyle

Resmin türü (ör. kare kenarlık veya dairesel kenarlık).

image_url

string

Kart başlığındaki resmin URL'si.

ImageStyle

Sıralamalar
IMAGE_STYLE_UNSPECIFIED
IMAGE Kare kenarlık.
AVATAR Dairesel kenarlık.

Bölüm

Bir bölüm, belirtildikleri sırayla (dikey olarak) oluşturulan bir widget koleksiyonu içerir. Kartlar tüm platformlarda dar ve sabit bir genişliğe sahip olduğundan şu anda düzen özelliklerine (ör. kaydırma) gerek yoktur.

Alanlar
header

string

Bölümün başlığı. Biçimlendirilmiş metin desteklenir. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metin biçimlendirme ve Google Workspace eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

widgets[]

WidgetMarkup

Bir bölüm en az bir widget içermelidir.

CreateCustomEmojiRequest

Özel emoji oluşturma isteği.

Alanlar
custom_emoji

CustomEmoji

Zorunlu. Oluşturulacak özel emoji.

CreateMembershipRequest

Üyelik oluşturma için istek mesajı.

Alanlar
parent

string

Zorunlu. Üyeliğin oluşturulacağı alanın kaynak adı.

Biçim: spaces/{space}

membership

Membership

Zorunlu. Oluşturulacak üyelik ilişkisi.

memberType alanı, user.name ve user.type alanları doldurulmuş bir kullanıcı içermelidir. Sunucu, bir kaynak adı atar ve belirtilen her şeyi üzerine yazar.

Bir sohbet uygulaması, gerçek bir kullanıcı için üyelik ilişkisi oluşturduğunda belirli yetkilendirme kapsamlarını kullanmalı ve belirli alanlar için belirli değerler ayarlamalıdır:

  • Kullanıcı olarak kimlik doğrulanırken chat.memberships yetkilendirme kapsamı gereklidir.

  • Uygulama olarak kimlik doğrulaması yapılırken chat.app.memberships yetkilendirme kapsamı gerekir. Uygulama olarak kimlik doğrulama şu ülkelerde kullanılabilir:

  • user.type öğesini HUMAN olarak, user.name öğesini ise users/{user} biçiminde ayarlayın. Burada {user}, kullanıcının e-posta adresi olabilir. Aynı Workspace kuruluşundaki kullanıcılar için {user}, People API'deki kişinin id'si veya Directory API'deki kullanıcının id'si de olabilir. Örneğin, user@example.com için People API Kişi profili kimliği 123456789 ise membership.member.name değerini users/user@example.com veya users/123456789 olarak ayarlayarak kullanıcıyı alana ekleyebilirsiniz.

Alanın sahibi olan Workspace kuruluşunun dışındaki kullanıcıları davet etmek için kullanıcı kimlik doğrulaması gerekir.

Bir Chat uygulaması kendisi için üyelik ilişkisi oluşturduğunda kullanıcı olarak kimliğini doğrulamalı, chat.memberships.app kapsamını kullanmalı, user.type değerini BOT olarak ve user.name değerini users/app olarak ayarlamalıdır.

use_admin_access

bool

İsteğe bağlıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.memberships OAuth 2.0 kapsamı gerektirir.

Yönetici erişimi kullanılarak uygulama üyelikleri veya yöneticinin Google Workspace kuruluşu dışındaki kullanıcılar için üyelikler oluşturulması desteklenmez.

CreateMessageRequest

İleti oluşturur.

Alanlar
parent

string

Zorunlu. Mesajın oluşturulacağı alanın kaynak adı.

Biçim: spaces/{space}

message

Message

Zorunlu. İleti gövdesi.

thread_key
(deprecated)

string

İsteğe bağlıdır. Desteği sonlandırıldı: Bunun yerine thread.thread_key politikasını kullanın. İleti dizisinin kimliği. En fazla 4.000 karakter desteklenir. Bir ileti dizisi başlatmak veya ileti dizisine ekleme yapmak için bir mesaj oluşturun ve threadKey veya thread.name simgesini belirtin. Kullanım örneği için Mesaj dizisi başlatma veya yanıtlama başlıklı makaleyi inceleyin.

request_id

string

İsteğe bağlıdır. Bu ileti için benzersiz bir istek kimliği. Mevcut bir istek kimliğini belirtmek, yeni bir mesaj oluşturmak yerine bu kimlikle oluşturulan mesajı döndürür.

message_reply_option

MessageReplyOption

İsteğe bağlıdır. Bir mesajın ileti dizisi başlatıp başlatmadığını veya bir ileti dizisini yanıtlayıp yanıtlamadığını belirtir. Yalnızca adlandırılmış alanlarda desteklenir.

Kullanıcı etkileşimlerine yanıt verirken bu alan yoksayılır. Bir ileti dizisindeki etkileşimler için yanıt aynı ileti dizisinde oluşturulur. Aksi takdirde yanıt yeni bir ileti dizisi olarak oluşturulur.

message_id

string

İsteğe bağlıdır. İleti için özel kimlik. Chat uygulamalarının, sistem tarafından atanan kimliği mesajın kaynak adında (mesaj name alanında gösterilir) depolamasına gerek kalmadan mesaj almasına, güncellemesine veya silmesine olanak tanır.

Bu alanın değeri aşağıdaki koşulları karşılamalıdır:

  • client- ile başlar. Örneğin, client-custom-name geçerli bir özel kimliktir ancak custom-name geçerli değildir.
  • En fazla 63 karakter içerir ve yalnızca küçük harf, rakam ve kısa çizgi içerebilir.
  • Bir alan içinde benzersiz olmalıdır. Bir sohbet uygulaması, farklı mesajlar için aynı özel kimliği kullanamaz.

Ayrıntılar için İletileri adlandırma başlıklı makaleyi inceleyin.

MessageReplyOption

Bir iletiye nasıl yanıt verileceğini belirtir. Gelecekte daha fazla eyalet eklenebilir.

Sıralamalar
MESSAGE_REPLY_OPTION_UNSPECIFIED Varsayılan. Yeni bir ileti dizisi başlatır. Bu seçeneği kullandığınızda eklenen tüm thread ID veya thread_key yoksayılır.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD thread ID veya thread_key ile belirtilen ileti dizisine yanıt olarak mesaj oluşturur. Bu işlem başarısız olursa ileti yeni bir ileti dizisi başlatır.
REPLY_MESSAGE_OR_FAIL thread ID veya thread_key ile belirtilen ileti dizisine yanıt olarak mesaj oluşturur. Yeni bir thread_key kullanılıyorsa yeni bir ileti dizisi oluşturulur. İleti oluşturma işlemi başarısız olursa bunun yerine NOT_FOUND hatası döndürülür.

CreateReactionRequest

Mesajlara tepki oluşturur.

Alanlar
parent

string

Zorunlu. Tepkinin oluşturulduğu mesaj.

Biçim: spaces/{space}/messages/{message}

reaction

Reaction

Zorunlu. Oluşturulacak tepki.

CreateSpaceRequest

Üyesi olmayan adlandırılmış bir alan oluşturma isteği.

Alanlar
space

Space

Zorunlu. displayName ve spaceType alanları doldurulmalıdır. Yalnızca SpaceType.SPACE ve SpaceType.GROUP_CHAT desteklenir. SpaceType.GROUP_CHAT yalnızca importMode doğru olarak ayarlanmışsa kullanılabilir.

ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

Alan name sunucuda atanır. Bu nedenle, bu alanda belirtilen her şey yoksayılır.

request_id

string

İsteğe bağlıdır. Bu isteğin benzersiz tanımlayıcısıdır. Rastgele bir UUID önerilir. Mevcut bir istek kimliğini belirtmek, yeni bir alan oluşturmak yerine bu kimlikle oluşturulan alanı döndürür. Farklı bir kimliği doğrulanmış kullanıcıyla aynı Chat uygulamasından mevcut bir istek kimliğini belirtmek hata döndürür.

CustomEmoji

Özel emojiyi temsil eder.

Alanlar
name

string

Tanımlayıcı. Sunucu tarafından atanan özel emojinin kaynak adı.

Biçim: customEmojis/{customEmoji}

uid

string

Yalnızca çıkış. Özel emoji kaynağı için benzersiz anahtar.

emoji_name

string

İsteğe bağlıdır. Değişmez. Özel emoji için kullanıcı tarafından sağlanan ve kuruluş içinde benzersiz olan ad.

Özel emoji oluşturulurken gereklidir, aksi takdirde yalnızca çıkış yapılır.

Emoji adları iki nokta üst üste işaretiyle başlayıp bitmelidir. Küçük harfle yazılmalı ve yalnızca alfanümerik karakterler, kısa çizgiler ve alt çizgiler içerebilir. Kelimeleri ayırmak için kısa çizgi ve alt çizgi kullanılmalıdır ancak bunlar art arda kullanılamaz.

Örnek: :valid-emoji-name:

temporary_image_uri

string

Yalnızca çıkış. Özel emoji için en az 10 dakika geçerli olan geçici bir resim URL'si. Özel emoji oluşturulduğunda bu alanın yanıtta doldurulmadığını unutmayın.

payload

CustomEmojiPayload

İsteğe bağlıdır. Yalnızca giriş. Yük verileri. Özel emoji oluşturulurken gereklidir.

CustomEmojiPayload

Özel emoji için yük verileri.

Alanlar
file_content

bytes

Zorunlu. Yalnızca giriş. Özel emoji için kullanılan resim.

Yük boyutu 256 KB'tan küçük olmalı ve resmin boyutu kare biçiminde olup 64 ile 500 piksel arasında olmalıdır. Kısıtlamalar değişebilir.

filename

string

Zorunlu. Yalnızca giriş. Resim dosyasının adı.

Desteklenen dosya uzantıları: .png, .jpg, .gif.

CustomEmojiMetadata

Özel emoji'ler için açıklama meta verileri.

Alanlar
custom_emoji

CustomEmoji

Özel emoji

DeleteCustomEmojiRequest

Özel emoji silme isteği.

Alanlar
name

string

Zorunlu. Silinecek özel emojinin kaynak adı.

Biçim: customEmojis/{customEmoji}

Emoji adını {customEmoji} için takma ad olarak kullanabilirsiniz. Örneğin, customEmojis/:example-emoji:. Burada :example-emoji:, özel bir emojinin emoji adıdır.

DeleteMembershipRequest

Bir alandaki üyeliğin silinmesini isteme

Alanlar
name

string

Zorunlu. Silinecek üyeliğin kaynak adı. Sohbet uygulamaları, kullanıcıların veya kendi üyeliklerini silebilir. Sohbet uygulamaları, diğer uygulamaların üyeliklerini silemez.

Bir kullanıcı üyeliği silinirken kullanıcı kimlik doğrulaması ile chat.memberships kapsamı veya uygulama kimlik doğrulaması ile chat.memberships.app kapsamı ve spaces/{space}/members/{member} biçimi gerekir. E-postayı {member} için takma ad olarak kullanabilirsiniz. Örneğin, spaces/{space}/members/example@gmail.com. Burada example@gmail.com, Google Chat kullanıcısının e-posta adresidir.

Uygulama üyeliği silinirken chat.memberships.app kapsamı ve spaces/{space}/members/app biçimi gerekir.

Biçim: spaces/{space}/members/{member} veya spaces/{space}/members/app.

use_admin_access

bool

İsteğe bağlıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.memberships OAuth 2.0 kapsamı gerektirir.

Bir alandaki uygulama üyeliklerinin silinmesi, yönetici erişimi kullanılarak desteklenmez.

DeleteMessageRequest

Mesaj silme isteği.

Alanlar
name

string

Zorunlu. İletinin kaynak adı.

Biçim: spaces/{space}/messages/{message}

İletiniz için özel bir kimlik ayarladıysanız clientAssignedMessageId alanındaki değeri {message} için kullanabilirsiniz. Ayrıntılar için İletileri adlandırma başlıklı makaleyi inceleyin.

force

bool

İsteğe bağlıdır. true olduğunda, bir mesajı sildiğinizde ileti dizisindeki yanıtlar da silinir. false olduğunda, bir iletinin ileti dizisi şeklinde yanıtları varsa silme işlemi başarısız olur.

Yalnızca kullanıcı olarak kimlik doğrulama sırasında geçerlidir. Chat uygulaması olarak kimlik doğrulaması yapılırken herhangi bir etkisi yoktur.

DeleteReactionRequest

Mesajlara verilen tepkileri siler.

Alanlar
name

string

Zorunlu. Silinecek tepkinin adı.

Biçim: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

Alan silme isteği

Alanlar
name

string

Zorunlu. Silinecek alanın kaynak adı.

Biçim: spaces/{space}

use_admin_access

bool

İsteğe bağlıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.delete OAuth 2.0 kapsamı gerektirir.

DeletionMetadata

Silinen bir iletiyle ilgili bilgiler. delete_time ayarlandığında mesaj silinir.

Alanlar
deletion_type

DeletionType

Mesajı kimin sildiğini gösterir.

DeletionType

İletiyi kimin ve nasıl sildiği Gelecekte daha fazla değer eklenebilir. Mesajların ne zaman silinebileceği hakkında ayrıntılı bilgi için Google Chat'te mesaj düzenleme veya silme başlıklı makaleyi inceleyin.

Sıralamalar
DELETION_TYPE_UNSPECIFIED Bu değer kullanılmıyor.
CREATOR Kullanıcı kendi mesajını silmiştir.
SPACE_OWNER Bir alan yöneticisi mesajı sildi.
ADMIN Bir Google Workspace yöneticisi mesajı sildi. Yöneticiler, alan üyeleri veya Chat uygulaması tarafından gönderilen mesajlar da dahil olmak üzere alandaki tüm mesajları silebilir.
APP_MESSAGE_EXPIRY Bir Chat uygulaması, süresi dolduğunda kendi mesajını sildi.
CREATOR_VIA_APP Bir Chat uygulaması, mesajı içerik üretici adına (kullanıcı kimlik doğrulamasını kullanarak) sildi.
SPACE_OWNER_VIA_APP Bir Chat uygulaması, alan yöneticisi adına (kullanıcı kimlik doğrulaması kullanarak) mesajı sildi.
SPACE_MEMBER Mesaj, alanın bir üyesi tarafından silindi. Kullanıcılar, uygulamalar tarafından gönderilen mesajları silebilir.

Dialog

İletişim kutusunun kart gövdesini saran sarmalayıcı.

Alanlar
body

Card

Yalnızca giriş. İletişim kutusunun gövdesi, modal olarak oluşturulur. Google Chat uygulamaları şu kart öğelerini desteklemez: DateTimePicker, OnChangeAction.

DialogAction

İletişim kutusu ve istek durum kodu içerir.

Alanlar
action_status

ActionStatus

Yalnızca giriş. Diyalog çağırma veya gönderme isteğinin durumu. Gerekirse kullanıcılara bir durum ve mesaj gösterir. Örneğin, hata veya başarı durumunda.

Birleştirme alanı action. Gerçekleştirilecek işlem. action yalnızca aşağıdakilerden biri olabilir:
dialog

Dialog

Yalnızca giriş. İstekle ilgili iletişim kutusu.

DriveDataRef

Drive eki verilerine referans.

Alanlar
drive_file_id

string

Drive dosyasının kimliği. Drive API ile kullanma

DriveLinkData

Google Drive bağlantılarının verileri.

Alanlar
drive_data_ref

DriveDataRef

Google Drive dosyasına referans veren bir DriveDataRef.

mime_type

string

Bağlı Google Drive kaynağının MIME türü.

Emoji

Bir mesaja tepki olarak kullanılan emoji.

Alanlar
Birleştirme alanı content. Zorunlu. Emoji'nin içeriği. content yalnızca aşağıdakilerden biri olabilir:
unicode

string

İsteğe bağlıdır. Unicode dizesiyle gösterilen temel emoji.

custom_emoji

CustomEmoji

Özel bir emoji.

EmojiReactionSummary

Bir mesaja belirli bir emoji ile tepki veren kullanıcıların sayısı.

Alanlar
emoji

Emoji

Yalnızca çıkış. Tepkilerle ilişkili emoji.

reaction_count

int32

Yalnızca çıkış. İlişkili emoji kullanılarak verilen toplam tepki sayısı.

FindDirectMessageRequest

Kullanıcı kaynağına dayalı olarak doğrudan mesaj alanı alma isteği.

Alanlar
name

string

Zorunlu. Doğrudan mesaj gönderilen kullanıcının kaynak adı.

Biçim: users/{user}. Burada {user}, People API'deki kişinin id'si veya Directory API'deki kullanıcının id'sidir. Örneğin, People API profil kimliği 123456789 ise users/123456789 değerini name olarak kullanarak ilgili kişiyle olan doğrudan mesajı bulabilirsiniz. Kullanıcı olarak kimlik doğruladığınızda e-postayı {user} için takma ad olarak kullanabilirsiniz. Örneğin, users/example@gmail.com. Burada example@gmail.com, Google Chat kullanıcısının e-posta adresidir.

GetAttachmentRequest

Ek alma isteğinde bulunma

Alanlar
name

string

Zorunlu. Ekin kaynak adı, spaces/{space}/messages/{message}/attachments/{attachment} biçiminde.

GetCustomEmojiRequest

Tek bir özel emojiyi döndürme isteği.

Alanlar
name

string

Zorunlu. Özel emojinin kaynak adı.

Biçim: customEmojis/{customEmoji}

Emoji adını {customEmoji} için takma ad olarak kullanabilirsiniz. Örneğin, customEmojis/:example-emoji:. Burada :example-emoji:, özel bir emojinin emoji adıdır.

GetMembershipRequest

Bir alanın üyeliğini alma isteği.

Alanlar
name

string

Zorunlu. Alınacak üyeliğin kaynak adı.

Kullanıcı kimlik doğrulamayı kullanarak uygulamanın kendi üyeliğini almak için isteğe bağlı olarak spaces/{space}/members/app kullanabilirsiniz.

Biçim: spaces/{space}/members/{member} veya spaces/{space}/members/app

Kullanıcının e-posta adresini {member} için takma ad olarak kullanabilirsiniz. Örneğin, spaces/{space}/members/example@gmail.com. Burada example@gmail.com, Google Chat kullanıcısının e-posta adresidir.

use_admin_access

bool

İsteğe bağlıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.memberships veya chat.admin.memberships.readonly OAuth 2.0 kapsamlarını gerektirir.

Yönetici erişimi kullanılırken bir alanda uygulama üyeliği alma özelliği desteklenmez.

GetMessageRequest

Mesaj alma isteği

Alanlar
name

string

Zorunlu. İletinin kaynak adı.

Biçim: spaces/{space}/messages/{message}

İletiniz için özel bir kimlik ayarladıysanız clientAssignedMessageId alanındaki değeri {message} için kullanabilirsiniz. Ayrıntılar için İletileri adlandırma başlıklı makaleyi inceleyin.

GetSpaceEventRequest

Alan etkinliği alma isteği mesajı.

Alanlar
name

string

Zorunlu. Alan etkinliğinin kaynak adı.

Biçim: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceNotificationSettingRequest

Alan bildirimi ayarını almak için mesaj isteğinde bulunun. Yalnızca görüşme yapan kullanıcının bildirim ayarını almayı destekler.

Alanlar
name

string

Zorunlu. Biçim: users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting veya
  • users/user@example.com/spaces/{space}/spaceNotificationSetting veya
  • users/123456789/spaces/{space}/spaceNotificationSetting. Not: Yalnızca arayanın kullanıcı kimliğine veya e-posta adresine izin verilir.

GetSpaceReadStateRequest

GetSpaceReadState API'si için istek mesajı.

Alanlar
name

string

Zorunlu. Alınacak alan okunma durumunun kaynak adı.

Yalnızca arayan kullanıcının okunma durumunu almayı destekler.

Arayan kullanıcıya başvurmak için aşağıdakilerden birini ayarlayın:

  • me takma adı. Örneğin, users/me/spaces/{space}/spaceReadState.

  • Workspace e-posta adresleri Örneğin, users/user@example.com/spaces/{space}/spaceReadState.

  • Kullanıcı kimliği Örneğin, users/123456789/spaces/{space}/spaceReadState.

Biçim: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

Tek bir boşluk döndürme isteği.

Alanlar
name

string

Zorunlu. Alan kaynak adı, spaces/{space} biçiminde.

Biçim: spaces/{space}

use_admin_access

bool

İsteğe bağlıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.spaces veya chat.admin.spaces.readonly OAuth 2.0 kapsamlarını gerektirir.

GetThreadReadStateRequest

GetThreadReadStateRequest API'si için istek mesajı.

Alanlar
name

string

Zorunlu. Alınacak ileti dizisi okuma durumunun kaynak adı.

Yalnızca arayan kullanıcının okunma durumunu almayı destekler.

Arayan kullanıcıya başvurmak için aşağıdakilerden birini ayarlayın:

  • me takma adı. Örneğin, users/me/spaces/{space}/threads/{thread}/threadReadState.

  • Workspace e-posta adresleri Örneğin, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

  • Kullanıcı kimliği Örneğin, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Biçim: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Grup

Google Chat'te Google Grubu.

Alanlar
name

string

Google Grubu'nun kaynak adı.

Cloud Identity Groups API'deki bir grubu temsil eder.

Biçim: groups/{group}

HistoryState

Mesajlar ve alanlar için geçmiş durumu. İletilerin ve ileti dizilerinin oluşturulduktan sonra ne kadar süreyle saklanacağını belirtir.

Sıralamalar
HISTORY_STATE_UNSPECIFIED Varsayılan değer. Kullanmayın.
HISTORY_OFF Geçmişe kayıt kapalı. İletiler ve ileti dizileri 24 saat boyunca saklanır.
HISTORY_ON Geçmişe kayıt açık. İletilerin ve ileti dizilerinin ne kadar süreyle saklanacağını kuruluşun Apps Kasası saklama kuralları belirler.

ListCustomEmojisRequest

Özel emoji listesi döndürme isteği.

Alanlar
page_size

int32

İsteğe bağlıdır. Döndürülen maksimum özel emoji sayısı. Hizmet, bu değerden daha az sayıda özel emoji döndürebilir. Belirtilmediği takdirde varsayılan değer 25'tir. Maksimum değer 200'dür. 200'ün üzerindeki değerler 200 olarak değiştirilir.

page_token

string

İsteğe bağlıdır. (Önceki bir sorgudan devam ediyorsanız.)

Önceki bir list custom emoji çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın.

Sayfalama yaparken filtre değeri, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Farklı bir değer iletmek beklenmedik sonuçlara yol açabilir.

filter

string

İsteğe bağlıdır. Sorgu filtresi.

İçerik üreticiye göre filtrelemeyi destekler.

İçerik üreticiye göre filtrelemek için geçerli bir değer belirtmeniz gerekir. Şu anda özel emojileri, arayan kullanıcı tarafından oluşturulup oluşturulmadıklarına göre filtrelemek için yalnızca creator("users/me") ve NOT creator("users/me") kabul edilmektedir.

Örneğin, aşağıdaki sorgu, arayan tarafından oluşturulan özel emojileri döndürür:

creator("users/me")

Geçersiz sorgular INVALID_ARGUMENT hatasıyla reddedilir.

ListCustomEmojisResponse

Özel emojileri listeleme yanıtı.

Alanlar
custom_emojis[]

CustomEmoji

Sırasız liste. Özel emojilerin listesi.

next_page_token

string

Sonuçların bir sonraki sayfasını almak için pageToken olarak gönderebileceğiniz bir jeton. Boşsa sonraki sayfa yoktur.

ListMembershipsRequest

Listeleme üyelikleri için istek mesajı.

Alanlar
parent

string

Zorunlu. Üyelik listesinin getirileceği alanın kaynak adı.

Biçim: spaces/{space}

page_size

int32

İsteğe bağlıdır. Döndürülecek maksimum üyelik sayısı. Hizmet, bu değerden daha az sonuç döndürebilir.

Belirtilmemesi halinde en fazla 100 üyelik döndürülür.

Maksimum değer 1.000'dir. 1.000'den büyük bir değer kullanırsanız bu değer otomatik olarak 1.000 olarak değiştirilir.

Negatif değerler INVALID_ARGUMENT hatası döndürür.

page_token

string

İsteğe bağlıdır. Üyelikleri listelemek için yapılan önceki bir çağrıdan alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalama yapılırken sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler iletmek beklenmedik sonuçlara yol açabilir.

filter

string

İsteğe bağlıdır. Sorgu filtresi.

Üyelikleri, üyenin rolüne (role) ve türüne (member.type) göre filtreleyebilirsiniz.

Role göre filtrelemek için role öğesini ROLE_MEMBER veya ROLE_MANAGER olarak ayarlayın.

Türe göre filtrelemek için member.type öğesini HUMAN veya BOT olarak ayarlayın. != operatörünü kullanarak member.type için de filtreleme yapabilirsiniz.

Hem role hem de türe göre filtrelemek için AND operatörünü kullanın. Role veya türe göre filtrelemek için OR operatörünü kullanın.

use_admin_access doğru olarak ayarlandığında member.type = "HUMAN" veya member.type != "BOT" gereklidir. Diğer üyelik türü filtreleri reddedilir.

Örneğin, aşağıdaki sorgular geçerlidir:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Şu sorgular geçersiz:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Geçersiz sorgular, sunucu tarafından INVALID_ARGUMENT hatasıyla reddedilir.

show_groups

bool

İsteğe bağlıdır. true olduğunda diğer üyelik türlerinin yanı sıra Google Group ile ilişkili üyelikler de döndürülür. filter ayarlanırsa filtreleme ölçütleriyle eşleşmeyen Google Group üyelikleri döndürülmez.

show_invited

bool

İsteğe bağlıdır. true olduğunda, diğer üyelik türlerinin yanı sıra invited üyeleriyle ilişkili üyelikler de döndürülür. Filtre ayarlanırsa filtre ölçütleriyle eşleşmeyen invited üyelikleri döndürülmez.

Şu anda kullanıcı kimlik doğrulaması gerektirir.

use_admin_access

bool

İsteğe bağlıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.memberships.readonly veya chat.admin.memberships OAuth 2.0 kapsamı gerektirir.

Yönetici erişimi kullanılırken bir alandaki uygulama üyeliklerini listeleme desteklenmez.

ListMembershipsResponse

Alan üyeliklerinin listesine yanıt verilir.

Alanlar
memberships[]

Membership

Sırasız liste. İstenen (veya ilk) sayfadaki üyeliklerin listesi.

next_page_token

string

Sonuçların bir sonraki sayfasını almak için pageToken olarak gönderebileceğiniz bir jeton. Boşsa sonraki sayfa yoktur.

ListMessagesRequest

Kullanıcının üyesi olduğu belirtilen alandaki mesajları listeler.

Alanlar
parent

string

Zorunlu. İletilerin listeleneceği alanın kaynak adı.

Biçim: spaces/{space}

page_size

int32

İsteğe bağlıdır. Döndürülen maksimum mesaj sayısı. Hizmet, bu değerden daha az ileti döndürebilir.

Belirtilmemesi halinde en fazla 25 öğe döndürülür.

Maksimum değer 1.000'dir. 1.000'den büyük bir değer kullanırsanız bu değer otomatik olarak 1.000 olarak değiştirilir.

Negatif değerler INVALID_ARGUMENT hatası döndürür.

page_token

string

İsteğe bağlıdır. Önceki bir list messages çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalama yapılırken sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler iletmek beklenmedik sonuçlara yol açabilir.

filter

string

İsteğe bağlıdır. Sorgu filtresi.

İletileri tarihe (create_time) ve ileti dizisine (thread.name) göre filtreleyebilirsiniz.

İletileri oluşturuldukları tarihe göre filtrelemek için create_time değerini RFC-3339 biçiminde ve çift tırnak işaretleriyle zaman damgasıyla birlikte belirtin. Örneğin, "2023-04-21T11:30:00-04:00". Zaman damgasından sonra oluşturulan iletileri listelemek için büyüktür operatörünü (>), zaman damgasından önce oluşturulan iletileri listelemek için ise küçüktür operatörünü (<) kullanabilirsiniz. İletileri belirli bir zaman aralığında filtrelemek için iki zaman damgası arasında AND operatörünü kullanın.

İleti dizisine göre filtrelemek için thread.name değerini spaces/{space}/threads/{thread} olarak biçimlendirerek belirtin. Sorgu başına yalnızca bir thread.name belirtebilirsiniz.

Hem ileti dizisine hem de tarihe göre filtrelemek için sorgunuzda AND operatörünü kullanın.

Örneğin, aşağıdaki sorgular geçerlidir:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Geçersiz sorgular, sunucu tarafından INVALID_ARGUMENT hatasıyla reddedilir.

order_by

string

İsteğe bağlıdır. İletilerin listesinin sıralanma şekli. Sıralama işlemine göre sıralanacak bir değer belirtin. Geçerli sıralama işlemi değerleri şunlardır:

  • Artan sıra için ASC.

  • Azalan düzende sıralamak için DESC.

Varsayılan sıralama create_time ASC'dır.

show_deleted

bool

İsteğe bağlıdır. Silinen iletilerin dahil edilip edilmeyeceği Silinen iletiler, silinme zamanını ve silinmeyle ilgili meta verileri içerir ancak ileti içeriği kullanılamaz.

ListMessagesResponse

Listeleme iletileri için yanıt mesajı.

Alanlar
messages[]

Message

Mesaj listesi.

next_page_token

string

Sonraki sonuç sayfasını almak için pageToken olarak bir jeton gönderebilirsiniz. Boşsa sonraki sayfa yoktur.

ListReactionsRequest

Bir mesaja verilen tepkileri listeler.

Alanlar
parent

string

Zorunlu. Kullanıcıların tepki verdiği mesaj.

Biçim: spaces/{space}/messages/{message}

page_size

int32

İsteğe bağlıdır. Döndürülen maksimum tepki sayısı. Hizmet, bu değerden daha az tepki döndürebilir. Belirtilmediği takdirde varsayılan değer 25'tir. Maksimum değer 200'dür. 200'ün üzerindeki değerler 200 olarak değiştirilir.

page_token

string

İsteğe bağlıdır. (Önceki bir sorgudan devam ediyorsanız.)

Önceki list reactions (tepkileri listele) çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın.

Sayfalama yaparken filtre değeri, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Farklı bir değer iletmek beklenmedik sonuçlara yol açabilir.

filter

string

İsteğe bağlıdır. Sorgu filtresi.

Tepkileri emoji (emoji.unicode veya emoji.custom_emoji.uid) ve kullanıcıya (user.name) göre filtreleyebilirsiniz.

Tepkileri birden fazla emoji veya kullanıcıya göre filtrelemek için benzer alanları OR operatörüyle birleştirin (ör. emoji.unicode = "🙂" OR emoji.unicode = "👍" ve user.name = "users/AAAAAA" OR user.name = "users/BBBBBB").

Tepkileri emojiye ve kullanıcıya göre filtrelemek için AND operatörünü (ör. emoji.unicode = "🙂" AND user.name = "users/AAAAAA") kullanın.

Sorgunuzda hem AND hem de OR kullanılıyorsa bunları parantez içinde gruplandırın.

Örneğin, aşağıdaki sorgular geçerlidir:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Şu sorgular geçersiz:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Geçersiz sorgular INVALID_ARGUMENT hatasıyla reddedilir.

ListReactionsResponse

Tepkileri listeleme isteğine verilen yanıt.

Alanlar
reactions[]

Reaction

İstenen (veya ilk) sayfadaki tepkilerin listesi.

next_page_token

string

Sonraki sonuç sayfasını almak için devamlılık jetonu. Sonuçların son sayfasında boştur.

ListSpaceEventsRequest

Listeleme alanı etkinlikleri için istek mesajı.

Alanlar
parent

string

Zorunlu. Etkinliklerin gerçekleştiği Google Chat alanının kaynak adı.

Biçim: spaces/{space}.

page_size

int32

İsteğe bağlıdır. Döndürülen maksimum alan etkinliği sayısı. Hizmet, bu değerden daha az sonuç döndürebilir.

Negatif değerler INVALID_ARGUMENT hatası döndürür.

page_token

string

İsteğe bağlıdır. Önceki bir list space events çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın.

Sayfalara ayırma işlemi yapılırken, liste alanı etkinlikleri için sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler iletmek beklenmedik sonuçlara yol açabilir.

filter

string

Zorunlu. Sorgu filtresi.

has : operatörünü kullanarak en az bir etkinlik türü (event_type) belirtmeniz gerekir. Birden fazla etkinlik türüne göre filtrelemek için OR operatörünü kullanın. Filtrenizde toplu etkinlik türlerini hariç tutun. İstek, ilgili tüm toplu etkinlikleri otomatik olarak döndürür. Örneğin, yeni tepkilere (google.workspace.chat.reaction.v1.created) göre filtreleme yaparsanız sunucu, toplu yeni tepki etkinliklerini (google.workspace.chat.reaction.v1.batchCreated) de döndürür. Desteklenen etkinlik türlerinin listesi için SpaceEvents referans belgelerine bakın.

İsteğe bağlı olarak, başlangıç zamanına (start_time) ve bitiş zamanına (end_time) göre de filtre uygulayabilirsiniz:

  • start_time: Alan etkinliklerinin listelenmeye başlanacağı özel zaman damgası. 28 gün öncesine kadar gerçekleşen etkinlikleri listeleyebilirsiniz. Belirtilmediyse son 28 gündeki alan etkinliklerini listeler.
  • end_time: Alan etkinliklerinin listelendiği son zaman damgası. Belirtilmediyse etkinlikleri istek zamanına kadar listeler.

Başlangıç veya bitiş zamanı belirtmek için eşittir = operatörünü kullanın ve RFC-3339 biçiminde ayarlayın. Hem start_time hem de end_time ile filtrelemek için AND operatörünü kullanın.

Örneğin, aşağıdaki sorgular geçerlidir:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"
start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Şu sorgular geçersiz:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"
event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Geçersiz sorgular, sunucu tarafından INVALID_ARGUMENT hatasıyla reddedilir.

ListSpaceEventsResponse

Listeleme alanı etkinlikleri için yanıt mesajı.

Alanlar
space_events[]

SpaceEvent

Sonuçlar kronolojik sırayla (en eski etkinlik önce) döndürülür. Not: permissionSettings alanı, liste istekleri için Space nesnesinde döndürülmez.

next_page_token

string

Daha fazla etkinlik getirmek için kullanılan devamlılık jetonu. Bu alan atlanırsa sonraki sayfa olmaz.

ListSpacesRequest

Arayanın üyesi olduğu alanların listelenmesi isteği.

Alanlar
page_size

int32

İsteğe bağlıdır. Döndürülecek maksimum alan sayısı. Hizmet, bu değerden daha az sonuç döndürebilir.

Belirtilmezse en fazla 100 boşluk döndürülür.

Maksimum değer 1.000'dir. 1.000'den büyük bir değer kullanırsanız bu değer otomatik olarak 1.000 olarak değiştirilir.

Negatif değerler INVALID_ARGUMENT hatası döndürür.

page_token

string

İsteğe bağlıdır. Önceki bir list spaces çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalama yaparken filtre değeri, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Farklı bir değer iletmek beklenmedik sonuçlara yol açabilir.

filter

string

İsteğe bağlıdır. Sorgu filtresi.

Alanları alan türüne (space_type) göre filtreleyebilirsiniz.

Alan türüne göre filtrelemek için SPACE veya GROUP_CHAT gibi geçerli bir enum değeri belirtmeniz gerekir (space_type, SPACE_TYPE_UNSPECIFIED olamaz). Birden fazla alan türü için sorgu oluşturmak istiyorsanız OR operatörünü kullanın.

Örneğin, aşağıdaki sorgular geçerlidir:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Geçersiz sorgular, sunucu tarafından INVALID_ARGUMENT hatasıyla reddedilir.

ListSpacesResponse

Alanları listeleme isteğinin yanıtı.

Alanlar
spaces[]

Space

İstenen (veya ilk) sayfadaki alanların listesi. Not: permissionSettings alanı, liste istekleri için Space nesnesinde döndürülmez.

next_page_token

string

Sonraki sonuç sayfasını almak için pageToken olarak bir jeton gönderebilirsiniz. Boşsa sonraki sayfa yoktur.

MatchedUrl

Chat mesajında eşleşen bir URL. Sohbet uygulamaları, eşleşen URL'leri önizleyebilir. Daha fazla bilgi için Bağlantıları önizleme başlıklı makaleyi inceleyin.

Alanlar
url

string

Yalnızca çıkış. Eşleşen URL.

Üyelik

Google Chat'teki üyelik ilişkisini (ör. bir kullanıcının veya Chat uygulamasının bir alana davet edilip edilmediği, alanın parçası olup olmadığı ya da alanda bulunup bulunmadığı) gösterir.

Alanlar
name

string

Tanımlayıcı. Sunucu tarafından atanan üyeliğin kaynak adı.

Biçim: spaces/{space}/members/{member}

state

MembershipState

Yalnızca çıkış. Üyeliğin durumu.

role

MembershipRole

İsteğe bağlıdır. Kullanıcının Chat alanındaki rolü, alanda izin verilen işlemlerini belirler.

Bu alan yalnızca UpdateMembership içinde giriş olarak kullanılabilir.

create_time

Timestamp

İsteğe bağlıdır. Değişmez. Üyeliğin oluşturulma zamanı (ör. bir üyenin alana katıldığı veya alana katılmaya davet edildiği zaman). Bu alan, içe aktarma modundaki alanlara geçmiş üyelikleri aktarmak için kullanılması dışında yalnızca çıkış olarak kullanılır.

delete_time

Timestamp

İsteğe bağlıdır. Değişmez. Üyeliğin silinme zamanı (ör. bir üye alandan ayrıldığında veya çıkarıldığında) Bu alan, içe aktarma modundaki alanlara geçmiş üyelikleri aktarmak için kullanılması dışında yalnızca çıkış olarak kullanılır.

Birleştirme alanı memberType. Bu üyelikle ilişkili üye. Gelecekte diğer üyelik türleri de desteklenebilir. memberType yalnızca aşağıdakilerden biri olabilir:
member

User

İsteğe bağlıdır. Üyeliğin karşılık geldiği Google Chat kullanıcısı veya uygulaması. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa çıkışta user name ve type alanları doldurulur.

group_member

Group

İsteğe bağlıdır. Üyeliğin karşılık geldiği Google Grubu.

Google Gruplar'daki üyelikleri okumak veya değiştirmek için kullanıcı kimlik doğrulaması gerekir.

MembershipRole

Bir kullanıcının Chat alanında izin verilen işlemlerini temsil eder. Gelecekte daha fazla enum değeri eklenebilir.

Sıralamalar
MEMBERSHIP_ROLE_UNSPECIFIED Varsayılan değer. users için: Kullanıcı alanın üyesi değildir ancak davet edilebilir. Google Groups için: Bu rol her zaman atanır (gelecekte diğer enum değerleri kullanılabilir).
ROLE_MEMBER Alan üyesi Kullanıcı, alana mesaj gönderme gibi temel izinlere sahip olmalıdır. 1:1 görüşmelerde ve adsız grup görüşmelerinde herkes bu role sahiptir.
ROLE_MANAGER Alan yöneticisi Kullanıcı, tüm temel izinlere ve alan yönetimine olanak tanıyan (ör. üye ekleme veya kaldırma) yönetici izinlerine sahiptir. Yalnızca SpaceType.SPACE sürümünde desteklenir.

MembershipState

Üyenin alanla ilişkisini belirtir. Gelecekte diğer üye devletler de desteklenebilir.

Sıralamalar
MEMBERSHIP_STATE_UNSPECIFIED Varsayılan değer. Kullanmayın.
JOINED Kullanıcı alana eklenir ve alana katılabilir.
INVITED Kullanıcı, alana katılmaya davet edilmiş ancak katılmamıştır.
NOT_A_MEMBER Kullanıcı, alana ait değil ve alana katılmak için bekleyen bir daveti yok.

MembershipBatchCreatedEventData

Birden fazla yeni üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.batchCreated

Alanlar
memberships[]

MembershipCreatedEventData

Yeni üyeliklerin listesi.

MembershipBatchDeletedEventData

Birden fazla silinen üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.batchDeleted

Alanlar
memberships[]

MembershipDeletedEventData

Silinen üyeliklerin listesi.

MembershipBatchUpdatedEventData

Birden fazla güncellenmiş üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.batchUpdated

Alanlar
memberships[]

MembershipUpdatedEventData

Güncellenen üyeliklerin listesi.

MembershipCreatedEventData

Yeni üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.created.

Alanlar
membership

Membership

Yeni üyelik.

MembershipDeletedEventData

Silinen üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.deleted

Alanlar
membership

Membership

Silinen üyelik. Yalnızca name ve state alanları doldurulur.

MembershipUpdatedEventData

Güncellenen üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.updated

Alanlar
membership

Membership

Güncellenen üyelik.

Mesaj

Google Chat alanındaki bir mesaj.

Alanlar
name

string

Tanımlayıcı. İletinin kaynak adı.

Biçim: spaces/{space}/messages/{message}

Burada {space}, mesajın yayınlandığı alanın kimliği, {message} ise mesaj için sisteme atanmış bir kimliktir. Örneğin, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

İleti oluştururken özel bir kimlik ayarlarsanız {message} alanındaki değeri clientAssignedMessageId alanındaki değerle değiştirerek isteğinizde iletiyi belirtmek için bu kimliği kullanabilirsiniz. Örneğin, spaces/AAAAAAAAAAA/messages/client-custom-name. Ayrıntılar için İletileri adlandırma başlıklı makaleyi inceleyin.

sender

User

Yalnızca çıkış. Mesajı oluşturan kullanıcı. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa çıkışta user name ve type alanları doldurulur.

create_time

Timestamp

İsteğe bağlıdır. Değişmez. Chat'te oluşturulan alanlarda, mesajın oluşturulduğu zaman. Bu alan, içe aktarma modu alanlarında kullanılması dışında yalnızca çıkış olarak kullanılır.

İçe aktarma modu alanlarında, orijinal oluşturma zamanını korumak için bu alanı, iletinin kaynakta oluşturulduğu geçmiş zaman damgası olarak ayarlayın.

last_update_time

Timestamp

Yalnızca çıkış. Mesajın bir kullanıcı tarafından en son düzenlendiği zaman. Mesaj hiç düzenlenmediyse bu alan boştur.

delete_time

Timestamp

Yalnızca çıkış. Mesajın Google Chat'te silindiği zaman. İleti hiç silinmezse bu alan boştur.

text

string

İsteğe bağlıdır. İletinin düz metin gövdesi. Resim, video veya web sayfasına yönelik ilk bağlantı önizleme çipi oluşturur. Ayrıca Google Chat kullanıcısından veya alandaki herkesten@bahsedebilirsiniz.

Kısa mesaj oluşturma hakkında bilgi edinmek için Mesaj gönderme başlıklı makaleyi inceleyin.

formatted_text

string

Yalnızca çıkış. Biçimlendirmeyi iletmek için eklenen işaretlemelerle birlikte text mesajını içerir. Bu alan, kullanıcı arayüzünde görünen tüm biçimlendirmeyi yakalamayabilir ancak aşağıdakileri içerir:

  • Kalın, italik, üstü çizili, tek aralıklı, tek aralıklı blok ve madde işaretli liste için biçimlendirme söz dizimi.

  • <users/{user}> biçiminde kullanıcı bahsetmeleri.

  • İlk dize URL, ikinci dize ise oluşturulan metin olacak şekilde <{url}|{rendered_text}> biçiminde özel köprüler (ör. <http://example.com|custom text>).

  • :{emoji_name}: biçiminde özel emoji (ör. :smile:) Bu durum, Unicode emojileri (ör. U+1F600) için geçerli değildir.

Daha fazla bilgi için İletide gönderilen metin biçimlendirmesini görüntüleme başlıklı makaleyi inceleyin.

cards[]
(deprecated)

Card

Desteği sonlandırıldı: Bunun yerine cards_v2 politikasını kullanın.

Biçimlendirilmiş metinler, düğmeler ve tıklanabilir resimler gibi kullanıcı arayüzü öğelerini göstermek için kullanabileceğiniz zengin, biçimlendirilmiş ve etkileşimli kartlar. Kartlar genellikle iletinin düz metin gövdesinin altında gösterilir. cards ve cards_v2 en fazla 32 KB olabilir.

cards_v2[]

CardWithId

İsteğe bağlıdır. Kartlar dizisi.

Yalnızca Chat uygulamaları kart oluşturabilir. Sohbet uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa mesajlar kart içermez.

Kart içeren bir mesaj oluşturmayı öğrenmek için Mesaj gönderme başlıklı makaleyi inceleyin.

Kart Oluşturucu ile kart tasarlama ve önizleme

Kart Oluşturucu'yu açma

annotations[]

Annotation

Yalnızca çıkış. Bu iletideki text ile ilişkili ek açıklamalar.

thread

Thread

İletinin ait olduğu ileti dizisi. Kullanım örneği için Mesaj dizisi başlatma veya yanıtlama başlıklı makaleyi inceleyin.

space

Space

Yalnızca çıkış. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa çıkışta yalnızca alan name doldurulur.

fallback_text

string

İsteğe bağlıdır. İletinin kartlarının düz metin açıklaması. Gerçek kartlar görüntülenemediğinde (ör. mobil bildirimler) kullanılır.

action_response

ActionResponse

Yalnızca giriş. Chat uygulamasının yanıtının nasıl yayınlanacağını yapılandırmak için kullanabileceği parametreler.

argument_text

string

Yalnızca çıkış. Tüm Chat uygulaması bahsetmelerinin çıkarıldığı, iletinin düz metin gövdesi.

slash_command

SlashCommand

Yalnızca çıkış. Eğik çizgi komutu bilgileri (varsa)

attachment[]

Attachment

İsteğe bağlıdır. Kullanıcı tarafından yüklenen ek.

matched_url

MatchedUrl

Yalnızca çıkış. spaces.messages.text içinde bağlantı önizleme kalıbıyla eşleşen bir URL. Daha fazla bilgi için Bağlantıları önizleme başlıklı makaleyi inceleyin.

thread_reply

bool

Yalnızca çıkış. true olduğunda, ileti bir yanıt dizisindeki yanıttır. false olduğunda ileti, alandaki üst düzey görüşmede bir mesaj dizisinin ilk iletisi veya mesaj dizisi yanıtı içermeyen bir ileti olarak görünür.

Alan, mesaj dizilerinde yanıtlamayı desteklemiyorsa bu alan her zaman false olur.

client_assigned_message_id

string

İsteğe bağlıdır. İleti için özel bir kimlik. Bir iletiyi tanımlamak veya almak, silmek ya da güncellemek için alanı kullanabilirsiniz. Özel bir kimlik ayarlamak için mesajı oluştururken messageId alanını belirtin. Ayrıntılar için İletileri adlandırma başlıklı makaleyi inceleyin.

emoji_reaction_summaries[]

EmojiReactionSummary

Yalnızca çıkış. Mesajdaki emoji tepkilerinin özet listesi.

private_message_viewer

User

İsteğe bağlıdır. Değişmez. Mesaj oluşturmak için giriş, aksi takdirde yalnızca çıkış. Mesajı görüntüleyebilen kullanıcı. Bu alan ayarlandığında mesaj özel olur ve yalnızca belirtilen kullanıcı ile Chat uygulaması tarafından görülebilir. Bu alanı isteğinize eklemek için Chat API'yi uygulama kimlik doğrulaması kullanarak çağırmalı ve aşağıdakileri atlamalısınız:

Ayrıntılı bilgi için Özel mesaj gönderme başlıklı makaleyi inceleyin.

deletion_metadata

DeletionMetadata

Yalnızca çıkış. Silinen bir iletiyle ilgili bilgiler. delete_time ayarlandığında mesaj silinir.

quoted_message_metadata

QuotedMessageMetadata

Yalnızca çıkış. Google Chat kullanıcısı tarafından bir alanda alıntılanan mesajla ilgili bilgiler. Google Chat kullanıcıları, yanıtlamak için bir mesajı alıntılayabilir.

attached_gifs[]

AttachedGif

Yalnızca çıkış. İletiye eklenen GIF resimler.

accessory_widgets[]

AccessoryWidget

İsteğe bağlıdır. İletinin en altında görünen bir veya daha fazla etkileşimli widget. Metin, kart veya hem metin hem de kart içeren mesajlara aksesuar widget'ları ekleyebilirsiniz. Diyalog içeren iletilerde desteklenmez. Ayrıntılar için İletinin en altına etkileşimli widget'lar ekleme başlıklı makaleyi inceleyin.

Aksesuar widget'ları içeren bir mesaj oluşturmak için uygulama kimlik doğrulaması gerekir.

MessageBatchCreatedEventData

Birden fazla yeni ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.batchCreated

Alanlar
messages[]

MessageCreatedEventData

Yeni mesajların listesi.

MessageBatchDeletedEventData

Birden fazla silinen ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.batchDeleted

Alanlar
messages[]

MessageDeletedEventData

Silinen iletilerin listesi

MessageBatchUpdatedEventData

Birden fazla güncellenmiş ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.batchUpdated

Alanlar
messages[]

MessageUpdatedEventData

Güncellenen mesajların listesi.

MessageCreatedEventData

Yeni bir mesajın etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.created

Alanlar
message

Message

Yeni mesaj.

MessageDeletedEventData

Silinen bir ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.deleted

Alanlar
message

Message

Silinen mesaj Yalnızca name, createTime, deleteTime ve deletionMetadata alanları doldurulur.

MessageUpdatedEventData

Güncellenen bir ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.updated

Alanlar
message

Message

Güncellenen mesaj.

QuotedMessageMetadata

Alıntılanan iletiyle ilgili bilgiler.

Alanlar
name

string

Yalnızca çıkış. Alıntılanan iletinin kaynak adı.

Biçim: spaces/{space}/messages/{message}

last_update_time

Timestamp

Yalnızca çıkış. Alıntılanan mesajın oluşturulduğu veya en son güncellendiği zaman damgası.

Tepki

Mesajlara tepki ekleme

Alanlar
name

string

Tanımlayıcı. Tepkinin kaynak adı.

Biçim: spaces/{space}/messages/{message}/reactions/{reaction}

user

User

Yalnızca çıkış. Tepkiyi oluşturan kullanıcı.

emoji

Emoji

Zorunlu. Tepkide kullanılan emoji.

ReactionBatchCreatedEventData

Birden fazla yeni tepki için etkinlik yükü.

Etkinlik türü: google.workspace.chat.reaction.v1.batchCreated

Alanlar
reactions[]

ReactionCreatedEventData

Yeni tepkilerin listesi.

ReactionBatchDeletedEventData

Birden fazla silinmiş tepki için etkinlik yükü.

Etkinlik türü: google.workspace.chat.reaction.v1.batchDeleted

Alanlar
reactions[]

ReactionDeletedEventData

Silinen tepkilerin listesi.

ReactionCreatedEventData

Yeni bir tepki için etkinlik yükü.

Etkinlik türü: google.workspace.chat.reaction.v1.created

Alanlar
reaction

Reaction

Yeni tepki.

ReactionDeletedEventData

Silinen bir tepkinin etkinlik yükü.

Tür: google.workspace.chat.reaction.v1.deleted

Alanlar
reaction

Reaction

Silinen tepki.

RichLinkMetadata

Bir kaynağın zengin bağlantısı.

Alanlar
uri

string

Bu bağlantının URI'si.

Birleştirme alanı data. Bağlı kaynağın verileri. data yalnızca aşağıdakilerden biri olabilir:

RichLinkType

Zengin bağlantı türü. Gelecekte daha fazla tür eklenebilir.

Sıralamalar
DRIVE_FILE Google Drive zengin bağlantı türü.
CHAT_SPACE Chat alanı zengin bağlantı türü. Örneğin, alan akıllı çipi.

SearchSpacesRequest

Bir sorguya göre alan listesi arama isteği.

Alanlar
use_admin_access

bool

true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.spaces.readonly veya chat.admin.spaces OAuth 2.0 kapsamı gerektirir.

Bu yöntem şu anda yalnızca yönetici erişimini desteklemektedir. Bu nedenle, bu alan için yalnızca true kabul edilir.

page_size

int32

Döndürülecek maksimum boşluk sayısı. Hizmet, bu değerden daha az sonuç döndürebilir.

Belirtilmezse en fazla 100 boşluk döndürülür.

Maksimum değer 1.000'dir. 1.000'den büyük bir değer kullanırsanız bu değer otomatik olarak 1.000 olarak değiştirilir.

page_token

string

Önceki arama alanları çağrısından alınan jeton. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalama yapılırken sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler iletmek beklenmedik sonuçlara yol açabilir.

query

string

Zorunlu. Arama sorgusu

Aşağıdaki parametreleri kullanarak arama yapabilirsiniz:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time ve last_active_time, RFC-3339 biçiminde bir zaman damgası kabul eder. Desteklenen karşılaştırma operatörleri şunlardır: =, <, >, <=, >=.

customer gereklidir ve alanların hangi müşteriden getirileceğini belirtmek için kullanılır. Yalnızca customers/my_customer değeri desteklenir.

display_name yalnızca HAS (:) operatörünü kabul eder. Eşleştirilecek metin önce jetonlara ayrılır ve her jeton, alanın display_name herhangi bir yerindeki alt dize olarak büyük/küçük harfe duyarsız ve bağımsız bir şekilde önek eşlemesi yapılır. Örneğin, Fun Eve, Fun event veya The evening was fun ile eşleşir ancak notFun event veya even ile eşleşmez.

external_user_allowed, true veya false değerini kabul eder.

space_history_state yalnızca bir space kaynağının historyState alanındaki değerleri kabul eder.

space_type gereklidir ve tek geçerli değer SPACE'dir.

Farklı alanlarda yalnızca AND operatörleri desteklenir. Geçerli bir örnek space_type = "SPACE" AND display_name:"Hello", geçersiz bir örnek ise space_type = "SPACE" OR display_name:"Hello" şeklindedir.

Aynı alan içinde space_type, AND veya OR operatörlerini desteklemez. display_name, "space_history_state" ve "external_user_allowed" yalnızca OR operatörlerini destekler. last_active_time ve create_time, hem AND hem de OR operatörlerini destekler. AND yalnızca last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00" gibi bir aralığı temsil etmek için kullanılabilir.

Aşağıdaki örnek sorgular geçerlidir:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

İsteğe bağlıdır. Alan listesinin sıralanma şekli.

Sıralama için desteklenen özellikler şunlardır:

  • membership_count.joined_direct_human_user_count: Bir alana doğrudan katılan kullanıcıların sayısını gösterir.
  • last_active_time: Bu alanın herhangi bir konusuna son uygun öğenin eklendiği zamanı gösterir.
  • create_time: Alanın oluşturulma zamanını gösterir.

Geçerli sıralama işlemi değerleri şunlardır:

  • Artan sıra için ASC. Varsayılan değer.

  • Azalan düzende sıralamak için DESC.

Desteklenen söz dizimleri şunlardır:

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

Arama alanları isteğine karşılık gelen alanların listesini içeren yanıt.

Alanlar
spaces[]

Space

İstenen alanların sayfası.

next_page_token

string

Sonraki sayfayı almak için kullanılabilecek bir jeton. Bu alan boşsa sonraki sayfa yoktur.

total_size

int32

Tüm sayfalarda sorguyla eşleşen toplam alan sayısı. Sonuç 10.000 boşluktan fazlaysa bu değer bir tahmindir.

SetUpSpaceRequest

Alan oluşturma ve belirtilen kullanıcıları alana ekleme isteği.

Alanlar
space

Space

Zorunlu. Space.spaceType alanı zorunludur.

Alan oluşturmak için Space.spaceType değerini SPACE olarak ve Space.displayName değerini ayarlayın. Bir alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

Grup sohbeti oluşturmak için Space.spaceType ayarını GROUP_CHAT olarak belirleyin. Space.displayName ayarlamayın.

İnsanlar arasında bire bir görüşme oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm değerini ise false olarak ayarlayın. Space.displayName veya Space.spaceDetails ayarlamayın.

Bir insan ile arayan Chat uygulaması arasında bire bir görüşme oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm değerini ise true olarak ayarlayın. Space.displayName veya Space.spaceDetails ayarlamayın.

DIRECT_MESSAGE alanı zaten varsa yeni bir alan oluşturulmaz ve bu alan döndürülür.

request_id

string

İsteğe bağlıdır. Bu isteğin benzersiz tanımlayıcısıdır. Rastgele bir UUID önerilir. Mevcut bir istek kimliğini belirtmek, yeni bir alan oluşturmak yerine bu kimlikle oluşturulan alanı döndürür. Farklı bir kimliği doğrulanmış kullanıcıyla aynı Chat uygulamasından mevcut bir istek kimliğini belirtmek hata döndürür.

memberships[]

Membership

İsteğe bağlıdır. Alana katılmaya davet edilecek Google Chat kullanıcıları veya grupları. Arayan kullanıcıyı otomatik olarak eklendiği için atlayın.

Şu anda sette, arayan kişi dışında en fazla 49 üyelik bulunabilir.

İnsan üyeliği için Membership.member alanı, name alanının doldurulduğu (biçim: users/{user}) bir user içermeli ve type alanı User.Type.HUMAN olarak ayarlanmalıdır. Yalnızca alan oluştururken kullanıcı ekleyebilirsiniz (Chat uygulamaları ekleme yalnızca arama uygulamasıyla doğrudan mesajlaşma kurulumunda desteklenir). Ayrıca, kullanıcının e-posta adresini {user} için takma ad olarak kullanarak da üye ekleyebilirsiniz. Örneğin, user.name, users/example@gmail.com olabilir. Gmail kullanıcılarını veya harici Google Workspace alanlarındaki kullanıcıları davet etmek için kullanıcının e-posta adresi {user} için kullanılmalıdır.

Google grubu üyeliği için Membership.group_member alanı, name değerinin doldurulduğu bir group içermelidir (groups/{group} biçiminde). Yalnızca Space.spaceType değerini SPACE olarak ayarlarken Google grupları ekleyebilirsiniz.

Space.spaceType, SPACE olarak ayarlandığında isteğe bağlıdır.

En az iki üyelikle birlikte Space.spaceType, GROUP_CHAT olarak ayarlanırken gereklidir.

Tam olarak bir üyelikle birlikte Space.spaceType ayarı DIRECT_MESSAGE olarak belirlenirken gereklidir.

Bir insan ile arama yapan Chat uygulaması arasında 1:1 görüşme oluşturulurken boş olmalıdır (Space.spaceType, DIRECT_MESSAGE ve Space.singleUserBotDm, true olarak ayarlanırken).

SlashCommand

Google Chat'teki eğik çizgiyle başlayan komutlar hakkında meta veriler.

Alanlar
command_id

int64

Eğik çizgi komutunun kimliği.

SlashCommandMetadata

Eğik çizgi komutları (/) için ek açıklama meta verileri.

Alanlar
bot

User

Komutu çağrılan Chat uygulaması.

type

Type

Eğik çizgi komutunun türü.

command_name

string

Çağrılan eğik çizgi komutunun adı.

command_id

int64

Çağrılan eğik çizgi komutunun komut kimliği.

triggers_dialog

bool

Eğik çizgi komutunun iletişim kutusu için olup olmadığını gösterir.

Tür

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
ADD Chat uygulamasını alana ekleyin.
INVOKE Alanda eğik çizgi komutu çağırma

Boşluk

Google Chat'te bir alan. Alanlar, iki veya daha fazla kullanıcı arasındaki görüşmeler ya da bir kullanıcı ile bir Chat uygulaması arasındaki bire bir mesajlardır.

Alanlar
name

string

Tanımlayıcı. Alan kaynak adı.

Biçim: spaces/{space}

Burada {space}, alana sistem tarafından atanan kimliği temsil eder. Alan kimliğini spaces.list() yöntemini çağırarak veya alan URL'sinden alabilirsiniz. Örneğin, alan URL'si https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA ise alan kimliği AAAAAAAAA olur.

type
(deprecated)

Type

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine space_type politikasını kullanın. Alan türü.

space_type

SpaceType

İsteğe bağlıdır. Alan türü. Alan oluştururken veya alan türünü güncellerken gereklidir. Diğer kullanımlar için yalnızca çıkış.

single_user_bot_dm

bool

İsteğe bağlıdır. Alan, bir Chat uygulaması ile tek bir kullanıcı arasındaki doğrudan mesajlaşma mı?

threaded
(deprecated)

bool

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceThreadingState politikasını kullanın. Bu alanda mesajların ileti dizisi hâlinde olup olmadığı.

display_name

string

İsteğe bağlıdır. Alanının görünen adı. SPACE spaceType ile alan oluştururken gereklidir. Alan oluştururken veya displayName güncellerken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

Doğrudan mesajlarda bu alan boş olabilir.

En fazla 128 karakter desteklenir.

external_user_allowed

bool

İsteğe bağlıdır. Değişmez. Bu alanın herhangi bir Google Chat kullanıcısının üye olmasına izin verip vermediği. Google Workspace kuruluşunda alan oluştururken girilen girişler. Aşağıdaki koşullarda alan oluştururken bu alanı atlayın:

  • Kimliği doğrulanmış kullanıcı, tüketici hesabı (yönetilmeyen kullanıcı hesabı) kullanıyor. Tüketici hesabı tarafından oluşturulan alanlar varsayılan olarak tüm Google Chat kullanıcılarına izin verir.

Mevcut alanlar için bu alan yalnızca çıkış alanıdır.

space_threading_state

SpaceThreadingState

Yalnızca çıkış. Chat alanındaki ileti dizisi durumu.

space_details

SpaceDetails

İsteğe bağlıdır. Açıklama ve kurallar da dahil olmak üzere alanla ilgili ayrıntılar.

space_history_state

HistoryState

İsteğe bağlıdır. Bu alandaki iletiler ve ileti dizileri için mesaj geçmişi durumu.

import_mode

bool

İsteğe bağlıdır. Bu alanın, Google Workspace'e veri taşıma işleminin bir parçası olarak Import Mode içinde oluşturulup oluşturulmadığı. Alanlar içe aktarılırken, içe aktarma işlemi tamamlanana kadar kullanıcılara görünmez.

Import Mode'da alan oluşturmak için kullanıcı kimlik doğrulaması gerekir.

create_time

Timestamp

İsteğe bağlıdır. Değişmez. Chat'te oluşturulan alanlar için alanın oluşturulma zamanı. Bu alan, içe aktarma modu alanlarında kullanılması dışında yalnızca çıkış olarak kullanılır.

İçe aktarma modu alanlarında, orijinal oluşturma zamanını korumak için bu alanı, alanın kaynakta oluşturulduğu geçmiş zaman damgası olarak ayarlayın.

Yalnızca spaceType, GROUP_CHAT veya SPACE olduğunda çıkışta doldurulur.

last_active_time

Timestamp

Yalnızca çıkış. Alandaki son mesajın zaman damgası.

admin_installed

bool

Yalnızca çıkış. Bir Chat uygulamasıyla doğrudan mesaj (DM) alanları için alanın bir Google Workspace yöneticisi tarafından oluşturulup oluşturulmadığı. Yöneticiler, kuruluşlarındaki kullanıcılar adına Chat uygulamasıyla doğrudan mesaj yükleyip ayarlayabilir.

Yönetici yüklemesini desteklemek için Chat uygulamanızda doğrudan mesajlaşma özelliği bulunmalıdır.

membership_count

MembershipCount

Yalnızca çıkış. Üye türüne göre gruplandırılmış, katılan üyeliklerin sayısı. space_type, SPACE, DIRECT_MESSAGE veya GROUP_CHAT olduğunda doldurulur.

access_settings

AccessSettings

İsteğe bağlıdır. Alan erişim ayarını belirtir. Yalnızca space_type SPACE olduğunda doldurulur.

space_uri

string

Yalnızca çıkış. Kullanıcının alana erişmek için kullanacağı URI.

import_mode_expire_time

Timestamp

Yalnızca çıkış. Alan, içe aktarma modunda kalırsa sistem tarafından otomatik olarak silineceği zaman.

İçe aktarma modunda oluşturulan her alan, spaces.completeImport kullanılarak bu süre dolmadan önce bu moddan çıkmalıdır.

Bu alan yalnızca içe aktarma moduyla oluşturulan alanlar için doldurulur.

customer

string

İsteğe bağlıdır. Değişmez. Alanının müşteri kimliği. Yalnızca uygulama kimlik doğrulaması ile alan oluşturulurken ve SpaceType SPACE olduğunda gereklidir. Aksi takdirde ayarlanmamalıdır.

customers/{customer} biçiminde. Burada customer, [Admin SDK müşteri kaynağındaki]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) id değeridir. Özel uygulamalar, uygulama ile aynı Google Workspace kuruluşunda alan oluşturmak için customers/my_customer takma adını da kullanabilir.

DM'ler için bu alan doldurulmaz.

Birleştirme alanı space_permission_settings. Bir alanın izin ayarlarını gösterir. Yalnızca space_type SPACE olduğunda doldurulur. space_permission_settings yalnızca aşağıdakilerden biri olabilir:
predefined_permission_settings

PredefinedPermissionSettings

İsteğe bağlıdır. Yalnızca giriş. Önceden tanımlanmış alan izni ayarları, yalnızca alan oluşturulurken girilir. Alan ayarlanmamışsa bir ortak çalışma alanı oluşturulur. Alanı oluşturduktan sonra ayarlar PermissionSettings alanına doldurulur.

Önceden tanımlanmış izin ayarlarını belirleme şu özellikleri destekler:

permission_settings

PermissionSettings

İsteğe bağlıdır. Mevcut alanlar için alan izni ayarları. Mevcut izin ayarlarının değiştirildiği, tam alan izin ayarlarını güncelleme girişi. Çıkış, mevcut izin ayarlarını listeler.

İzin ayarlarını okuma ve güncelleme şu durumlarda desteklenir:

AccessSettings

Alan erişim ayarını gösterir.

Alanlar
access_state

AccessState

Yalnızca çıkış. Alan erişim durumunu gösterir.

audience

string

İsteğe bağlıdır. Alanı keşfedebilen, alana katılabilen ve alandaki mesajları önizleyebilen hedef kitlenin kaynak adı. Ayarlanmamışsa yalnızca alana tek tek davet edilen veya eklenen kullanıcılar ya da Google Grupları alana erişebilir. Ayrıntılı bilgi için Bir alanı hedef kitle tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin.

Biçim: audiences/{audience}

Google Workspace kuruluşu için varsayılan hedef kitleyi kullanmak istiyorsanız audiences/default olarak ayarlayın.

Hedef kitleyi okuma şu özellikleri destekler:

Bu alan, uygulama kimlik doğrulaması ile chat.bot kapsamı kullanılırken doldurulmaz.

Hedef kitleyi ayarlamak için kullanıcı kimlik doğrulaması gerekir.

AccessState

Alan erişim durumunu gösterir.

Sıralamalar
ACCESS_STATE_UNSPECIFIED Erişim durumu bilinmiyor veya bu API'de desteklenmiyor.
PRIVATE Yalnızca diğer kullanıcılar veya Google Workspace yöneticileri tarafından tek tek eklenen ya da davet edilen kullanıcılar veya Google Grupları alanı keşfedip alana erişebilir.
DISCOVERABLE

Bir alan yöneticisi, hedef kitleye alana erişim izni vermişse Alana tek tek eklenen veya davet edilen kullanıcılar ya da Google Grupları da alanı keşfedip erişebilir. Daha fazla bilgi edinmek için Belirli kullanıcıların alanları bulmasını sağlama başlıklı makaleyi inceleyin.

Herkese açık alan oluşturmak için kullanıcı kimlik doğrulaması gerekir.

MembershipCount

Bir alanın üyelik sayısını kategorilere göre gruplandırılmış şekilde gösterir.

Alanlar
joined_direct_human_user_count

int32

Yalnızca çıkış. Katılan bir grupta üyeliği olan kullanıcılar hariç, alana doğrudan katılan gerçek kullanıcıların sayısı.

joined_group_count

int32

Yalnızca çıkış. Alana doğrudan katılan tüm grupların sayısı.

PermissionSetting

Alan izni ayarını gösterir.

Alanlar
managers_allowed

bool

İsteğe bağlıdır. Alan yöneticilerinin bu izne sahip olup olmadığı.

members_allowed

bool

İsteğe bağlıdır. Yönetici olmayan üyelerin bu izne sahip olup olmadığı.

PermissionSettings

Mevcut bir adlandırılmış alanı güncellerken belirtebileceğiniz izin ayarları.

Alan oluştururken izin ayarlarını belirlemek için isteğinizde PredefinedPermissionSettings alanını belirtin.

Alanlar
manage_members_and_groups

PermissionSetting

İsteğe bağlıdır. Alanın üyelerini ve gruplarını yönetme ayarı.

modify_space_details

PermissionSetting

İsteğe bağlıdır. Alan adını, avatarını, açıklamasını ve yönergelerini güncelleme ayarı.

toggle_history

PermissionSetting

İsteğe bağlıdır. Alan geçmişini açıp kapatma ayarı.

use_at_mention_all

PermissionSetting

İsteğe bağlıdır. Bir alanda @tümü ifadesini kullanma ayarı.

manage_apps

PermissionSetting

İsteğe bağlıdır. Alandaki uygulamaları yönetme ayarı.

manage_webhooks

PermissionSetting

İsteğe bağlıdır. Alandaki webhook'ları yönetme ayarı.

post_messages

PermissionSetting

Yalnızca çıkış. Alanda mesaj yayınlama ayarı.

reply_messages

PermissionSetting

İsteğe bağlıdır. Alandaki mesajları yanıtlama ayarı.

PredefinedPermissionSettings

Yalnızca adlandırılmış bir alan oluştururken belirleyebileceğiniz önceden tanımlanmış izin ayarları. Gelecekte daha fazla ayar eklenebilir. Adlandırılmış alanların izin ayarları hakkında ayrıntılı bilgi için Alanlar hakkında başlıklı makaleyi inceleyin.

Sıralamalar
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Belirtilmedi. Kullanmayın.
COLLABORATION_SPACE Alanı, tüm üyelerin mesaj gönderebileceği bir işbirliği alanı yapma ayarı.
ANNOUNCEMENT_SPACE Alanı, yalnızca alan yöneticilerinin ileti yayınlayabileceği bir duyuru alanı yapma ayarı.

SpaceDetails

Açıklama ve kurallar da dahil olmak üzere alanla ilgili ayrıntılar.

Alanlar
description

string

İsteğe bağlıdır. Alan açıklaması. Örneğin, alanın tartışma konusunu, işlevsel amacını veya katılımcılarını açıklayın.

En fazla 150 karakter desteklenir.

guidelines

string

İsteğe bağlıdır. Alan kuralları, beklentiler ve görgü kuralları

5.000 karaktere kadar destekler.

SpaceThreadingState

Chat alanındaki ileti dizisi durumunun türünü belirtir.

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Rezervasyon yapıldı.
THREADED_MESSAGES İleti dizilerini destekleyen adlandırılmış alanlar. Kullanıcılar bir iletiye yanıt verirken ileti dizisi içinde yanıtlayabilir. Bu sayede yanıtları orijinal iletinin bağlamında kalır.
GROUPED_MESSAGES Görüşmenin konuya göre düzenlendiği adlandırılmış alanlar. Konular ve yanıtları birlikte gruplandırılır.
UNTHREADED_MESSAGES İki kişi arasındaki doğrudan mesajlar (DM'ler) ve 3 veya daha fazla kişi arasındaki grup görüşmeleri.

SpaceType

Alan türü. Alan oluştururken veya güncellerken gerekir. Diğer kullanımlar için yalnızca çıkış.

Sıralamalar
SPACE_TYPE_UNSPECIFIED Rezervasyon yapıldı.
SPACE Kullanıcıların mesaj gönderdiği, dosya paylaştığı ve ortak çalıştığı yer. SPACE, Chat uygulamalarını içerebilir.
GROUP_CHAT 3 veya daha fazla kişi arasındaki grup görüşmeleri GROUP_CHAT, Chat uygulamalarını içerebilir.
DIRECT_MESSAGE İki insan veya bir insan ile bir Chat uygulaması arasındaki bire bir mesajlar.

Tür

Desteği sonlandırıldı: Bunun yerine SpaceType politikasını kullanın.

Sıralamalar
TYPE_UNSPECIFIED Rezervasyon yapıldı.
ROOM İki veya daha fazla insan arasındaki sohbetler.
DM Bir insan ile bir Chat uygulaması arasındaki bire bir doğrudan mesajlaşma. Tüm mesajlar düzdür. Bu durumun, iki kullanıcı arasındaki doğrudan mesajları kapsamadığını unutmayın.

SpaceBatchUpdatedEventData

Bir alanda birden fazla güncelleme için etkinlik yükü.

Etkinlik türü: google.workspace.chat.space.v1.batchUpdated

Alanlar
spaces[]

SpaceUpdatedEventData

Güncellenen alanların listesi.

SpaceEvent

Google Chat alanındaki bir değişikliği veya etkinliği temsil eden etkinlik. Daha fazla bilgi edinmek için Google Chat'teki etkinliklerle çalışma başlıklı makaleyi inceleyin.

Alanlar
name

string

Alan etkinliğinin kaynak adı.

Biçim: spaces/{space}/spaceEvents/{spaceEvent}

event_time

Timestamp

Etkinliğin gerçekleştiği zaman.

event_type

string

Alan etkinliğinin türü. Her etkinlik türünün, kısa bir süre içinde gerçekleşen birden fazla etkinlik türü örneğini temsil eden bir toplu sürümü vardır. spaceEvents.list() istekleri için sorgu filtrenizde toplu etkinlik türlerini atlayın. Sunucu, varsayılan olarak hem etkinlik türünü hem de toplu sürümünü döndürür.

Mesajlar için desteklenen etkinlik türleri:

  • Yeni mesaj: google.workspace.chat.message.v1.created
  • Güncellenen mesaj: google.workspace.chat.message.v1.updated
  • Silinen mesaj: google.workspace.chat.message.v1.deleted
  • Birden fazla yeni mesaj: google.workspace.chat.message.v1.batchCreated
  • Birden fazla güncellenmiş mesaj: google.workspace.chat.message.v1.batchUpdated
  • Birden fazla silinen ileti: google.workspace.chat.message.v1.batchDeleted

Üyelikler için desteklenen etkinlik türleri:

  • Yeni üyelik: google.workspace.chat.membership.v1.created
  • Güncellenen üyelik: google.workspace.chat.membership.v1.updated
  • Silinen üyelik: google.workspace.chat.membership.v1.deleted
  • Birden fazla yeni üyelik: google.workspace.chat.membership.v1.batchCreated
  • Birden fazla güncellenmiş üyelik: google.workspace.chat.membership.v1.batchUpdated
  • Birden fazla silinen üyelik: google.workspace.chat.membership.v1.batchDeleted

Tepkiler için desteklenen etkinlik türleri:

  • Yeni tepki: google.workspace.chat.reaction.v1.created
  • Silinen tepki: google.workspace.chat.reaction.v1.deleted
  • Birden fazla yeni tepki: google.workspace.chat.reaction.v1.batchCreated
  • Birden fazla silinen tepki: google.workspace.chat.reaction.v1.batchDeleted

Alanla ilgili desteklenen etkinlik türleri:

  • Güncellenen alan: google.workspace.chat.space.v1.updated
  • Birden fazla alan güncellemesi: google.workspace.chat.space.v1.batchUpdated

Birleştirme alanı payload.

payload yalnızca aşağıdakilerden biri olabilir:

message_created_event_data

MessageCreatedEventData

Yeni bir mesajın etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.created

message_updated_event_data

MessageUpdatedEventData

Güncellenen bir ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.updated

message_deleted_event_data

MessageDeletedEventData

Silinen bir ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.deleted

message_batch_created_event_data

MessageBatchCreatedEventData

Birden fazla yeni ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.batchCreated

message_batch_updated_event_data

MessageBatchUpdatedEventData

Birden fazla güncellenmiş ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.batchUpdated

message_batch_deleted_event_data

MessageBatchDeletedEventData

Birden fazla silinen ileti için etkinlik yükü.

Etkinlik türü: google.workspace.chat.message.v1.batchDeleted

space_updated_event_data

SpaceUpdatedEventData

Alan güncellemesi için etkinlik yükü.

Etkinlik türü: google.workspace.chat.space.v1.updated

space_batch_updated_event_data

SpaceBatchUpdatedEventData

Bir alanda birden fazla güncelleme için etkinlik yükü.

Etkinlik türü: google.workspace.chat.space.v1.batchUpdated

membership_created_event_data

MembershipCreatedEventData

Yeni üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.created

membership_updated_event_data

MembershipUpdatedEventData

Güncellenen üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.updated

membership_deleted_event_data

MembershipDeletedEventData

Silinen üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.deleted

membership_batch_created_event_data

MembershipBatchCreatedEventData

Birden fazla yeni üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.batchCreated

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Birden fazla güncellenmiş üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.batchUpdated

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Birden fazla silinen üyelik için etkinlik yükü.

Etkinlik türü: google.workspace.chat.membership.v1.batchDeleted

reaction_created_event_data

ReactionCreatedEventData

Yeni bir tepki için etkinlik yükü.

Etkinlik türü: google.workspace.chat.reaction.v1.created

reaction_deleted_event_data

ReactionDeletedEventData

Silinen bir tepkinin etkinlik yükü.

Etkinlik türü: google.workspace.chat.reaction.v1.deleted

reaction_batch_created_event_data

ReactionBatchCreatedEventData

Birden fazla yeni tepki için etkinlik yükü.

Etkinlik türü: google.workspace.chat.reaction.v1.batchCreated

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Birden fazla silinmiş tepki için etkinlik yükü.

Etkinlik türü: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

Bir alandaki kullanıcının bildirim ayarı.

Alanlar
name

string

Tanımlayıcı. Alan bildirimi ayarının kaynak adı. Biçim: users/{user}/spaces/{space}/spaceNotificationSetting.

notification_setting

NotificationSetting

Bildirim ayarı.

mute_setting

MuteSetting

Alan bildirimini kapatma ayarı.

MuteSetting

Alan bildirimlerini yoksayma ayarı türleri.

Sıralamalar
MUTE_SETTING_UNSPECIFIED Rezervasyon yapıldı.
UNMUTED Kullanıcı, bildirim ayarına göre alanla ilgili bildirimler alır.
MUTED Kullanıcı, bildirim ayarı ne olursa olsun alanla ilgili bildirim almaz.

NotificationSetting

Bildirim ayarı türleri. Gelecekte başka türler de desteklenebilir.

Sıralamalar
NOTIFICATION_SETTING_UNSPECIFIED Rezervasyon yapıldı.
ALL Bildirimler; @bahisler, takip edilen mesaj dizileri ve yeni dizilerdeki ilk mesaj ile tetiklenir. Kullanıcı tarafından manuel olarak takibi bırakılmadığı sürece tüm yeni ileti dizileri otomatik olarak takip edilir.
MAIN_CONVERSATIONS Bildirim; @bahisler, takip edilen mesaj dizileri ve yeni dizilerdeki ilk mesaj tarafından tetiklenir. Bire bir doğrudan mesajlarda kullanılamaz.
FOR_YOU Bildirim, @bahisler ve takip edilen mesaj dizileri tarafından tetiklenir. Bire bir doğrudan mesajlarda kullanılamaz.
OFF Bildirim kapalı.

SpaceReadState

Okundu ve okunmadı iletilerini belirlemek için kullanılan, kullanıcının bir alandaki okundu durumu.

Alanlar
name

string

Alan okunma durumunun kaynak adı.

Biçim: users/{user}/spaces/{space}/spaceReadState

last_read_time

Timestamp

İsteğe bağlıdır. Kullanıcının alan okuma durumunun güncellendiği zaman. Bu genellikle son okunan mesajın zaman damgasına veya kullanıcının bir alanda son okunan konumu işaretlemek için belirttiği bir zaman damgasına karşılık gelir.

SpaceUpdatedEventData

Güncellenen bir alanın etkinlik yükü.

Etkinlik türü: google.workspace.chat.space.v1.updated

Alanlar
space

Space

Güncellenen alan.

İplik

Google Chat alanındaki bir ileti dizisi. Kullanım örneği için Mesaj dizisi başlatma veya yanıtlama başlıklı makaleyi inceleyin.

İleti oluştururken bir ileti dizisi belirtirseniz eşleşen bir ileti dizisi bulunamazsa ne olacağını belirlemek için messageReplyOption alanını ayarlayabilirsiniz.

Alanlar
name

string

Tanımlayıcı. İş parçacığının kaynak adı.

Örnek: spaces/{space}/threads/{thread}

thread_key

string

İsteğe bağlıdır. İş parçacığı oluşturmak veya güncellemek için giriş. Aksi takdirde, yalnızca çıkış. İleti dizisinin kimliği. En fazla 4.000 karakter desteklenir.

Bu kimlik, onu ayarlayan Chat uygulamasına özeldir. Örneğin, birden fazla sohbet uygulaması aynı ileti dizisi anahtarını kullanarak ileti oluşturursa iletiler farklı ileti dizilerinde yayınlanır. Bir kişi veya başka bir Chat uygulaması tarafından oluşturulan mesaj dizilerinde yanıt vermek için bunun yerine mesaj dizisi name alanını belirtin.

ThreadReadState

Okunmuş ve okunmamış iletileri belirlemek için kullanılan, bir ileti dizisindeki kullanıcının okuma durumu.

Alanlar
name

string

Okunan ileti dizisi durumunun kaynak adı.

Biçim: users/{user}/spaces/{space}/threads/{thread}/threadReadState

last_read_time

Timestamp

Kullanıcının ileti dizisi okuma durumunun güncellendiği zaman. Bu genellikle bir ileti dizisindeki okunan son mesajın zaman damgasına karşılık gelir.

UpdateMembershipRequest

Üyeliği güncelleme için istek mesajı.

Alanlar
membership

Membership

Zorunlu. Güncellenecek üyelik. Yalnızca update_mask tarafından belirtilen alanlar güncellenir.

update_mask

FieldMask

Zorunlu. Güncellenecek alan yolları. Birden çok değeri virgülle ayırın veya tüm alan yollarını güncellemek için * simgesini kullanın.

Şu anda desteklenen alan yolları:

  • role
use_admin_access

bool

İsteğe bağlıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.memberships OAuth 2.0 kapsamı gerektirir.

UpdateMessageRequest

Mesaj güncelleme isteğinde bulunma

Alanlar
message

Message

Zorunlu. Alanları güncellenmiş ileti.

update_mask

FieldMask

Zorunlu. Güncellenecek alan yolları. Birden çok değeri virgülle ayırın veya tüm alan yollarını güncellemek için * simgesini kullanın.

Şu anda desteklenen alan yolları:

allow_missing

bool

İsteğe bağlıdır. true ve ileti bulunamazsa yeni bir ileti oluşturulur ve updateMask yoksayılır. Belirtilen ileti kimliği istemci tarafından atanmış olmalıdır. Aksi takdirde istek başarısız olur.

UpdateSpaceNotificationSettingRequest

Alan bildirim ayarlarını güncelleme isteği Yalnızca arayan kullanıcının bildirim ayarının güncellenmesini destekler.

Alanlar
space_notification_setting

SpaceNotificationSetting

Zorunlu. Alan bildirim ayarlarının kaynak adı users/{user}/spaces/{space}/spaceNotificationSetting biçiminde doldurulmalıdır. Yalnızca update_mask tarafından belirtilen alanlar güncellenir.

update_mask

FieldMask

Zorunlu. Desteklenen alan yolları:

  • notification_setting

  • mute_setting

UpdateSpaceReadStateRequest

UpdateSpaceReadState API için istek mesajı.

Alanlar
space_read_state

SpaceReadState

Zorunlu. Alan okuma durumu ve güncellenecek alanlar.

Yalnızca arayan kullanıcının okunma durumunu güncellemeyi destekler.

Arayan kullanıcıya başvurmak için aşağıdakilerden birini ayarlayın:

  • me takma adı. Örneğin, users/me/spaces/{space}/spaceReadState.

  • Workspace e-posta adresleri Örneğin, users/user@example.com/spaces/{space}/spaceReadState.

  • Kullanıcı kimliği Örneğin, users/123456789/spaces/{space}/spaceReadState.

Biçim: users/{user}/spaces/{space}/spaceReadState

update_mask

FieldMask

Zorunlu. Güncellenecek alan yolları. Şu anda desteklenen alan yolları:

  • last_read_time

last_read_time, en son mesaj oluşturma zamanından önceyse alan, kullanıcı arayüzünde okunmamış olarak görünür.

Alanı okunmuş olarak işaretlemek için last_read_time değerini en son mesajın oluşturulma zamanından sonraki (daha büyük) bir değere ayarlayın. last_read_time, en son mesaj oluşturma zamanıyla eşleşecek şekilde zorlanır. Alan okuma durumunun yalnızca alanın üst düzey ileti dizisinde görünen iletilerin okuma durumunu etkilediğini unutmayın. İleti dizilerindeki yanıtlar bu zaman damgasından etkilenmez ve bunun yerine ileti dizisinin okunma durumuna göre belirlenir.

UpdateSpaceRequest

Tek bir alanı güncelleme isteği.

Alanlar
space

Space

Zorunlu. Güncellenecek alanların bulunduğu alan. Space.name, spaces/{space} biçiminde doldurulmalıdır. Yalnızca update_mask tarafından belirtilen alanlar güncellenir.

update_mask

FieldMask

Zorunlu. Güncellenen alan yolları (birden fazla varsa virgülle ayrılmış).

Bir alan için aşağıdaki alanları güncelleyebilirsiniz:

space_details: Alanın açıklamasını günceller. En fazla 150 karakter desteklenir.

display_name: Yalnızca spaceType alanının SPACE olduğu alanların görünen adının güncellenmesini destekler. ALREADY_EXISTS hata mesajını alırsanız farklı bir değer deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

space_type: Yalnızca GROUP_CHAT alan türünü SPACE olarak değiştirmeyi destekler. Güncelleme maskesine display_name ile birlikte space_type öğesini ekleyin ve belirtilen alanın boş olmayan bir görünen ada ve SPACE alan türüne sahip olduğundan emin olun. Görünen adı güncellerken belirtilen alana space_type maskesini ve SPACE türünü eklemek, mevcut alanda SPACE türü zaten varsa isteğe bağlıdır. Alan türünü başka yöntemlerle güncellemeye çalışmak geçersiz bağımsız değişken hatasına neden olur. space_type, useAdminAccess ile desteklenmez.

space_history_state: Alanın geçmişini açarak veya kapatarak alan geçmişi ayarlarını günceller. Yalnızca Google Workspace kuruluşu için geçmiş ayarları etkinleştirilmişse desteklenir. Alan geçmişi durumunu güncellemek için isteğinizdeki diğer tüm alan maskelerini çıkarmanız gerekir. space_history_state, useAdminAccess ile desteklenmez.

access_settings.audience: spaceType alanının SPACE olduğu adlandırılmış alanda, alanı kimlerin keşfedebileceği, alana kimlerin katılabileceği ve mesajları kimlerin önizleyebileceğiyle ilgili erişim ayarını günceller. Mevcut alanda hedef kitle varsa bu alan maskesi için bir değer atlamadan kitleyi kaldırabilir ve alan erişimini kısıtlayabilirsiniz. Bir alanın erişim ayarlarını güncellemek için kimliği doğrulayan kullanıcının alan yöneticisi olması ve isteğinizdeki diğer tüm alan maskelerini atlaması gerekir. Alan içe aktarma modundaysa bu alanı güncelleyemezsiniz. Daha fazla bilgi edinmek için Belirli kullanıcıların alanları bulmasını sağlama başlıklı makaleyi inceleyin. access_settings.audience, useAdminAccess ile desteklenmez.

permission_settings: Alanın izin ayarlarını değiştirmeyi destekler. İzin ayarlarını güncellerken yalnızca permissionSettings alan maskelerini belirtebilirsiniz. Diğer alan maskelerini aynı anda güncelleyemezsiniz. permissionSettings, useAdminAccess ile desteklenmez. Desteklenen alan maskeleri şunlardır:

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

İsteğe bağlıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

chat.admin.spaces OAuth 2.0 kapsamı gerektirir.

Bazı FieldMask değerleri, yönetici erişimi kullanılarak desteklenmez. Ayrıntılar için update_mask açıklamasına bakın.

Kullanıcı

Google Chat'teki bir kullanıcı. Bir istekten çıkış olarak döndürüldüğünde, Chat uygulamanız kullanıcı olarak kimlik doğrulaması yaparsa User kaynağının çıkışında yalnızca kullanıcının name ve type değerleri doldurulur.

Alanlar
name

string

Google Chat user için kaynak adı.

Biçim: users/{user}. users/app, arama uygulaması bot kullanıcısı için takma ad olarak kullanılabilir.

human users için {user}, aşağıdakiyle aynı kullanıcı tanımlayıcısıdır:

  • People API'deki Kişi için id. Örneğin, Chat API'deki users/123456789, People API'deki 123456789 kişi profili kimliğiyle aynı kişiyi temsil eder.

  • Yönetici SDK'sı Directory API'de kullanıcı için id.

  • Kullanıcının e-posta adresi, API isteklerinde {user} için alan takma adı olarak kullanılabilir. Örneğin, user@example.com için People API Kişi profili kimliği 123456789 ise users/123456789 öğesine referans vermek için users/user@example.com öğesini takma ad olarak kullanabilirsiniz. API'den yalnızca kurallı kaynak adı (örneğin, users/123456789) döndürülür.

display_name

string

Yalnızca çıkış. Kullanıcının görünen adı.

domain_id

string

Kullanıcının Google Workspace alanının benzersiz tanımlayıcısı.

type

Type

Kullanıcı türü.

is_anonymous

bool

Yalnızca çıkış. true olduğunda kullanıcı silinir veya profili görünmez.

Tür

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. KULLANMAYIN.
HUMAN Gerçek bir kullanıcı.
BOT Chat uygulaması kullanıcısı.

UserMentionMetadata

Kullanıcı bahsetmeleri (@) için ek açıklama meta verileri.

Alanlar
user

User

Bahsedilen kullanıcı.

type

Type

Kullanıcı bahsetme türü.

Tür

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
ADD Kullanıcıyı alana ekleyin.
MENTION Alanda kullanıcıdan bahsetme

WidgetMarkup

Widget, metin ve resimler sunan bir kullanıcı arayüzü öğesidir.

Alanlar
buttons[]

Button

Düğme listesi. Düğmeler de oneof data ve bu alanlardan yalnızca biri ayarlanmalıdır.

Birleştirme alanı data. Bir WidgetMarkup yalnızca aşağıdaki öğelerden birini içerebilir. Daha fazla öğe görüntülemek için birden fazla WidgetMarkup alanı kullanabilirsiniz. data yalnızca aşağıdakilerden biri olabilir:
text_paragraph

TextParagraph

Bu widget'ta bir metin paragrafı gösterin.

image

Image

Bu widget'ta bir resim gösterin.

key_value

KeyValue

Bu widget'ta bir anahtar/değer öğesi gösterin.

Düğme

Düğme. Metin düğmesi veya resim düğmesi olabilir.

Alanlar

Birleştirme alanı type.

type yalnızca aşağıdakilerden biri olabilir:

text_button

TextButton

Metin ve onclick işlem içeren bir düğme.

image_button

ImageButton

Resim ve onclick işlemi içeren bir düğme.

FormAction

Form işlemi, form gönderildiğinde gerçekleşen davranışı tanımlar. Örneğin, formu işlemek için Apps Komut Dosyası'nı çağırabilirsiniz.

Alanlar
action_method_name

string

Yöntem adı, formun hangi bölümünün form gönderimini tetiklediğini belirlemek için kullanılır. Bu bilgiler, kart tıklama etkinliğinin bir parçası olarak Chat uygulamasına geri gönderilir. Ortak bir davranışı tetikleyen birkaç öğe için aynı yöntem adını kullanabilirsiniz.

parameters[]

ActionParameter

İşlem parametrelerinin listesi.

ActionParameter

İşlem yöntemi çağrıldığında sağlanacak dize parametrelerinin listesi. Örneğin, üç erteleme düğmesi olduğunu düşünelim: şimdi ertele, bir gün ertele, gelecek hafta ertele. Dize parametreleri listesinde erteleme türünü ve erteleme süresini ileterek action method = snooze() kullanabilirsiniz.

Alanlar
key

string

İşlem komut dosyasının parametresinin adı.

value

string

Parametrenin değeri.

Simge

Desteklenen simgeler kümesi.

Sıralamalar
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Resim

Bir URL ile belirtilen ve onclick işlemi içerebilen resim.

Alanlar
image_url

string

Resmin URL'si.

on_click

OnClick

onclick işlemi.

aspect_ratio

double

Bu resmin en boy oranı (genişlik ve yükseklik). Bu alan, resmin yüklenmesini beklerken doğru yüksekliği ayırmanıza olanak tanır. Bu özellik, resmin yerleşik en boy oranını geçersiz kılmak için tasarlanmamıştır. Ayarlanmamışsa sunucu, resmi önceden getirerek bu alanı doldurur.

ImageButton

onclick işlemi içeren bir resim düğmesi.

Alanlar
on_click

OnClick

onclick işlemi.

name

string

Erişilebilirlik için kullanılan bu image_button öğesinin adı. Bu ad belirtilmezse varsayılan değer sağlanır.

Birleştirme alanı icons. Simge, Icon enum veya URL ile belirtilebilir. icons yalnızca aşağıdakilerden biri olabilir:
icon

Icon

Chat API tarafından sağlanan bir simgeyi indeksleyen enum ile belirtilen simge.

icon_url

string

URL ile belirtilen simge.

KeyValue

Bir kullanıcı arayüzü öğesi, anahtar (etiket) ve değer (içerik) içerir. Bu öğe, onclick düğmesi gibi bazı işlemleri de içerebilir.

Alanlar
top_label

string

Üst etiketin metni. Biçimlendirilmiş metin desteklenir. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metin biçimlendirme ve Google Workspace eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

content

string

İçeriğin metni. Biçimlendirilmiş metin desteklenir ve her zaman gereklidir. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metin biçimlendirme ve Google Workspace eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

content_multiline

bool

İçerik çok satırlı olmalıdır.

bottom_label

string

Alt etiketin metni. Biçimlendirilmiş metin desteklenir. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metin biçimlendirme ve Google Workspace eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

on_click

OnClick

onclick işlemi. Yalnızca üst etiket, alt etiket ve içerik bölgesi tıklanabilir.

Birleştirme alanı icons. Simgelerden en az biri (top_label ve bottom_label) tanımlanmalıdır. icons yalnızca aşağıdakilerden biri olabilir:
icon

Icon

Chat API tarafından ilgili simge resmiyle değiştirilen bir enum değeri.

icon_url

string

URL ile belirtilen simge.

Birleştirme alanı control. Kontrol widget'ı. button veya switch_widget değerini ayarlayabilirsiniz ancak ikisini birden ayarlayamazsınız. control yalnızca aşağıdakilerden biri olabilir:
button

Button

Bir işlemi tetiklemek için tıklanabilen düğme.

OnClick

Bir onclick işlemi (örneğin, bağlantı açma).

Alanlar

Birleştirme alanı data.

data yalnızca aşağıdakilerden biri olabilir:

action

FormAction

Belirtilmişse bu onclick işlemiyle bir form işlemi tetiklenir.

TextButton

Metin ve onclick işlemi içeren bir düğme.

Alanlar
text

string

Düğmenin metni.

on_click

OnClick

Düğmenin onclick işlemi.

TextParagraph

Bir metin paragrafı. Biçimlendirilmiş metin desteklenir. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metin biçimlendirme ve Google Workspace eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

Alanlar
text

string