Package google.chat.v1

Dizin

ChatService

Geliştiricilerin, Google Chat Platformu'nda Chat uygulamaları ve entegrasyonları geliştirmesine 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 hale getirir. Uygulama kimlik doğrulaması ve alan genelinde yetki gerektirir. Daha fazla bilgi için Google Chat uygulamalarını veri içe aktarması için 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ılavuzunu inceleyin.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Arama uygulaması için gerçek kişi tarafından oluşturulan üyelik veya uygulama üyeliği oluşturur. Diğer uygulamalar için üyelik oluşturma işlemi desteklenmiyor. Örnek için Alana kullanıcı veya Google Chat uygulaması davet etme ya da ekleme başlıklı makaleyi inceleyin. Üyelik oluştururken, belirtilen üyenin otomatik kabul politikası devre dışıysa davet edilir ve katılmadan önce alan davetini kabul etmesi gerekir. Aksi takdirde, üyelik oluşturulduğunda üye doğrudan belirtilen alana eklenir. Kullanıcı kimlik doğrulaması gerekir.

Eklenecek üyeyi belirtmek üzere gerçek üye veya uygulama üyesi için membership.member.name değerini ya da grup üyesi için membership.group_member.name değerini ayarlayın.

  • Arama uygulamasını bir alana veya iki kullanıcı arasındaki doğrudan mesajlara eklemek için users/app kullanın. Alana başka uygulamalar eklenemiyor.

  • Gerçek kullanıcı eklemek için users/{user} 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şi için id veya Directory API'deki kullanıcı için id 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.

  • Adlandırılmış bir alana Google grubu eklemek veya mevcut bir Google grubunu davet etmek için groups/{group} kullanın. Burada {group}, Cloud Identity Groups API'deki grubun id değeridir. Örneğin, group@example.com grup e-postasının 123456789 kimliğini almak için Cloud Identity Groups arama API'sini kullanabilir, ardından membership.group_member.name öğesini groups/123456789 olarak ayarlayarak grubu adlandırılmış bir alana ekleyebilir veya davet edebilirsiniz. Grup e-posta adresleri desteklenmez ve Google grupları yalnızca adlandırılmış alanlara üye olarak eklenebilir.

Yetkilendirme kapsamları

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

  • 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ılavuzunu inceleyin.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Google Chat alanında mesaj oluşturur. Metin ve kartlar dahil olmak üzere maksimum ileti boyutu 32.000 bayttır. Örnek için Mesaj gönderme başlıklı makaleyi inceleyin.

Bu yöntemi çağırmak için kimlik doğrulama gerekir ve aşağıdaki kimlik doğrulama türleri desteklenir:

  • Kısa mesajlarda, kullanıcı kimlik doğrulaması veya uygulama kimlik doğrulaması desteklenir.
  • Kart mesajları için yalnızca uygulama kimlik doğrulaması desteklenir. (Yalnızca Chat uygulamaları kart mesajları oluşturabilir.)
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ılavuzunu inceleyin.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Tepki oluşturur ve bir mesaja ekler. Yalnızca unicode emojiler desteklenir. Örneğin, Bir iletiye tepki ekleme başlıklı makaleyi inceleyin. Kullanıcı kimlik doğrulaması gerekir.

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ılavuzunu inceleyin.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Adlandırılmış bir alan oluşturur. Konulara göre gruplandırılmış alanlar desteklenmez. Örnek için Alan oluşturma başlıklı makaleyi inceleyin.

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

Kullanıcı kimlik doğrulaması gerekir.

Yetkilendirme kapsamları

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

  • 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ılavuzunu inceleyin.

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

Kullanıcı kimlik doğrulaması gerekir.

Yetkilendirme kapsamları

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

  • 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ılavuzunu inceleyin.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Bir iletiyi siler. Örnek için, Mesaj silme başlıklı makaleyi inceleyin.

Kimlik doğrulama gerekir. Uygulama kimlik doğrulamasını ve kullanıcı kimlik doğrulamasını destekler. Uygulama kimlik doğrulaması kullanılırken istekler yalnızca aramayı yapan 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ılavuzunu inceleyin.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Bir mesaja verilen tepkiyi siler. Yalnızca unicode emojiler desteklenir. Örneğin, Tepkiyi silme başlıklı makaleyi inceleyin. Kullanıcı kimlik doğrulaması gerekir.

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ılavuzunu inceleyin.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Adlandırılmış bir alanı siler. Her zaman basamaklı silme işlemi gerçekleştirir. Bu durumda, alanda yayınlanan mesajlar ve alandaki üyelikler gibi alanın alt kaynakları da silinir. Örnek için Alan silme başlıklı makaleyi inceleyin. Alanı silme izni olan bir kullanıcıdan kullanıcı kimlik doğrulaması alınmasını gerektirir.

Yetkilendirme kapsamları

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

  • 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ılavuzunu inceleyin.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Belirtilen kullanıcıyla olan 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.

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.

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

Kullanıcı kimlik doğrulaması veya uygulama kimlik doğrulaması gerektirir.

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ılavuzunu inceleyin.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Bir mesaj ekinin meta verilerini alır. Ek verileri, media API kullanılarak getirilir. Örnek için İleti ekleri hakkında meta veri alma başlıklı makaleye bakın. Uygulama kimlik doğrulaması gerekir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Üyelikle ilgili ayrıntıları döndürür. Örnek için Bir kullanıcının veya Google Chat uygulamasının üyeliğiyle ilgili ayrıntıları alma başlıklı makaleyi inceleyin.

Kimlik doğrulama gerekir. Uygulama kimlik doğrulamasını ve kullanıcı kimlik doğrulamasını destekler.

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ılavuzunu inceleyin.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Bir iletiyle ilgili ayrıntıları döndürür. Örnek için Bir mesajla ilgili ayrıntıları alma başlıklı makaleye bakın.

Kimlik doğrulama gerekir. Uygulama kimlik doğrulamasını ve kullanıcı kimlik doğrulamasını destekler.

Not: Engellenen üye veya alandan gelen bir 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ılavuzunu inceleyin.

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

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

Kimlik doğrulama gerekir. Uygulama kimlik doğrulamasını ve kullanıcı kimlik doğrulamasını destekler.

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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

Kullanıcı kimlik doğrulaması gerekir. Bir etkinliği almak için kimliği doğrulanan kullanıcının alanın üyesi olması gerekir.

Örnek için Google Chat alanından 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ılavuzunu inceleyin.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Bir kullanıcının alandaki okunma durumuyla ilgili ayrıntıları döndürür. Bu ayrıntılar, okunmuş ve okunmamış mesajları tanımlamak için kullanılır. Örnek için Bir kullanıcının alanının okuma durumuyla ilgili ayrıntıları alma başlıklı makaleyi inceleyin.

Kullanıcı kimlik doğrulaması gerekir.

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ılavuzunu inceleyin.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Bir kullanıcının, okunmuş ve okunmamış iletileri tanımlamak için kullanılan ileti dizisindeki okuma durumuyla ilgili ayrıntıları döndürür. Örnek için Bir kullanıcının ileti dizisinin okunma durumuyla ilgili ayrıntıları alma başlıklı makaleye bakın.

Kullanıcı kimlik doğrulaması gerekir.

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ılavuzunu inceleyin.

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 üyelik girişi, Chat uygulamasının erişebildiği alanlardaki üyelikleri listeler ancak kendi üyelikleri de dahil olmak üzere Chat uygulaması üyeliklerini hariç tutar. Kullanıcı kimlik doğrulaması ile giriş yaptığınızda, kimliği doğrulanmış kullanıcının erişebildiği alanlardaki üyelikler listelenir.

Kimlik doğrulama gerekir. Uygulama kimlik doğrulamasını ve kullanıcı kimlik doğrulamasını destekler.

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ılavuzunu inceleyin.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Engellenen üyeler ve alanlardan gelen mesajlar da dahil olmak üzere, arayanın üyesi olduğu bir alandaki mesajları listeler. Örnek için Mesajları listeleme bölümüne göz atın. Kullanıcı kimlik doğrulaması gerekir.

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ılavuzunu inceleyin.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Bir mesaja verilen tepkileri listeler. Örnek için Mesaja verilen tepkileri listeleme başlıklı makaleyi inceleyin. Kullanıcı kimlik doğrulaması gerekir.

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ılavuzunu inceleyin.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

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

Örnek için Bir 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ılavuzunu inceleyin.

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Arayanın üyesi olduğu alanları listeler. İlk mesaj gönderilene kadar grup sohbetleri ve DM'ler listelenmez. Örnek için Alanları listeleme bölümünü inceleyin.

Kimlik doğrulama gerekir. Uygulama kimlik doğrulamasını ve kullanıcı kimlik doğrulamasını destekler.

Arayanın veya kimliği doğrulanmış kullanıcının görebildiği alanları listeler. İlk mesaj gönderilene kadar grup sohbetleri ve DM'ler listelenmez.

Google Workspace kuruluşuna göre tüm adlandırılmış alanları listelemek için 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ılavuzunu inceleyin.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Kullanıcının yaptığı aramaya bağlı olarak alanların listesini döndürür. Kullanıcı kimlik doğrulaması gerekir. Kullanıcı, Google Workspace kuruluşunun yöneticisi olmalıdır. İstekte use_admin_access öğesini 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ılavuzunu inceleyin.

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

Eklenecek gerçek kişilerden oluşan üyeleri belirtmek için üyelikleri uygun membership.member.name öğesine ekleyin. Gerçek kullanıcı eklemek için users/{user} 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şi için id veya Directory API'deki kullanıcı için id 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 üyelikleri uygun membership.group_member.name ile ekleyin. Bir Google grubu eklemek veya davet etmek için groups/{group} kullanın. Burada {group}, grubun Cloud Identity Groups API'sinden id değeridir. Örneğin, group@example.com grup e-postasının 123456789 kimliğini almak için Cloud Identity Groups arama API'sini kullanabilir, ardından membership.group_member.name öğesini groups/123456789 olarak ayarlayarak grubu alana ekleyebilirsiniz. Grup e-posta adresleri desteklenmez ve Google grupları yalnızca adlandırılmış alanlara üye olarak eklenebilir.

Adlandırılmış bir alan veya grup sohbetinde, arayan kişiyi bazı üyeler engelliyorsa, engelliyorsa veya bazı üyeleri ekleme iznine sahip değilse söz konusu ü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 kullanıcıyı temsil edecek 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 arama uygulaması arasında DM oluşturmak için Space.singleUserBotDm öğesini true olarak ayarlayın ve üyelik belirtmeyin. Bu yöntemi yalnızca arama uygulamasıyla bir DM ayarlamak için kullanabilirsiniz. Görüşme uygulamasını bir alanın üyesi olarak eklemek veya iki kullanıcı arasındaki mevcut bir DM'yi eklemek için Alana kullanıcı veya uygulama davet etme ya da ekleme başlıklı makaleyi inceleyin.

İki kullanıcı arasında halihazırda bir DM varsa, istek yapıldığı anda bir kullanıcı diğerini engellese bile mevcut DM döndürülür.

Mesaj dizisi halinde yanıtların olduğu alanlar desteklenmez. Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki mevcut bir alanda bu görünen ad zaten kullanılıyor olabilir.

Kullanıcı kimlik doğrulaması gerekir.

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ılavuzunu inceleyin.

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

Kullanıcı kimlik doğrulaması gerekir.

Yetkilendirme kapsamları

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

  • 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ılavuzunu inceleyin.

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

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

Kimlik doğrulama gerekir. Uygulama kimlik doğrulamasını ve kullanıcı kimlik doğrulamasını destekler. Uygulama kimlik doğrulaması kullanılırken istekler yalnızca aramayı yapan 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ılavuzunu inceleyin.

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Bir alanı günceller. Örnek için Alan güncelleme başlıklı makaleyi inceleyin.

displayName alanını güncelliyor ve ALREADY_EXISTS hata mesajını alıyorsanız farklı bir görünen ad deneyin. Google Workspace kuruluşundaki mevcut bir alanda bu görünen ad zaten kullanılıyor olabilir.

Kullanıcı kimlik doğrulaması gerekir.

Yetkilendirme kapsamları

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

  • 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ılavuzunu inceleyin.

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Kullanıcının bir alandaki okunma durumunu günceller. Bu durum, okunmuş ve okunmamış mesajları tanımlamak için kullanılır. Örnek için Kullanıcının alan okuma durumunu güncelleme başlıklı makaleyi inceleyin.

Kullanıcı kimlik doğrulaması gerekir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.

AccessoryWidget

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

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

ButtonList

Düğme listesi.

ActionResponse

Bir 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 kimliğini doğrulaması veya yapılandırması için URL. (Yalnızca REQUEST_CONFIG yanıt türü için.)

dialog_action

DialogAction

Yalnızca giriş. Bir iletişim kutusuyla ilgili etkileşim etkinliğine verilen yanıt. ResponseType.Dialog eşlik etmelidir.

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ınla.
UPDATE_MESSAGE Chat uygulamasının mesajını güncelleyin. Bu işleme yalnızca ileti gönderen türünün BOT olduğu CARD_CLICKED etkinliklerinde izin verilir.
UPDATE_USER_MESSAGE_CARDS Bir kullanıcının mesajındaki kartları güncelleyin. Buna yalnızca eşleşen URL'ye sahip bir MESSAGE etkinliğine veya ileti 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 isteğini gizli olarak isteyin.
DIALOG İletişim kutusu gösterir.
UPDATE_WIDGET Widget metin otomatik tamamlama seçenekleri sorgusu.

SelectionItems

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

Alanlar
items[]

SelectionItem

Seçim Öğesi nesnelerinden oluşan bir dizi.

UpdatedWidget

Güncellenen widget'ın yanıtı. Bir widget için otomatik tamamlama seçenekleri sağlamak üzere kullanılır.

Alanlar
widget

string

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

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

SelectionItems

Widget otomatik tamamlama sonuçlarının listesi

ActionStatus

Bir iletişim kutusunu çağırmak veya göndermek için isteğin durumunu temsil eder.

Alanlar
status_code

Code

Durum kodu.

user_facing_message

string

Kullanıcılara isteklerinin durumu hakkında gönderilen mesaj. Politika ayarlanmazsa status_code temel alınarak genel bir mesaj gönderilir.

Ek Açıklama

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

Örnek düz metin mesaj gövdesi:

Hello @FooBot how are you!"

İlgili ek açıklama 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çıklamaya karşılık gelen düz metin ileti gövdesindeki alt dizenin uzunluğu.

start_index

int32

Bu ek açıklamanın karşılık gelen düz metin ileti gövdesinde başlangıç dizini (0 tabanlı, dahil).

Birleştirme alanı metadata. Ek açıklamayla ilgili ek meta veriler. metadata şunlardan yalnızca biri olabilir:
user_mention

UserMentionMetadata

Kullanıcıdan bahsetmeyle ilgili meta veriler.

slash_command

SlashCommandMetadata

Eğik çizgi komutu için meta veriler.

AnnotationType

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

Sıralamalar
ANNOTATION_TYPE_UNSPECIFIED Sıralama için varsayılan değer. Kullanmayın.
USER_MENTION Bir kullanıcıdan bahsediliyor.
SLASH_COMMAND Eğik çizgi komutu çağrılır.

AttachedGif

URL ile belirtilen bir GIF resmi.

Alanlar
uri

string

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

Ek

Google Chat'te ek.

Alanlar
name

string

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

content_name

string

Yalnızca çıkış. İçeriğin tam yol 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 gerçek kullanıcıya önizlemek için kullanılması gereken küçük resim URL'si. Chat uygulamaları, ek içeriklerini indirmek için bu URL'yi kullanmamalıdır.

download_uri

string

Yalnızca çıkış. Bir gerçek kullanıcının eki indirmesine olanak tanımak için kullanılması gereken indirme URL'si. Chat uygulamaları, ek içeriklerini indirmek için bu URL'yi kullanmamalıdır.

source

Source

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

Birleştirme alanı data_ref. Eke yönelik veri referansı. data_ref şunlardan yalnızca biri olabilir:
attachment_data_ref

AttachmentDataRef

Ek verileri için bir referans. Bu alan, ek verilerini indirmek için medya API'si ile kullanılır.

drive_data_ref

DriveDataRef

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

Kaynak

Ekin kaynağı.

Sıralamalar
SOURCE_UNSPECIFIED Ayrıldı.
DRIVE_FILE Dosya bir Google Drive dosyası olmalıdır.
UPLOADED_CONTENT Dosya Chat'e yüklenir.

AttachmentDataRef

Ek verileri için bir referans.

Alanlar
resource_name

string

Ek verilerinin kaynak adı. Bu alan, ek verilerini indirmek için medya API'si ile kullanılır.

attachment_upload_token

string

Yüklenen bir eke referans içeren opak jeton. İstemciler tarafından opak bir dize olarak ele alınır ve ek içeren Chat mesajlarını oluşturmak veya güncellemek için kullanılır.

CardWithId

Google Chat mesajındaki bir 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 kartları tasarlayın ve önizleyin.

Kart Oluşturucu'yu açın

Alanlar
card_id

string

Mesajda birden fazla kart varsa gereklidir. Bir mesajdaki kartın benzersiz tanımlayıcısıdır.

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 ileti 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şleminin tamamlandığına dair mesaj isteyin.

Alanlar
name

string

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

Biçim: spaces/{space}

CompleteImportSpaceResponse

Bir alanın içe aktarma işlemini tamamladığını belirten 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 belirtmesi için kullanılan işaretleme.

Kart

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

Alanlar
header

CardHeader

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

sections[]

Section

Bölümler çizgi ayırıcıyla ayrılır.

card_actions[]

CardAction

Bu kartla ilgili işlemler.

name

string

Kartın adı.

CardAction

Kart işlemi, kartla ilişkilendirilmiş işlemdir. Fatura kartları için tipik işlem şu şekildedir: faturayı silme veya faturayı e-posta ile silme ya da faturayı tarayıcıda açma.

Google Chat uygulamalarında desteklenmez.

Alanlar
action_label

string

Etiket, daha önce işlem menüsü öğesinde görüntüleniyordu.

on_click

OnClick

Bu işlem öğesi için tıklama işlemi.

CardHeader

Alanlar
title

string

Başlık belirtilmelidir. Üstbilginin sabit yüksekliği vardır: 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ü (örneğin, kare kenarlık veya yuvarlak 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ıraya göre oluşturulan (dikey olarak) widget koleksiyonunu içerir. Tüm platformlarda, kartlar dar bir sabit genişliğe sahiptir. Bu nedenle, şu anda düzen özelliklerine (ör. kayan) ihtiyaç duyulmaz.

Alanlar
header

string

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

widgets[]

WidgetMarkup

Bir bölümde en az bir widget bulunmalıdır.

CreateMembershipRequest

Üyelik oluşturma için istekte bulunun.

Alanlar
parent

string

Zorunlu. Üyelik oluşturulacak alanın kaynak adı.

Biçim: boşluk/{boşluk}

membership

Membership

Zorunlu. Oluşturulacak üyelik ilişkisi. memberType alanı, user.name ve user.type alanlarının doldurulduğu bir kullanıcı içermelidir. Sunucu bir kaynak adı atar ve belirtilen her şeyin üzerine yazar. Chat uygulaması, gerçek bir kullanıcı için üyelik ilişkisi oluşturduğunda chat.memberships kapsamını kullanmalı, user.type öğesini HUMAN olarak ayarlamalı ve user.name biçimini users/{user} (burada {user}, kullanıcının e-posta adresi olabilir) olarak ayarlamalıdır. Aynı Workspace kuruluşundaki kullanıcılar için {user}, People API'deki kişinin id değeri veya Directory API'deki kullanıcı için id 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. Bir Chat uygulaması kendisi için üyelik ilişkisi oluşturduğunda chat.memberships.app kapsamını kullanmalı, user.type ve BOT olarak ayarlanmalı user.name, users/app olarak ayarlanmalıdır.

use_admin_access

bool

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

Görüşmeyi yapan 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ı gerekir.

Uygulama üyeliği oluşturma veya yöneticinin Google Workspace kuruluşunun dışında yer alan kullanıcılar için üyelik oluşturma işlemleri, yönetici erişimi kullanılarak desteklenmez.

CreateMessageRequest

Bir mesaj oluşturur.

Alanlar
parent

string

Zorunlu. Mesaj oluşturulacak alanın kaynak adı.

Biçim: spaces/{space}

message

Message

Zorunlu. E-posta mesajı.

thread_key
(deprecated)

string

İsteğe bağlı. Desteği sonlandırıldı: Bunun yerine thread.thread_key kullanın. İleti dizisinin kimliği. 4.000 karaktere kadar destekler. Bir ileti dizisi başlatmak veya ileti dizisine eklemek için bir ileti oluşturun ve threadKey ya da thread.name belirtin. Kullanım örnekleri için İleti dizisi başlatma veya yanıtlama başlıklı makaleye bakın.

request_id

string

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

message_reply_option

MessageReplyOption

İsteğe bağlı. Bir mesajın, mesaj dizisi mi başlatacağını yoksa bir mesaj dizisine yanıt mı vereceğini belirtir. Yalnızca adlandırılmış alanlarda desteklenir.

message_id

string

İsteğe bağlı. Bir mesajın özel kimliği. Chat uygulamalarının, mesajın kaynak adında (mesaj name alanında gösterilir) sistem tarafından atanmış kimliği depolamasına gerek kalmadan mesaj almasını, güncellemesini veya silmesini sağlar.

Bu alanın değeri aşağıdaki şartları 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 ve yalnızca küçük harf, sayı ve kısa çizgi içerebilir.
  • Bir alan içinde benzersiz olmalıdır. Chat uygulamaları, farklı mesajlar için aynı özel kimliği kullanamaz.

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

MessageReplyOption

Bir iletinin nasıl yanıtlanacağını belirtir. Gelecekte daha fazla eyalet eklenebilir.

Sıralamalar
MESSAGE_REPLY_OPTION_UNSPECIFIED Varsayılan. Yeni bir ileti dizisi başlatır. Bu seçeneğin kullanılması, dahil edilen tüm thread ID veya thread_key öğelerini yoksayar.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD İletiyi, thread ID veya thread_key tarafından belirtilen ileti dizisine yanıt olarak oluşturur. Başarısız olursa ileti, bunun yerine yeni bir ileti dizisi başlatır.
REPLY_MESSAGE_OR_FAIL İletiyi, thread ID veya thread_key tarafından belirtilen ileti dizisine yanıt olarak oluşturur. Yeni bir thread_key kullanılırsa yeni bir ileti dizisi oluşturulur. İleti oluşturulamazsa bunun yerine bir NOT_FOUND hatası döndürülür.

CreateReactionRequest

Bir mesaja tepki oluşturur.

Alanlar
parent

string

Zorunlu. Tepkinin oluşturulduğu mesaj.

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

reaction

Reaction

Zorunlu. İçerik üretme tepkisi.

CreateSpaceRequest

Adlandırılmış alan oluşturma isteği.

Alanlar
space

Space

Zorunlu. displayName ve spaceType alanları doldurulmalıdır. Yalnızca SpaceType.SPACE desteklenir.

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

name alanı sunucuda atandığından bu alanda belirtilen hiçbir şey yok sayılacak.

request_id

string

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

CustomEmoji

Özel bir emojiyi temsil eder.

Alanlar
uid

string

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

DeleteMembershipRequest

Alan üyeliğini silme isteği gönderin.

Alanlar
name

string

Zorunlu. Silinecek üyeliğin kaynak adı. Sohbet uygulamaları gerçek kullanıcıların verilerini silebilir üyelik satın alabilir. Chat uygulamaları diğer uygulamaları silemez. üyelikler.

Gerçek kişi olan bir üyeliği silerken chat.memberships kapsamı ve spaces/{space}/members/{member} biçimi gerekir. Bu 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.

Bir uygulama üyeliğini silerken 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

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

Görüşmeyi yapan 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ı gerekir.

Bir alandaki uygulama üyeliklerini silme işlemi, yönetici erişimi kullanılarak desteklenmez.

DeleteMessageRequest

Mesaj silme isteğinde bulunun.

Alanlar
name

string

Zorunlu. Mesajın kaynak adı.

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

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

force

bool

true durumunda, bir mesajı sildiğinizde mesaj dizili yanıtları da silinir. false durumunda, ileti dizisi halinde yanıtlar varsa silme işlemi başarısız olur.

Yalnızca kullanıcı olarak kimlik doğrularken geçerlidir. Chat uygulaması olarak kimlik doğrulama işleminin herhangi bir etkisi yoktur.

DeleteReactionRequest

Bir mesaja verilen tepkiyi 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

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

Görüşmeyi yapan 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ı gerekir.

DeletionMetadata

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

Alanlar
deletion_type

DeletionType

İletiyi kimin sildiğini belirtir.

DeletionType

Mesajı kimin sildiği ve nasıl silindiği.

Sıralamalar
DELETION_TYPE_UNSPECIFIED Bu değer kullanılmıyor.
CREATOR Kullanıcı kendi mesajını sildi.
SPACE_OWNER Alan sahibi mesajı sildi.
ADMIN Bir Google Workspace yöneticisi mesajı sildi.
APP_MESSAGE_EXPIRY Bir Chat uygulaması, süresi dolduğunda kendi mesajını sildi.
CREATOR_VIA_APP Bir Chat uygulaması, mesajı kullanıcı adına sildi.
SPACE_OWNER_VIA_APP Bir Chat uygulaması, alan sahibi adına mesajı sildi.

Dialog

İletişim kutusunun kart gövdesinin etrafında sarmalayıcı.

Alanlar
body

Card

Yalnızca giriş. İletişim kutusunun, kalıcı olarak oluşturulan gövdesi. Google Chat uygulamaları şu kart varlıklarını desteklemez: DateTimePicker, OnChangeAction.

DialogAction

Bir iletişim kutusu ve istek durum kodu içerir.

Alanlar
action_status

ActionStatus

Yalnızca giriş. Bir iletişim kutusunu çağırmak veya göndermek için isteğin durumu. Gerekirse kullanıcılara bir durum ve mesaj görüntüler. Örneğin, hata veya başarı durumunda.

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

Dialog

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

DriveDataRef

Bir Drive ekindeki verilere başvuru.

Alanlar
drive_file_id

string

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

DriveLinkData

Google Drive bağlantılarıyla ilgili veriler.

Alanlar
drive_data_ref

DriveDataRef

Bir Google Drive dosyasına referans veren DriveDataRef.

mime_type

string

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

Emoji

Mesajlara tepki olarak kullanılan emoji.

Alanlar
Birleştirme alanı content. Emojinin içeriği. content şunlardan yalnızca biri olabilir:
unicode

string

Unicode dizesiyle temsil edilen basit bir emoji.

custom_emoji

CustomEmoji

Yalnızca çıkış. Özel bir emoji.

EmojiReactionSummary

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

Alanlar
emoji

Emoji

Tepkilerle ilişkili emoji.

reaction_count

int32

İlişkili emojilerin kullanıldığı toplam tepki sayısıdır.

FindDirectMessageRequest

Kullanıcı kaynağına göre doğrudan mesaj alanı alma isteği.

Alanlar
name

string

Zorunlu. Doğrudan mesajı bulmak için kullanıcının kaynak adı.

Biçim: users/{user}, burada {user}, People API'deki kişi için id veya Directory API'deki kullanıcı için id değeridir. Örneğin, People API profil kimliği 123456789 ise name olarak users/123456789 kullanıp bu kişiyle gönderilen bir doğrudan mesajı bulabilirsiniz. Kullanıcı olarak kimliğiniz doğrulandığında, bu 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 bulunun.

Alanlar
name

string

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

GetMembershipRequest

Bir alan için üyelik isteğinde bulunun.

Alanlar
name

string

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

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

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

Kullanıcı olarak kimliğiniz doğrulandığında 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

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

Görüşmeyi yapan 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şimini kullanırken alanlarda uygulama üyeliklerinden yararlanma işlemi desteklenmez.

GetMessageRequest

Mesaj alma isteğinde bulunun.

Alanlar
name

string

Zorunlu. Mesajın kaynak adı.

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

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

GetSpaceEventRequest

Alan etkinliği almaya dair mesaj isteyin.

Alanlar
name

string

Zorunlu. Alan etkinliğinin kaynak adı.

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

GetSpaceReadStateRequest

GetSpaceReadState API için istek mesajı.

Alanlar
name

string

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

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

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

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

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

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

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

GetSpaceRequest

Tek bir alan döndürme isteği.

Alanlar
name

string

Zorunlu. Alanın spaces/{space} biçimindeki kaynak adı.

Biçim: spaces/{space}

use_admin_access

bool

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

Görüşmeyi yapan 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 için istek mesajı.

Alanlar
name

string

Zorunlu. Alınacak iş parçacığı okuma durumunun kaynak adı.

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

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

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

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

  • İlgili 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 bir Google grubu.

Alanlar
name

string

Bir Google Grubu için kaynak adı.

Cloud Identity Groups API'de bir grubu temsil eder.

Biçim: gruplar/{grup}

HistoryState

Mesajların ve alanların geçmiş durumu. Mesajların ve görüşme dizilerinin oluşturulduktan sonra ne kadar süre saklanacağını belirtir.

Sıralamalar
HISTORY_STATE_UNSPECIFIED Varsayılan değer. Kullanmayın.
HISTORY_OFF Geçmişe kayıt kapalı. Mesajlar ve ileti dizileri 24 saat saklanır.
HISTORY_ON Geçmişe kayıt açık. Kuruluşun Apps Kasası saklama kuralları, iletilerin ve ileti dizilerinin ne kadar süre saklanacağını belirtir.

ListMembershipsRequest

Üyelik listeleme için istek mesajı

Alanlar
parent

string

Zorunlu. Üyelik listesi getirilecek alanın kaynak adı.

Biçim: boşluk/{boşluk}

page_size

int32

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

Belirtilmezse en fazla 100 üyelik döndürülür.

Maksimum değer 1.000'dir. 1000'den fazla bir değer kullanırsanız bu değer otomatik olarak 1000'e değiştirilir.

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

page_token

string

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

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

filter

string

İsteğe bağlı. 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 değerini HUMAN veya BOT olarak ayarlayın. Geliştirici Önizlemesi: != operatörünü kullanarak member.type için de filtre uygulayabilirsiniz.

Hem rol hem de türe göre filtrelemek için AND operatörünü kullanın. Rol 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" gerekir. Diğer üye 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çersizdir:

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

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

show_groups

bool

İsteğe bağlı. true, diğer üyelik türlerine ek olarak Google Group ile ilişkili üyelikleri de iade eder. filter ayarlanırsa filtre ölçütleriyle eşleşmeyen Google Group üyelikleri döndürülmez.

show_invited

bool

İsteğe bağlı. true, diğer üyelik türlerine ek olarak invited üyeyle ilişkili üyelikleri de iade eder. Filtre ayarlanırsa filtre ölçütleriyle eşleşmeyen invited üyelikleri döndürülmez.

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

use_admin_access

bool

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

Görüşmeyi yapan 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ı gerekir.

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

ListMembershipsResponse

Alan üyeliklerini listeleme yanıtı.

Alanlar
memberships[]

Membership

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

next_page_token

string

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

ListMessagesRequest

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

Alanlar
parent

string

Zorunlu. Mesajlarının listeleneceği alanın kaynak adı.

Biçim: spaces/{space}

page_size

int32

Döndürülen maksimum ileti sayısı. Hizmet, bu değerden daha az ileti döndürebilir.

Belirtilmezse en fazla 25 kod döndürülür.

Maksimum değer 1.000'dir. 1000'den fazla bir değer kullanırsanız bu değer otomatik olarak 1000'e değiştirilir.

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

page_token

string

Önceki bir sorgudan devam ettiriliyorsa isteğe bağlıdır.

Önceki bir liste mesajları çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

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

filter

string

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 özelliğini RFC-3339 biçiminde bir zaman damgası ve çift tırnak işaretiyle belirtin. Örneğin, "2023-04-21T11:30:00-04:00". Bir zaman damgasından sonra oluşturulan mesajları listelemek için büyüktür operatörünü >, zaman damgasından sonra oluşturulan mesajları listelemek için ise küçüktür operatörünü (<) kullanabilirsiniz. Belirli bir zaman aralığı içindeki iletileri filtrelemek için iki zaman damgası arasında AND operatörünü kullanın.

İleti dizisine göre filtrelemek için spaces/{space}/threads/{thread} olarak biçimlendirilmiş thread.name özelliğini 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 INVALID_ARGUMENT hatasıyla sunucu tarafından reddedilir.

order_by

string

Önceki bir sorgudan devam ettiriliyorsa isteğe bağlıdır.

Mesaj listesinin sıralanma şekli. Sıralama işlemine göre sıralanacak bir değer belirtin. Geçerli sipariş işlemi değerleri şunlardır:

  • Artan için ASC.

  • Azalan için DESC.

Varsayılan sıralama create_time ASC şeklindedir.

show_deleted

bool

Silinen iletilerin eklenip eklenmeyeceğini belirtir. Silinen iletiler arasında, silinen zamanı ve silinme zamanıyla ilgili meta verileri içerir ancak ileti içeriği mevcut değildir.

ListMessagesResponse

Mesajları listelemeyle ilgili yanıt mesajı.

Alanlar
messages[]

Message

Mesaj listesi.

next_page_token

string

Sonuçların sonraki sayfasını almak için pageToken olarak bir jeton gönderebilirsiniz. Boşsa sonrasında başka 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öndürülen maksimum tepki sayısı. Hizmet, bu değerden daha az tepki döndürebilir. Belirtilmemişse 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ı. (Önceki bir sorgudan devam ettiriliyorsa.)

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

Sayfalara ayırırken 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ı. Sorgu filtresi.

Tepkileri emoji (emoji.unicode veya emoji.custom_emoji.uid) ve kullanıcı (user.name) ölçütüne göre filtreleyebilirsiniz.

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

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

Sorgunuzda hem AND hem de OR kullanılıyorsa bunları parantezle 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çersizdir:

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 sunucu tarafından reddedilir.

ListReactionsResponse

Liste tepkileri isteğine verilen yanıt.

Alanlar
reactions[]

Reaction

İstenen (veya ilk) sayfadaki tepkilerin listesi.

next_page_token

string

Sonuçların sonraki sayfasını almak için devam jetonu. Sonuç sayfasının son sayfası için boştur.

ListSpaceEventsRequest

Alan etkinliklerini listelemek 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öndürülen maksimum alan etkinliği sayısı. Hizmet bu değerden daha az değer döndürebilir.

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

page_token

string

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

Sayfalara ayırma işlemi sırasında alan etkinliklerini listelemek 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 aktarmak beklenmedik sonuçlara yol açabilir.

filter

string

Zorunlu. Sorgu filtresi.

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

Dilerseniz başlangıç zamanı (start_time) ve bitiş zamanı (end_time) temelinde de filtreleme yapabilirsiniz:

  • start_time: Alan etkinliklerini listelemeye başlamak için kullanılacak özel zaman damgası. 28 gün öncesine kadar gerçekleşmiş etkinlikleri listeleyebilirsiniz. Belirtilmemişse son 28 gündeki alan etkinlikleri listelenir.
  • end_time: Alan etkinliklerinin listelendiğine kadar olan kapsayıcı zaman damgası. Belirtilmemişse istek zamanına kadar olan etkinlikler listelenir.

Bir başlangıç veya bitiş zamanı belirtmek için eşittir = operatörünü ve RFC-3339'daki biçimini kullanın. Hem start_time hem de end_time ölçütüne göre 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çersizdir:

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 INVALID_ARGUMENT hatasıyla sunucu tarafından reddedilir.

ListSpaceEventsResponse

Alan etkinliklerinin listelenmesi için yanıt mesajı.

Alanlar
space_events[]

SpaceEvent

Sonuçlar kronolojik sırada (önce en eski etkinlik) döndürülür.

next_page_token

string

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

ListSpacesRequest

Arayanın üyesi olduğu alanların listelenmesi için gönderilen istek.

Alanlar
page_size

int32

İsteğe bağlı. Döndürülecek maksimum boşluk sayısı. Hizmet bu değerden daha az değer döndürebilir.

Belirtilmezse en fazla 100 alan döndürülür.

Maksimum değer 1.000'dir. 1000'den fazla bir değer kullanırsanız bu değer otomatik olarak 1000'e değiştirilir.

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

page_token

string

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

Sayfalara ayırırken 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ı. 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 sıralama değeri belirtmeniz gerekir (space_type, SPACE_TYPE_UNSPECIFIED olamaz). Birden çok alan türünü sorgulamak için 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 INVALID_ARGUMENT hatasıyla sunucu tarafından reddedilir.

ListSpacesResponse

Alan listeleme isteğinin yanıtı.

Alanlar
spaces[]

Space

İstenen (veya ilk) sayfadaki alanların listesi.

next_page_token

string

Sonuçların sonraki sayfasını almak için pageToken olarak bir jeton gönderebilirsiniz. Boşsa sonrasında başka sayfa yoktur.

MatchedUrl

Bir Chat mesajındaki eşleşen URL. Chat uygulamaları, eşleşen URL'leri önizleyebilir. Daha fazla bilgi için Önizleme bağlantıları konusuna bakın.

Alanlar
url

string

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

Üyelik

Google Chat'teki üyelik ilişkisini temsil eder (ör. bir kullanıcının veya Chat uygulamasının alana davet edilip edilmediği ya da alanda bulunmadığı).

Alanlar
name

string

Üyeliğin kaynak adı; sunucu tarafından atanır.

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

state

MembershipState

Yalnızca çıkış. Üyelik durumu.

role

MembershipRole

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

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

create_time

Timestamp

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

delete_time

Timestamp

İsteğe bağlı. Sabit. Üyeliğin silinme süresi (ör. üyenin alandan ayrılması veya çıkarılması). Bu alan, içe aktarma modundaki alanlarda geçmiş üyelikleri içe aktarmak için kullanıldığı durumlar dışında yalnızca çıkış olarak oluşturulur.

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

User

Üyeliğin ilişkili olduğu Google Chat kullanıcısı veya uygulaması. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yaparsa kullanıcı name ve type alanlarını doldurur.

group_member

Group

Üyeliğin ilişkili olduğu Google Grubu.

MembershipRole

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: Bu kullanıcı alanın üyesi değil ancak davet edilebilir. Google Groups için: Her zaman bu role atanırlar (gelecekte başka numaralandırma değerleri kullanılabilir).
ROLE_MEMBER Alanın bir üyesi. Kullanıcı, alana mesaj gönderme gibi temel izinlere sahiptir. 1:1 ve adsız grup görüşmelerinde herkes bu role sahiptir.
ROLE_MANAGER Alan yöneticisi Kullanıcı, tüm temel izinlerin yanı sıra alanı yönetmesini sağlayan yönetici izinlerine (ör. üye ekleme veya çıkarma) sahiptir. Yalnızca SpaceType.SPACE sürümünde desteklenir.

MembershipState

Üyenin alanla olan ilişkisini belirtir. Gelecekte diğer üyelik durumları 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 alana katılmamış.
NOT_A_MEMBER Kullanıcı alana ait değil ve alana katılmak için beklemede bir daveti yok.

MembershipBatchCreatedEventData

Birden fazla yeni üyeliğin etkinlik yükü.

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

Alanlar
memberships[]

MembershipCreatedEventData

Yeni üyeliklerin listesi.

MembershipBatchDeletedEventData

Silinen birden fazla üyeliğin etkinlik yükü.

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

Alanlar
memberships[]

MembershipDeletedEventData

Silinen üyeliklerin listesi.

MembershipBatchUpdatedEventData

Güncellenmiş birden çok üyeliğin etkinlik yükü.

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

Alanlar
memberships[]

MembershipUpdatedEventData

Güncellenen üyeliklerin listesi.

MembershipCreatedEventData

Yeni bir üyeliğin etkinlik yükü.

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

Alanlar
membership

Membership

Yeni üyelik.

MembershipDeletedEventData

Silinen bir üyeliğ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üncellenmiş bir üyeliğin etkinlik yükü.

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

Alanlar
membership

Membership

Güncellenen üyelik.

Mesaj

Google Chat alanında mesaj.

Alanlar
name

string

Mesajın kaynak adı.

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

Burada {space} iletinin yayınlandığı alanın kimliğidir. {message} ise ileti için sistem tarafından atanan kimliktir. Örneğin, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Mesaj oluştururken özel bir kimlik ayarlarsanız {message} değerini clientAssignedMessageId alanındaki değerle değiştirerek bir istekteki mesajı belirtmek için bu kimliği kullanabilirsiniz. Örneğin, spaces/AAAAAAAAAAA/messages/client-custom-name. Ayrıntılar için Mesajı 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ı yaparsa kullanıcı name ve type alanlarını doldurur.

create_time

Timestamp

İsteğe bağlı. Sabit. Chat'te oluşturulan alanlar için mesajın oluşturulduğu saat. Bu alan, içe aktarma modundaki alanlarda kullanılmadığı durumlar dışında yalnızca çıkış olarak oluşturulur.

İçe aktarma modundaki alanlarda, orijinal oluşturma zamanını korumak için bu alanı, mesajın kaynakta oluşturulduğu geçmiş zaman damgasına ayarlayın.

last_update_time

Timestamp

Yalnızca çıkış. Mesajın bir kullanıcı tarafından son düzenlendiği zaman. Mesaj hiç düzenlenmemişse bu alan boş bırakılır.

delete_time

Timestamp

Yalnızca çıkış. Mesajın Google Chat'te silindiği saat. Mesaj hiçbir zaman silinmezse bu alan boş bırakılır.

text

string

İletinin düz metin gövdesi. Bir resme, videoya veya web sayfasına giden ilk bağlantı bir önizleme çipi oluşturur. Ayrıca, bir Google Chat kullanıcısından veya alandaki herkesten@bahsedebilirsiniz.

Kısa mesaj oluşturma hakkında bilgi edinmek için Kısa 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 işaretleme söz dizimi.

  • <users/{user}> biçimi kullanılarak kullanıcıdan bahsediliyor.

  • İlk dizenin URL ve ikincisi oluşturulan metin olduğu <{url}|{rendered_text}> biçimini kullanan özel köprüler (ör. <http://example.com|custom text>).

  • :{emoji_name}: biçimini kullanan özel emoji (ör. :smile:). Bu durum, sırıtan yüz emojisi için U+1F600 gibi Unicode emojileri 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 kullanın.

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

cards_v2[]

CardWithId

Kartlar dizisi.

Yalnızca Chat uygulamaları kart oluşturabilir. Chat uygulamanızın kullanıcı olarak kimliği doğrulanıyorsa mesajlar kart içeremez.

Kartlar ve nasıl oluşturulacağı hakkında bilgi edinmek için Kart mesajları gönderme başlıklı makaleyi inceleyin.

Kart Oluşturucu ile kartları tasarlayın ve önizleyin.

Kart Oluşturucu'yu açın

annotations[]

Annotation

Yalnızca çıkış. Bu iletide text ile ilişkili notlar.

thread

Thread

İletinin ait olduğu ileti dizisi. Kullanım örnekleri için İleti dizisi başlatma veya yanıtlama başlıklı makaleye bakın.

space

Space

Chat uygulamanız kullanıcı olarak kimlik doğrulaması yaparsa çıkış, name alanını doldurur.

fallback_text

string

Mesaj kartlarının düz metin açıklamasıdır. Gerçek kartlar gösterilemediğinde (örneğin, mobil bildirimler) kullanılır.

action_response

ActionResponse

Yalnızca giriş. Bir 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ış. Chat uygulamasında bahsedilen tüm kısımların çıkarıldığı, düz metin mesajının gövdesi.

slash_command

SlashCommand

Yalnızca çıkış. Varsa Slash komutu bilgileri.

attachment[]

Attachment

Kullanıcı tarafından yüklenen ek.

matched_url

MatchedUrl

Yalnızca çıkış. spaces.messages.text ürününde bağlantı önizleme kalıbıyla eşleşen URL. Daha fazla bilgi için Önizleme bağlantıları konusuna bakın.

thread_reply

bool

Yalnızca çıkış. true olduğunda ileti, yanıt ileti dizisinde bir yanıttır. false itibarıyla mesaj, alanın üst düzey görüşmesinde, mesaj dizisinin ilk mesajı veya mesaj dizisi halinde yanıt içermeyen bir mesaj olarak görünür.

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

client_assigned_message_id

string

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

emoji_reaction_summaries[]

EmojiReactionSummary

Yalnızca çıkış. İletideki emoji tepki özetlerinin listesi.

private_message_viewer

User

Sabit. Mesaj oluşturmak için giriş, aksi takdirde yalnızca çıkış içindir. Mesajı görüntüleyebilen kullanıcı. Ayarlandığında mesaj gizli olur ve yalnızca belirtilen kullanıcı ile Chat uygulaması tarafından görülebilir. Gizli mesajlarda bağlantı önizlemeleri ve ekler desteklenmez.

Yalnızca Chat uygulamaları özel mesaj gönderebilir. Chat uygulamanız mesaj göndermek için kullanıcı olarak kimlik doğrulaması yaparsa mesaj gizli olamaz ve bu alanı atlamalıdır.

Ayrıntılı bilgi için Google Chat kullanıcılarına özel mesaj gönderme başlıklı makaleyi inceleyin.

deletion_metadata

DeletionMetadata

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

quoted_message_metadata

QuotedMessageMetadata

Yalnızca çıkış. Alandaki bir Google Chat kullanıcısı tarafından alıntılanan mesajla ilgili bilgiler. Google Chat kullanıcıları bir mesajı alıntılayarak yanıtlayabilir.

attached_gifs[]

AttachedGif

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

accessory_widgets[]

AccessoryWidget

Bir iletinin alt kısmında görünen bir veya daha fazla etkileşimli widget. Metin, kart veya hem metin hem de kart içeren iletilere aksesuar widget'ları ekleyebilirsiniz. İletişim kutusu içeren iletiler için desteklenmez. Ayrıntılı bilgi için İletinin alt kısmına etkileşimli widget'lar ekleme başlıklı makaleyi inceleyin.

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

MessageBatchCreatedEventData

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

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

Alanlar
messages[]

MessageCreatedEventData

Yeni mesajların listesi.

MessageBatchDeletedEventData

Silinen birden fazla mesaj için etkinlik yükü.

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

Alanlar
messages[]

MessageDeletedEventData

Silinen iletilerin listesi.

MessageBatchUpdatedEventData

Birden fazla güncellenen mesajın etkinlik yükü.

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

Alanlar
messages[]

MessageUpdatedEventData

Güncellenen mesajların listesi.

MessageCreatedEventData

Yeni mesajın etkinlik yükü.

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

Alanlar
message

Message

Yeni mesaj.

MessageDeletedEventData

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

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

Alanlar
message

Message

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

MessageUpdatedEventData

Güncellenen mesajın etkinlik yükü.

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

Alanlar
message

Message

Güncellenen mesaj.

QuotedMessageMetadata

Alıntılanan bir mesajla ilgili bilgiler.

Alanlar
name

string

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

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

last_update_time

Timestamp

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

Tepki

Mesaja verilen tepkidir.

Alanlar
name

string

Tepkinin kaynak adı.

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

user

User

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

emoji

Emoji

Tepkide kullanılan emoji.

ReactionBatchCreatedEventData

Birden fazla yeni tepkinin etkinlik yükü.

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

Alanlar
reactions[]

ReactionCreatedEventData

Yeni tepkilerin listesi.

ReactionBatchDeletedEventData

Silinen birden fazla tepkinin etkinlik yükü.

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

Alanlar
reactions[]

ReactionDeletedEventData

Silinen tepkilerin listesi.

ReactionCreatedEventData

Yeni bir tepkinin 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 şunlardan yalnızca 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 listesini arama isteğinde bulunun.

Alanlar
use_admin_access

bool

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

Görüşmeyi yapan 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ı gerekir.

Bu yöntem şu anda yalnızca yönetici erişimini desteklediğinden 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 bir değer döndürebilir.

Belirtilmezse en fazla 100 alan döndürülür.

Maksimum değer 1.000'dir. 1000'den fazla bir değer kullanırsanız bu değer otomatik olarak 1000'e değiştirilir.

page_token

string

Önceki arama alanları görüşmesinden alınan bir jeton. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalara ayırırken, sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler aktarmak 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. customers/my_customer desteklenen tek değerdir.

display_name yalnızca HAS (:) operatörünü kabul eder. Eşleştirilecek metin ilk olarak jetonlara dönüştürülür ve her jeton, alanın display_name herhangi bir yerinde alt dize olarak, büyük/küçük harfe duyarlı olmayan ve bağımsız bir şekilde ön ekle eşleşir. Ö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 kabul edilir.

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

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

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.

space_type, aynı alanda AND veya OR operatörlerini desteklemez. display_name, "space_history_state" ve "external_user_allowed" yalnızca OR operatörleri desteklenir. 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ı. Alan listesinin sıralanma şekli.

Sıralama ölçütü olarak 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 alandaki herhangi bir konuya en son uygun öğenin ne zaman eklendiğini gösterir.
  • create_time: Alanın oluşturulma zamanını gösterir.

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

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

  • Azalan için DESC.

Desteklenen söz dizimi:

  • 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

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

Alanlar
spaces[]

Space

İstenen alanların bir 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 alanların toplam sayısı. Sonuç 10.000 boşluktan fazlaysa bu değer tahminidir.

SetUpSpaceRequest

Alan oluşturma ve belirli kullanıcıları alana ekleme isteğinde bulunun.

Alanlar
space

Space

Zorunlu. Space.spaceType alanının doldurulması zorunludur.

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

Grup sohbeti oluşturmak için Space.spaceType öğesini GROUP_CHAT olarak ayarlayın. Space.displayName özelliğini ayarlamayın.

İnsanlar arasında 1:1 sohbet oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm değerini ise false olarak ayarlayın. Space.displayName veya Space.spaceDetails özelliğini ayarlamayın.

Gerçek kişi ile arayan Chat uygulaması arasında 1:1 görüşme oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm uygulamasını ise true olarak ayarlayın. Space.displayName veya Space.spaceDetails özelliğini ayarlamayın.

Halihazırda DIRECT_MESSAGE alanı varsa yeni alan oluşturulması yerine bu alan döndürülür.

request_id

string

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

memberships[]

Membership

İsteğe bağlı. Alana katılmak üzere davet edilecek Google Chat kullanıcıları veya grupları. Arayan kullanıcıyı otomatik olarak eklendiği için dahil etmeyin.

Grup şu anda arayana ek olarak 20 üyeye izin vermektedir.

Gerçek kişi üyeliği için Membership.member alanı, name alanının doldurulduğu bir user içermelidir (biçim: users/{user}) ve type, User.Type.HUMAN olarak ayarlanmış olmalıdır. Yalnızca alan oluştururken gerçek kullanıcı ekleyebilirsiniz (Chat uygulamalarının eklenmesi yalnızca görüşme uygulamasında doğrudan mesaj kurulumu için desteklenir). Üyeleri, kullanıcının e-posta adresini {user} için takma ad olarak kullanarak da 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 {user} için kullanıcının e-posta adresi kullanılmalıdır.

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

Space.spaceType, SPACE olarak ayarlanırken isteğe bağlıdır.

Space.spaceType, en az iki üyelikle birlikte GROUP_CHAT olarak ayarlanır.

Space.spaceType, tam olarak bir üyelikle birlikte gerçek bir kullanıcıyla DIRECT_MESSAGE olarak ayarlanır.

Gerçek kişi ile arayan Chat uygulaması arasında 1:1 görüşme oluştururken (Space.spaceType değeri DIRECT_MESSAGE, Space.singleUserBotDm değeri ise true olarak ayarlanır) boş olmalıdır.

SlashCommand

Google Chat'te eğik çizgi komutu.

Alanlar
command_id

int64

Çağrılan 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 bir iletişim kutusu için olup olmadığını belirtir.

Tür

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

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

Alanın kaynak adı.

Biçim: spaces/{space}

type
(deprecated)

Type

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

space_type

SpaceType

Alanın türü. Alan oluştururken veya alanın alan türünü güncellerken gereklidir. Yalnızca diğer kullanımlar için çıkış yap.

single_user_bot_dm

bool

İsteğe bağlı. Alanın bir Chat uygulaması ile tek bir insan arasında bir DM olup olmadığı.

threaded
(deprecated)

bool

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceThreadingState kullanın. Mesajların bu alanda mesaj dizisi olup olmadığı.

display_name

string

Alanın görünen adı. Alan oluştururken gereklidir. Alan oluştururken veya displayName öğesini güncellerken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki mevcut bir alanda bu görünen ad kullanılıyor olabilir.

Doğrudan mesajlar için bu alan boş olabilir.

En fazla 128 karakter desteklenir.

external_user_allowed

bool

Sabit. Bu alanın herhangi bir Google Chat kullanıcısına üye olarak izin verip vermediği. Google Workspace kuruluşunda alan oluştururken giriş Aşağıdaki koşullarda alan oluştururken bu alanı atlayın:

  • Kimliği doğrulanan kullanıcı bir tüketici hesabı (yönetilmeyen kullanıcı hesabı) kullanıyor. Varsayılan olarak, tüketici hesabı tarafından oluşturulan bir alanda tüm Google Chat kullanıcılarına izin verilir.

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

space_threading_state

SpaceThreadingState

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

space_details

SpaceDetails

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

space_history_state

HistoryState

Bu alandaki mesaj ve mesaj dizilerinin mesaj geçmişi durumu.

import_mode

bool

İsteğe bağlı. Bu alanın Google Workspace'e veri taşıma işlemi kapsamında Import Mode konumunda oluşturulup oluşturulmadığı. Alanlar içe aktarılırken, içe aktarma işlemi tamamlanana kadar bu alanlar kullanıcılara gösterilmez.

create_time

Timestamp

İsteğe bağlı. Sabit. Chat'te oluşturulan alanlar için alanın oluşturulduğu zaman. Bu alan, içe aktarma modundaki alanlarda kullanılmadığı durumlar dışında yalnızca çıkış olarak oluşturulur.

İçe aktarma modundaki alanlarda, orijinal oluşturma zamanını korumak için bu alanı, alanın kaynakta oluşturulduğu geçmiş zaman damgasına ayarlayın.

Çıkış yalnızca spaceType, GROUP_CHAT veya SPACE olduğunda doldurulur.

last_active_time

Timestamp

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

admin_installed

bool

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

Yönetici tarafından yükleme özelliğinin desteklenmesi 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ış birleştirilen üyeliklerin sayısı. space_type SPACE, DIRECT_MESSAGE veya GROUP_CHAT olduğunda doldurulur.

access_settings

AccessSettings

İsteğe bağlı. Alanın 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şmesini sağlayacak URI.

Birleştirme alanı space_permission_settings. Bir alanın izin ayarlarını temsil eder. Yalnızca space_type, SPACE olduğunda doldurulur. space_permission_settings şunlardan yalnızca biri olabilir:
predefined_permission_settings

PredefinedPermissionSettings

İsteğe bağlı. Yalnızca giriş. Alan izni ayarları. Alan oluşturma girişi. Bu alan ayarlanmazsa ortak çalışma alanı oluşturulur. Alanı oluşturduktan sonra ayarlar PermissionSettings alanında doldurulur.

permission_settings

PermissionSettings

İsteğe bağlı. Alanı güncellemek için ayarlanabilecek tam izin ayarları. Bir alanı güncellemek için giriş. Aksi takdirde yalnızca çıkış kullanılır. Alan oluşturmak için bunun yerine predefined_permission_settings kullanın.

AccessSettings

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

Alanlar
access_state

AccessState

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

audience

string

İsteğe bağlı. Alanı keşfedebilecek, alana katılabilecek ve alandaki mesajları önizleyebilecek hedef kitlenin kaynak adı. Politika ayarlanmadan bırakılırsa yalnızca alana ayrı ayrı davet edilmiş veya alana eklenmiş 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şunun varsayılan hedef kitlesini kullanmak için ayarı audiences/default olarak ayarlayın.

AccessState

Alanın 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 ayrı ayrı eklenen ya da davet edilen kullanıcılar veya Google Grupları alanı keşfedebilir ve erişebilir.
DISCOVERABLE Bir alan yöneticisi, bir hedef kitleye alan için erişim izni verdi. Alana ayrıca eklenen veya davet edilen kullanıcılar ya da Google Grupları da alanı keşfedebilir ve erişebilir. Daha fazla bilgi edinmek için Bir alanı belirli kullanıcılar tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin.

MembershipCount

Bir alanın üyelik sayısını kategoriler halinde gruplanmış şekilde gösterir.

Alanlar
joined_direct_human_user_count

int32

Alana doğrudan katılan gerçek kullanıcıların sayısı (birleştirilmiş bir gruba üye olarak katılan kullanıcılar hariç).

joined_group_count

int32

Alana doğrudan katılan tüm grupların sayısı.

PermissionSetting

Alan izni ayarını temsil eder.

Alanlar
managers_allowed

bool

Alan yöneticilerinin bu izne sahip olup olmadığı.

members_allowed

bool

Yönetici olmayan üyelerin bu izne sahip olup olmadığı.

PermissionSettings

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

Alanlar
manage_members_and_groups

PermissionSetting

Alandaki üyeleri ve grupları yönetme ayarı.

modify_space_details

PermissionSetting

Alan adı, avatarı, açıklaması ve kurallarını güncelleme ayarı.

toggle_history

PermissionSetting

Alan geçmişini açma ve kapatma ayarı.

use_at_mention_all

PermissionSetting

Alanda @tümü kullanma ayarı.

manage_apps

PermissionSetting

Bir alandaki uygulamaları yönetme ayarı.

manage_webhooks

PermissionSetting

Alandaki webhook'ları yönetme ayarı.

post_messages

PermissionSetting

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

reply_messages

PermissionSetting

Alandaki mesajları yanıtlama ayarı.

PredefinedPermissionSettings

Adlandırılmış alan oluştururken belirtebileceğiniz alan izni ayarları. Gelecekte daha fazla ayar eklenebilir. Adlandırılmış alanların izin ayarlarıyla ilgili ayrıntılar için Alanlar hakkında bilgi 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 ortak çalışma alanı haline getirme ayarı.
ANNOUNCEMENT_SPACE Alanı, yalnızca alan yöneticilerinin mesaj yayınlayabileceği bir duyuru alanı haline getirmek için yapılan ayar.

SpaceDetails

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

Alanlar
description

string

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

En fazla 150 karakteri destekler.

guidelines

string

İsteğe bağlı. Alanın kuralları, beklentileri ve görgü kuralları.

5.000 karaktere kadar destekler.

SpaceThreadingState

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

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Ayrıldı.
THREADED_MESSAGES Mesaj dizilerini destekleyen adlandırılmış alanlar. Kullanıcılar bir iletiye yanıt verdiklerinde, ileti dizisi içinde yanıt verebilirler. Böylece, yanıtları orijinal iletinin bağlamında tutulur.
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ın türü. Alan oluştururken veya güncellerken gereklidir. Yalnızca diğer kullanımlar için çıkış yap.

Sıralamalar
SPACE_TYPE_UNSPECIFIED Ayrıldı.
SPACE Kullanıcıların ileti gönderdiği, dosya paylaştığı ve ortak çalışma yaptığı bir yer. SPACE, Chat uygulamaları içerebilir.
GROUP_CHAT 3 veya daha fazla kişi arasındaki grup görüşmeleri. GROUP_CHAT, Chat uygulamaları 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 kullanın.

Sıralamalar
TYPE_UNSPECIFIED Ayrıldı.
ROOM İki veya daha fazla insan arasındaki sohbetler.
DM İnsan ile Chat uygulaması arasında 1:1 doğrudan mesaj (tüm mesajların düz olduğu) Bunun, iki kişi arasındaki doğrudan mesajları içermediğini unutmayın.

SpaceBatchUpdatedEventData

Bir alana yapılan 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

Bir Google Chat alanındaki 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, etkinlik türünün kısa bir süre içinde birden fazla örneğini temsil eden bir toplu sürümü vardır. spaceEvents.list() istekleri için sorgu filtrenizde toplu etkinlik türlerini atlayın. Varsayılan olarak sunucu 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
  • Mesaj güncellendi: 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 çok güncellenmiş mesaj: google.workspace.chat.message.v1.batchUpdated
  • Birden çok silinen mesaj: google.workspace.chat.message.v1.batchDeleted

Üyelikler için desteklenen etkinlik türleri:

  • Yeni üyelik: google.workspace.chat.membership.v1.created
  • Üyelik güncellendi: google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted üyeliği silindi
  • Birden çok yeni üyelik: google.workspace.chat.membership.v1.batchCreated
  • Birden çok güncellenen üyelik: google.workspace.chat.membership.v1.batchUpdated
  • Birden çok silinen üyelik: google.workspace.chat.membership.v1.batchDeleted

Tepkiler için desteklenen etkinlik türleri:

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

Alan hakkında 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 şunlardan yalnızca biri olabilir:

message_created_event_data

MessageCreatedEventData

Yeni mesajın etkinlik yükü.

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

message_updated_event_data

MessageUpdatedEventData

Güncellenen mesajın etkinlik yükü.

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

message_deleted_event_data

MessageDeletedEventData

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

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

message_batch_created_event_data

MessageBatchCreatedEventData

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

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

message_batch_updated_event_data

MessageBatchUpdatedEventData

Birden fazla güncellenen mesajın etkinlik yükü.

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

message_batch_deleted_event_data

MessageBatchDeletedEventData

Silinen birden fazla mesaj 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 alana yapılan birden fazla güncelleme için etkinlik yükü.

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

membership_created_event_data

MembershipCreatedEventData

Yeni bir üyeliğin etkinlik yükü.

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

membership_updated_event_data

MembershipUpdatedEventData

Güncellenmiş bir üyeliğin etkinlik yükü.

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

membership_deleted_event_data

MembershipDeletedEventData

Silinen bir üyeliğin etkinlik yükü.

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

membership_batch_created_event_data

MembershipBatchCreatedEventData

Birden fazla yeni üyeliğin etkinlik yükü.

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

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Birden fazla güncellenen üyeliğin etkinlik yükü.

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

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Silinen birden fazla üyeliğin etkinlik yükü.

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

reaction_created_event_data

ReactionCreatedEventData

Yeni bir tepkinin 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 tepkinin etkinlik yükü.

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

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Silinen birden fazla tepkinin etkinlik yükü.

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

SpaceReadState

Kullanıcının bir alandaki okuma durumu. Okunmuş ve okunmamış mesajları tanımlamak için kullanılır.

Alanlar
name

string

Alanın okuma durumunun kaynak adı.

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

last_read_time

Timestamp

İsteğe bağlı. Kullanıcının alan okuma durumunun güncellendiği zaman. Genellikle bu, son okunan mesajın zaman damgasına veya bir alandaki son okunma konumunu işaretlemek için kullanıcı tarafından belirtilen bir zaman damgasına karşılık gelir.

SpaceUpdatedEventData

Güncellenen alanın etkinlik yükü.

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

Alanlar
space

Space

Güncellenen alan.

İleti dizisi

Google Chat alanındaki mesaj dizisi. Kullanım örnekleri için İleti dizisi başlatma veya yanıtlama başlıklı makaleye bakın.

İleti oluştururken bir ileti dizisi belirtirseniz messageReplyOption alanını, eşleşen bir ileti dizisi bulunamadığında ne olacağını belirlemek için ayarlayabilirsiniz.

Alanlar
name

string

İleti dizisinin kaynak adı.

Örnek: spaces/{space}/threads/{thread}

thread_key

string

İsteğe bağlı. İleti dizisi oluşturma veya güncelleme girişi. Aksi takdirde yalnızca çıkış kullanılır. İleti dizisinin kimliği. 4.000 karaktere kadar destekler.

Bu kimlik, onu ayarlayan Chat uygulamasına özgüdür. Örneğin, birden fazla Chat uygulaması aynı mesaj dizisi anahtarını kullanarak mesaj oluşturursa mesajlar farklı mesaj dizilerinde yayınlanır. Bir kullanıcı veya başka bir Chat uygulaması tarafından oluşturulan bir mesaj dizisinde yanıt vermek için bunun yerine mesaj dizisi name alanını belirtin.

ThreadReadState

Kullanıcının okunmuş ve okunmamış iletileri tanımlamak için kullanılan ileti dizisindeki okuma durumu.

Alanlar
name

string

İleti dizisi okuma 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. Genellikle bu, bir ileti dizisindeki son okunan iletinin zaman damgasına karşılık gelir.

UpdateMembershipRequest

Üyeliğin güncellenmesiyle ilgili mesaj isteyin.

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 * kullanın.

Şu anda desteklenen alan yolları:

  • role
use_admin_access

bool

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

Görüşmeyi yapan 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ı gerekir.

UpdateMessageRequest

Mesaj güncelleme isteğinde bulunun.

Alanlar
message

Message

Zorunlu. Alan içeren mesaj güncellendi.

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 * kullanın.

Şu anda desteklenen alan yolları:

allow_missing

bool

İsteğe bağlı. true tarafından gönderilen mesaj bulunmazsa yeni bir mesaj 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.

UpdateSpaceReadStateRequest

UpdateSpaceReadState API için istek mesajı.

Alanlar
space_read_state

SpaceReadState

Zorunlu. Alanın okuma durumu ve güncellenecek alanlar.

Yalnızca çağrı yapan kullanıcının okuma durumunun güncellenmesini destekler.

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

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

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

  • İlgili 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ın oluşturulma zamanından önce olduğunda alan kullanıcı arayüzünde okunmamış olarak görünür.

Alanı okundu olarak işaretlemek için last_read_time öğesini, en son mesajın oluşturulma zamanından daha sonraki bir değere (daha büyük) ayarlayın. last_read_time, en son mesaj oluşturma zamanıyla eşleşmeye zorlandı. Alan okuma durumunun yalnızca alanın üst düzey görüşmesinde görünen mesajların okunma durumunu etkilediğini unutmayın. İleti dizilerindeki yanıtlar bu zaman damgasından etkilenmez. Bunun yerine, ileti dizisi okuma durumuna dayanır.

UpdateSpaceRequest

Tek bir alanı güncelleme isteği.

Alanlar
space

Space

Zorunlu. Güncellenecek alanlar içeren alan. Space.name, spaces/{space} biçiminde doldurulmalıdır. Yalnızca update_mask tarafından belirtilen alanlar güncellenir.

update_mask

FieldMask

Zorunlu. Birden fazla varsa virgülle ayrılmış olarak güncellenen alan yolları.

Bir alan için aşağıdaki alanları güncelleyebilirsiniz:

  • space_details

  • display_name: Yalnızca spaceType alanının SPACE olduğu alanlarda görünen adın güncellenmesini destekler. ALREADY_EXISTS hata mesajını alıyorsanız farklı bir değer deneyin. Google Workspace kuruluşundaki mevcut bir alanda bu görünen ad kullanılıyor olabilir.

  • space_type: Yalnızca GROUP_CHAT alan türünün SPACE olarak değiştirilmesini destekler. display_name öğesini güncelleme maskesine space_type ile birlikte ekleyin ve belirtilen alanda görünen adın boş olmadığından ve alan türünün SPACE olduğundan emin olun. Mevcut alan zaten SPACE türüne sahipse görünen ad güncellenirken belirtilen alana space_type maskesinin ve SPACE türünün dahil edilmesi isteğe bağlıdır. Alan türünü başka yollarla güncellemeye çalıştığınızda geçersiz bağımsız değişken hatası oluştu. space_type, yönetici erişimiyle desteklenmiyor.

  • space_history_state: Alan için geçmişi etkinleştirerek veya devre dışı bırakarak alan geçmişi ayarlarını günceller. Yalnızca Google Workspace kuruluşu için geçmiş ayarları etkinse desteklenir. Alan geçmişi durumunu güncellemek için isteğinizde diğer tüm alan maskelerini atlamanız gerekir. space_history_state, yönetici erişimiyle desteklenmiyor.

  • access_settings.audience: Alanı kimlerin keşfedebileceğini, alana katılabileceğini ve spaceType alanının SPACE olduğu adlandırılmış alanda mesajları önizleyebilecek kullanıcıların erişim ayarını günceller. Mevcut alanın hedef kitlesi varsa bu alan maskesine bir değer atlayarak kitleyi kaldırabilir ve alan erişimini kısıtlayabilirsiniz. Bir alanın erişim ayarlarını güncellemek için, kimlik doğrulamasını yapan kullanıcının alan yöneticisi olması ve isteğinizdeki diğer tüm alan maskelerini kullanmaması gerekir. Alan içe aktarma modunda ise bu alanı güncelleyemezsiniz. Daha fazla bilgi edinmek için Bir alanı belirli kullanıcılar tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin. access_settings.audience, yönetici erişimiyle desteklenmiyor.

  • Geliştirici Önizlemesi: Bir alanın izin ayarlarının değiştirilmesini destekler. Desteklenen alan yolları şunları içerir: permission_settings.manage_members_and_groups, permission_settings.modify_space_details, permission_settings.toggle_history, permission_settings.use_at_mention_all, permission_settings.manage_apps, permission_settings.manage_webhooks, permission_settings.reply_messages (Uyarı: diğer tüm izin olmayan ayarlar alan yollarıyla birlikte hariç). permission_settings, yönetici erişimiyle desteklenmiyor.

use_admin_access

bool

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

Görüşmeyi yapan 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ı gerekir.

Bazı FieldMask değerleri, yönetici erişimi kullanılırken desteklenmez. Ayrıntılar için update_mask açıklamasına bakın.

Kullanıcı

Google Chat'teki bir kullanıcı. İsteğin çıkışı olarak döndürüldüğünde, Chat uygulamanız kullanıcı olarak kimlik doğrulaması yaparsa User kaynağının çıkışı, kullanıcının yalnızca name ve type değerlerini doldurur.

Alanlar
name

string

Google Chat user 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ğıdakilerle aynı kullanıcı tanımlayıcısıdır:

  • People API'deki Person için id. Örneğin, Chat API'deki users/123456789, People API'deki 123456789 kişi profili kimliğiyle aynı kişiyi temsil eder.

  • Admin SDK Directory API'deki bir kullanıcı için id.

  • kullanıcının e-posta adresi, API isteklerinde {user} için takma ad olarak kullanılabilir. Örneğin, user@example.com için People API Kişi profil kimliği 123456789 ise users/123456789 referansı için users/user@example.com adresini takma ad olarak kullanabilirsiniz. API'den yalnızca standart 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ülemez.

Tür

Sıralamalar
TYPE_UNSPECIFIED Sıralama için varsayılan değer. KULLANMAYIN.
HUMAN İnsan kullanıcı.
BOT Chat uygulaması kullanıcısı.

UserMentionMetadata

Kullanıcı bahisleri için ek açıklama meta verileri (@).

Alanlar
user

User

Bahsedilen kullanıcı.

type

Type

Kullanıcının bahsettiği türü.

Tür

Sıralamalar
TYPE_UNSPECIFIED Sıralama için varsayılan değer. Kullanmayın.
ADD Kullanıcıyı alana ekleyin.
MENTION Alanda kullanıcıdan bahsedin.

WidgetMarkup

Widget, metin ve resimleri 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. WidgetMarkup, aşağıdaki öğelerden yalnızca birine sahip olabilir. Daha fazla öğe görüntülemek için birden fazla WidgetMarkup alanı kullanabilirsiniz. data şunlardan yalnızca biri olabilir:
text_paragraph

TextParagraph

Bu widget'ta bir metin paragrafı gösterir.

image

Image

Bu widget'ta bir resim gösterin.

key_value

KeyValue

Bu widget'ta bir anahtar/değer öğesi görüntüleyin.

Düğme

Bir düğme. Bir metin düğmesi veya resim düğmesi olabilir.

Alanlar

Birleştirme alanı type.

type şunlardan yalnızca biri olabilir:

text_button

TextButton

Metin ve onclick işlemi içeren bir düğme.

image_button

ImageButton

Bir resim ve onclick işlemi içeren bir düğme.

FormAction

Form işlemi, form gönderilirken gerçekleştirilen 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 tanımlamak için kullanılır. Bu bilgiler, kart tıklama etkinliğinin bir parçası olarak Chat uygulamasına yansıtılır. Yaygın bir davranışı tetikleyen çeşitli öğeler 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, şu üç erteleme düğmesini kullanabilirsiniz: şimdi ertele, bir gün ertele, sonraki hafta ertele. Dize parametreleri listesinde erteleme türünü ve erteleme süresini iletmek için action method = snooze() kullanabilirsiniz.

Alanlar
key

string

İşlem komut dosyası parametresinin adı.

value

string

Parametrenin değeri.

Simge

Desteklenen simge grubu.

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

URL ile belirtilen ve onclick işlemi içerebilen bir 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. Resmin yerleşik en boy oranını geçersiz kılmak amaçlanmamıştır. Politika ayarlanmazsa sunucu, resmi önceden getirerek resmi doldurur.

ImageButton

onclick işlemi içeren resim düğmesi.

Alanlar
on_click

OnClick

onclick işlemi.

name

string

Erişilebilirlik için kullanılan bu image_button cihazın adı. Bu ad belirtilmezse varsayılan değer sağlanır.

Birleştirme alanı icons. Simge, bir Icon enum veya URL ile belirtilebilir. icons şunlardan yalnızca biri olabilir:
icon

Icon

Chat API tarafından sağlanan bir simgeyi ifade eden enum ile belirtilen simge.

icon_url

string

URL ile belirtilen simge.

KeyValue

Bir kullanıcı arayüzü öğesi, bir 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 destekleniyor. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metni 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 zorunludur. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metni biçimlendirme ve Google Workspace Eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

content_multiline

bool

İçeriğin çok satırlı olup olmaması gerektiği.

bottom_label

string

Alt etiketin metni. Biçimlendirilmiş metin destekleniyor. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metni 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 şunlardan yalnızca biri olabilir:
icon

Icon

Chat API tarafından, karşılık gelen simge resmiyle değiştirilen bir sıralama değeri.

icon_url

string

URL ile belirtilen simge.

Birleştirme alanı control. Bir kontrol widget'ı. button ve switch_widget ayarlarını yapabilirsiniz ancak ikisini birden yapamazsınız. control şunlardan yalnızca biri olabilir:
button

Button

İşlemi tetiklemek için tıklanabilen bir düğme.

OnClick

onclick işlemi (örneğin, bir bağlantıyı açma).

Alanlar

Birleştirme alanı data.

data şunlardan yalnızca biri olabilir:

action

FormAction

Belirtilirse bu onclick işlemi tarafından 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 paragraflık metin. Biçimlendirilmiş metin destekleniyor. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metni biçimlendirme ve Google Workspace Eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

Alanlar
text

string