Package google.chat.v1

Dizin

ChatService

Geliştiricilerin Google Chat Platform'da Chat uygulamaları ve entegrasyonları oluşturmasını sağlar.

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 yetkilendirme 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ılavuzuna bakın.

CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Özel emoji oluşturur.

Kullanıcı kimlik doğrulaması gerektirir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Arama yapan Chat uygulaması, kullanıcı veya Google grubu için üyelik oluşturur. Diğer Chat uygulamaları için üyelik oluşturma desteklenmez. Üyelik oluştururken, belirtilen üyenin otomatik kabul politikası devre dışıysa davet edilen üyenin katılmadan önce alan davetini kabul etmesi gerekir. Aksi takdirde, üyelik oluşturarak üyeyi doğrudan belirtilen alana ekleyebilirsiniz.

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

Örnek kullanım için şu makaleye bakın:

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Google Chat alanında mesaj oluşturur. Örnek için Mesaj gönderme bölümüne bakın.

create() yöntemi için kullanıcı kimlik doğrulaması veya uygulama kimlik doğrulaması gerekir. Chat, isteğinizde kullandığınız kimlik doğrulama türüne bağlı olarak mesaj gönderenini farklı şekilde ilişkilendirir.

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

Uygulama kimlik doğrulamasıyla gönderilen mesaj

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

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

İleti içeriği dahil maksimum ileti boyutu 32.000 bayttır.

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ılavuzuna bakın.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Tepki oluşturur ve mesaja ekler. Yalnızca Unicode emojileri desteklenir. Örnek için Mesajlara tepki ekleme başlıklı makaleyi inceleyin.

Kullanıcı kimlik doğrulaması gerektirir.

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ılavuzuna bakın.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

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

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

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

Alanın oluşturulduğu Import mode'ye bağlı olarak, alan üyeliği oluşturulurken aşağıdakiler geçerli olur:

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

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Özel emojileri siler.

Kullanıcı kimlik doğrulaması gerektirir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Bir mesajı siler. Örnek için Mesaj silme bölümüne bakın.

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

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Bir mesaja verilen tepkiyi siler. Yalnızca Unicode emojileri desteklenir. Örnek için Tepkileri silme başlıklı makaleyi inceleyin.

Kullanıcı kimlik doğrulaması gerektirir.

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ılavuzuna bakın.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Adlandırılmış bir alanı siler. Her zaman basamaklı silme işlemi gerçekleştirir. Bu, alanda yayınlanan mesajlar ve alandaki üyelikler gibi alanın alt kaynaklarının da silindiği anlamına gelir. Örnek için Alan silme bölümüne bakın.

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Belirtilen kullanıcıyla mevcut doğrudan mesajı döndürür. Doğrudan mesaj alanı bulunamazsa 404 NOT_FOUND hatası döndürülür. Örnek için Doğrudan mesaj bulma bölümüne bakın.

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ı ile, belirtilen kullanıcı ile kimliği doğrulanmış kullanıcı arasındaki doğrudan mesaj alanını döndürür.

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Bir ileti ekinin meta verilerini alır. Ek verileri media API kullanılarak getirilir. Örnek için Mesaj eki hakkında meta veri alma başlıklı makaleyi inceleyin. Uygulama kimlik doğrulaması gerektirir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Özel emojilerle ilgili ayrıntıları döndürür.

Kullanıcı kimlik doğrulaması gerektirir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

Yetkilendirme kapsamları

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

  • https://www.googleapis.com/auth/chat.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ılavuzuna bakın.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

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

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

Not: Engellenen bir üyeden veya alandan gelen bir mesaj döndürülebilir.

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ılavuzuna bakın.

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

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

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

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

Kullanıcı kimlik doğrulaması gerektirir. Kimliği doğrulanmış kullanıcının etkinlik alabilmesi için 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ılavuzuna bakın.

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Alan bildirim durumu ayarlarını alır.

Kullanıcı kimlik doğrulaması gerektirir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Okunmuş ve okunmamış iletileri tanımlamak için kullanılan, kullanıcının alandaki okuma durumuyla ilgili ayrıntıları döndürür. Örnek için Kullanıcıların alan okuma durumuyla ilgili ayrıntıları alma başlıklı makaleyi inceleyin.

Kullanıcı kimlik doğrulaması gerektirir.

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ılavuzuna bakın.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Okunmuş ve okunmamış iletileri tanımlamak için kullanılan, kullanıcının bir ileti dizisindeki okuma durumuyla ilgili ayrıntıları döndürür. Örnek için Kullanıcı mesaj dizisinin okunma durumuyla ilgili ayrıntıları alma başlıklı makaleyi inceleyin.

Kullanıcı kimlik doğrulaması gerektirir.

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ılavuzuna bakın.

ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Kimliği doğrulanmış kullanıcı tarafından görülebilen özel emojileri listeler.

Kullanıcı kimlik doğrulaması gerektirir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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ıyla üyelikleri listelemek, 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 üyelikleri listelemek, kimliği doğrulanmış kullanıcının erişebildiği alanlarda üyelikleri listeler.

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

Yetkilendirme kapsamları

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

  • https://www.googleapis.com/auth/chat.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ılavuzuna bakın.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Arayanın üyesi olduğu bir alandaki mesajları (engellenen üyelerden ve alanlardan gelen mesajlar dahil) listeler. Mesaj içermeyen bir alandaki mesajları listelerseniz yanıt boş bir nesne olur. REST/HTTP arayüzü kullanıldığında yanıt, {} adlı boş bir JSON nesnesi içerir. Örnek için Mesajları listeleme bölümüne bakın.

Kullanıcı kimlik doğrulaması gerektirir.

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ılavuzuna bakın.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Bir mesaja verilen tepkileri listeler. Örnek için Bir mesaja verilen tepkileri listeleme bölümüne bakın.

Kullanıcı kimlik doğrulaması gerektirir.

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ılavuzuna bakın.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

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

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Arayanın üyesi olduğu alanları listeler. Grup sohbetleri ve DM'ler, ilk mesaj gönderilene kadar listelenmez. Örnek için Alanları listeleme bölümüne bakın.

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

Tüm adlandırılmış alanları Google Workspace kuruluşuna göre 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ılavuzuna bakın.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Yöneticinin yaptığı aramaya göre Google Workspace kuruluşundaki alanların listesini döndürür.

Yönetici ayrıcalıklarına sahip kullanıcı kimlik doğrulaması gerektirir. İstekte use_admin_access değerini true olarak ayarlayın.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

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

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

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

Arayan kullanıcı ile başka bir gerçek kullanıcı arasında doğrudan mesaj (DM) oluşturmak için gerçek kullanıcıyı temsil 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 arayan uygulama arasında DM oluşturmak için Space.singleUserBotDm değerini true olarak ayarlayın ve herhangi bir üyelik belirtmeyin. Bu yöntemi yalnızca arama uygulamasıyla DM oluşturmak için kullanabilirsiniz. Arama uygulamasını bir alanın üyesi veya iki gerçek kullanıcı arasındaki mevcut bir DM'ye eklemek için Bir alana kullanıcı veya uygulama davet etme veya ekleme başlıklı makaleyi inceleyin.

İki kullanıcı arasında zaten bir DM varsa, istek gönderilirken bir kullanıcı diğerini engellese bile mevcut DM döndürülür.

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

Kullanıcı 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.create

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Bir mesajı günceller. patch ve update yöntemleri arasında fark vardır. patch yöntemi bir patch isteği, update yöntemi ise bir put isteği kullanır. patch yöntemini kullanmanızı öneririz. Örnek için Mesaj güncelleme bölümüne bakın.

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

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Alanları günceller. Örnek için Alan güncelleme bölümüne bakın.

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

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

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Alan bildirim durumu ayarlarını günceller.

Kullanıcı kimlik doğrulaması gerektirir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

Kullanıcı kimlik doğrulaması gerektirir.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

AccessoryWidget

Bir ileti dizisinin en altında görünen bir veya daha fazla etkileşimli widget. Ayrıntılar için Mesajın alt kısmına etkileşimli widget ekleme başlıklı makaleyi inceleyin.

Alanlar
Birlik alanı action. İşlemin türü. action yalnızca aşağıdakilerden 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 kimlik doğrulaması veya yapılandırma yapması için URL. (Yalnızca REQUEST_CONFIG yanıt türleri için.)

dialog_action

DialogAction

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

updated_widget

UpdatedWidget

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

ResponseType

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

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

SelectionItems

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

Alanlar
items[]

SelectionItem

SelectionItem nesneleri dizisi.

UpdatedWidget

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

Alanlar
widget

string

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

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

SelectionItems

Widget otomatik tamamlama sonuçlarının listesi

ActionStatus

Bir iletişim kutusunu çağırma veya gönderme isteğinin durumunu temsil eder.

Alanlar
status_code

Code

Durum kodu.

user_facing_message

string

Kullanıcılara isteklerinin durumu hakkında gönderilecek mesaj. Ayarlanmamışsa status_code değerine göre genel bir mesaj gönderilir.

Ek Açıklama

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

Düz metin ileti gövdesi örneği:

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çıklamanın karşılık geldiği düz metin ileti gövdesinde alt dizenin uzunluğu.

start_index

int32

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

Birlik alanı metadata. Ek açıklamayla ilgili ek meta veriler. metadata yalnızca aşağıdakilerden biri olabilir:
user_mention

UserMentionMetadata

Kullanıcının bahsedildiği meta veriler.

slash_command

SlashCommandMetadata

Eğik çizgi komutunun meta verileri.

AnnotationType

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

Sıralamalar
ANNOTATION_TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
USER_MENTION Bir kullanıcıdan 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'teki bir ek.

Alanlar
name

string

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

content_name

string

Yalnızca çıkış. Tam yol değil, içeriğin orijinal dosya adı.

content_type

string

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

thumbnail_uri

string

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

download_uri

string

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

source

Source

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

Birlik alanı data_ref. Ekteki verilere referans. data_ref yalnızca aşağıdakilerden biri olabilir:
attachment_data_ref

AttachmentDataRef

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

drive_data_ref

DriveDataRef

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

Kaynak

Ekin kaynağı.

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

AttachmentDataRef

Ek verilerine referans.

Alanlar
resource_name

string

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

attachment_upload_token

string

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

CardWithId

Google Chat mesajındaki bir kart.

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

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

Kart Oluşturucu'yu açma

Alanlar
card_id

string

Mesaj birden fazla kart içeriyorsa 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 mesaj dizisi.

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

message

string

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

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

CompleteImportSpaceRequest

Bir alanın içe aktarma işleminin tamamlanması için istek mesajı.

Alanlar
name

string

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

Biçim: spaces/{space}

CompleteImportSpaceResponse

Bir alanın içe aktarma işleminin tamamlanmasıyla ilgili yanıt mesajı.

Alanlar
space

Space

İçe aktarma modu alanı.

ContextualAddOnMarkup

Bu türde alan yoktur.

Geliştiricilerin bağlama dayalı bir eklentinin içeriğini belirtmek için kullandıkları 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ığı. Başlıklar genellikle bir başlık ve resim içerir.

sections[]

Section

Bölümler bir satır ayırıcıyla ayrılır.

card_actions[]

CardAction

Bu kartın işlemleri.

name

string

Kartın adı.

CardAction

Kart işlemi, kartla ilişkili işlemdir. Fatura kartında tipik işlemler şunlardır: faturayı silme, faturayı e-postayla gönderme veya faturayı tarayıcıda açma.

Google Chat uygulamaları tarafından desteklenmez.

Alanlar
action_label

string

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

on_click

OnClick

Bu işlem öğesinin tıklama işlemi.

CardHeader

Alanlar
title

string

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

subtitle

string

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

image_style

ImageStyle

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

image_url

string

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

ImageStyle

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

Bölüm

Bir bölüm, belirtildikleri sırada oluşturulan (dikey olarak) bir widget koleksiyonu içerir. Kartlar tüm platformlarda dar ve sabit bir genişliğe sahiptir. Bu nedenle, şu anda düzen özelliklerine (ör. yüzer) gerek yoktur.

Alanlar
header

string

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

widgets[]

WidgetMarkup

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

CreateCustomEmojiRequest

Özel emoji oluşturma isteği.

Alanlar
custom_emoji

CustomEmoji

Zorunlu. Oluşturulacak özel emoji.

CreateMembershipRequest

Üyelik oluşturma isteği mesajı.

Alanlar
parent

string

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

Biçim: spaces/{space}

membership

Membership

Zorunlu. Oluşturulacak üyelik ilişkisi.

memberType alanında, user.name ve user.type alanları doldurulmuş bir kullanıcı bulunmalıdır. Sunucu bir kaynak adı atar ve belirtilen her şeyin üzerine yazar.

Chat uygulaması, gerçek bir kullanıcı için üyelik ilişkisi oluştururken belirli yetkilendirme kapsamlarını kullanması ve belirli alanlar için belirli değerler ayarlamalıdır:

  • Kullanıcı olarak kimlik doğrulama yapılırken chat.memberships yetkilendirme kapsamı gereklidir.

  • Uygulama olarak kimlik doğrulama yapılırken chat.app.memberships yetkilendirme kapsamı gereklidir. Uygulama olarak kimlik doğrulama aşağıdaki platformlarda kullanılabilir:

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

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

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

use_admin_access

bool

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

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

chat.admin.memberships OAuth 2.0 kapsamını gerektirir.

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

CreateMessageRequest

Mesaj oluşturur.

Alanlar
parent

string

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

Biçim: spaces/{space}

message

Message

Zorunlu. İleti gövdesi.

thread_key
(deprecated)

string

İsteğe bağlı. Desteği sonlandırıldı: Bunun yerine thread.thread_key kullanın. İleti dizisinin kimliği. En fazla 4.000 karakter desteklenir. Mesaj dizisi başlatmak veya bir mesaj dizisine eklemek için bir mesaj oluşturun ve threadKey veya thread.name belirtin. Örnek kullanım için Mesaj dizisi başlatma veya yanıtlama başlıklı makaleyi inceleyin.

request_id

string

İsteğe bağlı. Bu mesaj için benzersiz bir istek kimliği. Mevcut bir istek kimliği belirtmek, 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 başlatıp başlatmadığını veya bir mesaj dizisini yanıtlayıp yanıtlamadığını belirtir. Yalnızca adlandırılmış alanlarda desteklenir.

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

message_id

string

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

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

  • client- ile başlar. Örneğin, client-custom-name geçerli bir özel kimliktir ancak custom-name geçerli değildir.
  • En fazla 63 karakterden oluşmalı ve yalnızca küçük harf, rakam ve kısa çizgi içermelidir.
  • Alan içinde benzersiz olmalıdır. Sohbet uygulamaları, farklı mesajlar için aynı özel kimliği kullanamaz.

Ayrıntılar için Mesajlara ad verme başlıklı makaleyi inceleyin.

MessageReplyOption

Bir mesajın 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çenek kullanıldığında, dahil edilen tüm thread ID veya thread_key yoksayılır.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD İleti, thread ID veya thread_key ile belirtilen ileti dizisine yanıt olarak oluşturulur. Bu işlem başarısız olursa ileti yerine yeni bir ileti dizisi başlatılır.
REPLY_MESSAGE_OR_FAIL İleti, thread ID veya thread_key ile belirtilen ileti dizisine yanıt olarak oluşturulur. Yeni bir thread_key kullanılırsa yeni bir ileti dizisi oluşturulur. Mesaj oluşturma işlemi başarısız olursa 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. Oluşturulacak tepki.

CreateSpaceRequest

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

Alanlar
space

Space

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

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

name alanı sunucuda atandığından bu alanda belirtilen her şey yoksayılır.

request_id

string

İsteğe bağlı. Bu istek için benzersiz bir tanımlayıcı. Rastgele bir UUID kullanılması önerilir. Mevcut bir istek kimliği belirtmek, yeni bir alan oluşturmak yerine bu kimlikle oluşturulan alanı döndürür. Aynı Chat uygulamasında kimliği doğrulanmış farklı bir kullanıcının mevcut istek kimliğini belirtmek hata döndürür.

CustomEmoji

Özel emojiyi temsil eder.

Alanlar
name

string

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

Biçim: customEmojis/{customEmoji}

uid

string

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

emoji_name

string

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

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

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

Örnek: :valid-emoji-name:

temporary_image_uri

string

Yalnızca çıkış. Özel emojinin resim URL'si (en az 10 dakika boyunca geçerlidir). Özel emoji oluşturulduğunda bu alanın yanıtta doldurulmadığını unutmayın.

payload

CustomEmojiPayload

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

CustomEmojiPayload

Özel emojinin yük verileri.

Alanlar
file_content

bytes

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

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

filename

string

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

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

DeleteCustomEmojiRequest

Özel emojilerin silinmesi için talep.

Alanlar
name

string

Zorunlu. Silinecek özel emojinin kaynak adı.

Biçim: customEmojis/{customEmoji}

{customEmoji} için takma ad olarak emoji adını kullanabilirsiniz. Örneğin, customEmojis/:example-emoji: (:example-emoji:, özel emojinin adı olur).

DeleteMembershipRequest

Alandaki bir üyeliğin silinmesini isteme.

Alanlar
name

string

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

Gerçek kullanıcı üyeliklerini silerken chat.memberships kapsamı ve spaces/{space}/members/{member} biçimi gerekir. E-postayı {member} için takma ad olarak kullanabilirsiniz. Örneğin, spaces/{space}/members/example@gmail.com (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

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

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

chat.admin.memberships OAuth 2.0 kapsamını gerektirir.

Yönetici erişimi kullanılarak bir alandaki uygulama üyeliklerinin silinmesi desteklenmez.

DeleteMessageRequest

Mesaj silme isteği.

Alanlar
name

string

Zorunlu. Mesajın kaynak adı.

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

Mesajınız için özel bir kimlik belirlediyseniz {message} için clientAssignedMessageId alanındaki değeri kullanabilirsiniz. Ayrıntılar için Mesajlara ad verme başlıklı makaleyi inceleyin.

force

bool

İsteğe bağlı. true ise bir mesajın silinmesi, mesajın mesaj dizileriyle yanıtlarını da siler. false olduğunda, bir ileti dizisinde yanıt varsa silme işlemi başarısız olur.

Yalnızca kullanıcı olarak kimlik doğrulama işleminde geçerlidir. Chat uygulaması olarak kimlik doğrulaması yapılırken 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

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

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

chat.admin.delete OAuth 2.0 kapsamını gerektirir.

DeletionMetadata

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

Alanlar
deletion_type

DeletionType

Mesajı kimin sildiğini belirtir.

DeletionType

Mesajın kim tarafından ve nasıl silindiği. Gelecekte daha fazla değer eklenebilir.

Sıralamalar
DELETION_TYPE_UNSPECIFIED Bu değer kullanılmamaktadır.
CREATOR Kullanıcı kendi mesajını silmiştir.
SPACE_OWNER Alan sahibi mesajı sildi.
ADMIN Mesaj bir Google Workspace yöneticisi tarafından silindi.
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 silmiştir.
SPACE_OWNER_VIA_APP Mesaj, bir Chat uygulaması tarafından alan sahibi adına silindi.

Dialog

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

Alanlar
body

Card

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

DialogAction

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

Alanlar
action_status

ActionStatus

Yalnızca giriş. İletişim kutusu başlatma veya gönderme isteğinin durumu. Gerekirse kullanıcılara bir durum ve mesaj gösterir. Örneğin, hata veya başarı durumunda.

Birlik alanı action. Yapılacak işlem. action yalnızca aşağıdakilerden biri olabilir:
dialog

Dialog

Yalnızca giriş. İstek için iletişim kutusu.

DriveDataRef

Drive eki verilerine referans.

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

Mesaja tepki olarak kullanılan emoji.

Alanlar
Birlik alanı content. Zorunlu. Emojinin içeriği. content yalnızca aşağıdakilerden biri olabilir:
unicode

string

İsteğe bağlı. Unicode dizesi ile temsil edilen temel bir emoji.

custom_emoji

CustomEmoji

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

EmojiReactionSummary

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

Alanlar
emoji

Emoji

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

reaction_count

int32

Yalnızca çıkış. İlişkili emojinin kullanıldığı toplam tepki sayısı.

FindDirectMessageRequest

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

Alanlar
name

string

Zorunlu. Doğrudan mesajı bulunacak 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ğerini ifade eder. Örneğin, People API profil kimliği 123456789 ise name olarak users/123456789 değerini kullanarak bu kişiyle doğrudan mesajı bulabilirsiniz. Kullanıcı olarak kimlik doğrulaması yaptığınızda e-postayı {user} için takma ad olarak kullanabilirsiniz. Örneğin, users/example@gmail.com (example@gmail.com, Google Chat kullanıcısının e-posta adresidir).

GetAttachmentRequest

Ek isteğinde bulunun.

Alanlar
name

string

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

GetCustomEmojiRequest

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

Alanlar
name

string

Zorunlu. Özel emojinin kaynak adı.

Biçim: customEmojis/{customEmoji}

{customEmoji} için takma ad olarak emoji adını kullanabilirsiniz. Örneğin, customEmojis/:example-emoji: (:example-emoji:, özel emojinin adı olur).

GetMembershipRequest

Alana üyelik isteğinde bulunma

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 kullanabilirsiniz.

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

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

use_admin_access

bool

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

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

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

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

GetMessageRequest

Mesaj isteğinde bulunun.

Alanlar
name

string

Zorunlu. Mesajın kaynak adı.

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

Mesajınız için özel bir kimlik belirlediyseniz {message} için clientAssignedMessageId alanındaki değeri kullanabilirsiniz. Ayrıntılar için Mesajlara ad verme başlıklı makaleyi inceleyin.

GetSpaceEventRequest

Alan etkinliği alma isteği mesajı.

Alanlar
name

string

Zorunlu. Alan etkinliğinin kaynak adı.

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

GetSpaceNotificationSettingRequest

Alan bildirimi ayarını almak için istek mesajı. Yalnızca arayan kullanıcının bildirim ayarını almayı destekler.

Alanlar
name

string

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

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

GetSpaceReadStateRequest

GetSpaceReadState API için istek mesajı.

Alanlar
name

string

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

Yalnızca arayan kullanıcının okuma durumunu alma işlemini destekler.

Arayan kullanıcıyı belirtmek için aşağıdakilerden birini ayarlayın:

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

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

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

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

GetSpaceRequest

Tek bir alanı iade etme isteği.

Alanlar
name

string

Zorunlu. Alanın kaynak adı (spaces/{space} biçiminde).

Biçim: spaces/{space}

use_admin_access

bool

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

Arayan kullanıcı, Chat ve Alanlar 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 ileti dizisinin okunma durumunun kaynak adı.

Yalnızca arayan kullanıcının okuma durumunu alma işlemini destekler.

Arayan kullanıcıyı belirtmek için aşağıdakilerden birini ayarlayın:

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

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

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

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

Grup

Google Chat'te bir Google grubu.

Alanlar
name

string

Bir Google grubu için kaynak adı.

Cloud Identity Groups API'de bir grubu temsil eder.

Format: groups/{group}

HistoryState

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

Sıralamalar
HISTORY_STATE_UNSPECIFIED Varsayılan değer. Kullanmayın.
HISTORY_OFF Geçmişe kayıt kapalı. Mesajlar ve ileti dizileri 24 saat boyunca 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.

ListCustomEmojisRequest

Özel emojilerin listesini döndürme isteği.

Alanlar
page_size

int32

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

page_token

string

İsteğe bağlı. (Önceki bir sorgudan devam ediliyorsa.)

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

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

filter

string

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

İçerik üreticiye göre filtrelemeyi destekler.

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

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

creator("users/me")

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

ListCustomEmojisResponse

Özel emoji listesine verilen bir yanıt.

Alanlar
custom_emojis[]

CustomEmoji

Sırasız liste. İstenen (veya ilk) sayfada bulunan özel emojilerin listesi.

next_page_token

string

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

ListMembershipsRequest

Üyelikleri listeleme isteği mesajı.

Alanlar
parent

string

Zorunlu. Üyelik listesinin alınacağı alanın kaynak adı.

Biçim: spaces/{space}

page_size

int32

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

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

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

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

page_token

string

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

Sayfalandırma yapılırken sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler göndermek 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ürü filtrelemek için member.type öğesini HUMAN veya BOT olarak ayarlayın. != operatörünü kullanarak member.type için de filtreleme yapabilirsiniz.

Hem role hem de türe göre filtrelemek için AND operatörünü kullanın. 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" gereklidir. 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"

Aşağıdaki sorgular geçersiz:

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

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

show_groups

bool

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

show_invited

bool

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

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

use_admin_access

bool

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

Arayan kullanıcı, Chat ve Alanlar 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ını gerektirir.

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

ListMembershipsResponse

Alanın üyeliklerini listeleyen yanıt.

Alanlar
memberships[]

Membership

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

next_page_token

string

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

ListMessagesRequest

Belirtilen alandaki ve kullanıcının üyesi olduğu mesajları listeler.

Alanlar
parent

string

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

Biçim: spaces/{space}

page_size

int32

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

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

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

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

page_token

string

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

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

filter

string

İsteğe bağlı. 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 öğesini RFC-3339 biçiminde bir zaman damgasıyla ve çift tırnak içinde belirtin. Örneğin, "2023-04-21T11:30:00-04:00". Bir zaman damgasından sonra oluşturulan iletileri listelemek için büyüktür operatörünü >, bir zaman damgasından önce oluşturulan iletileri listelemek için de küçüktür operatörünü < kullanabilirsiniz. Belirli bir zaman aralığındaki iletileri filtrelemek için iki zaman damgası arasına AND operatörünü ekleyin.

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

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

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

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

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

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

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

thread.name = spaces/AAAAAAAAAAA/threads/123

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

order_by

string

İsteğe bağlı. Mesaj listesinin sıralaması. Sıralama işlemine göre sıralama yapılacak bir değer belirtin. Geçerli sıralama işlemi değerleri şunlardır:

  • Artan için ASC.

  • Azalan düzen için DESC.

Varsayılan sıralama create_time ASC'tür.

show_deleted

bool

İsteğe bağlı. Silinen iletilerin dahil edilip edilmeyeceği. Silinen iletilerde, iletilerin silinme zamanı ve silinmeyle ilgili meta veriler yer alır ancak ileti içeriği kullanılamaz.

ListMessagesResponse

Listeleme mesajları için yanıt mesajı.

Alanlar
messages[]

Message

Mesaj listesi.

next_page_token

string

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

ListReactionsRequest

Bir mesaja verilen tepkileri listeler.

Alanlar
parent

string

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

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

page_size

int32

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

page_token

string

İsteğe bağlı. (Önceki bir sorgudan devam ediliyorsa.)

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

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

filter

string

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

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

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

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

Sorgunuzda hem AND hem de OR kullanılıyorsa bunları 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}"

Aşağıdaki sorgular geçersiz:

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

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

ListReactionsResponse

Tepkileri listeleme isteğine verilen yanıt.

Alanlar
reactions[]

Reaction

İstenen (veya ilk) sayfadaki tepkilerin listesi.

next_page_token

string

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

ListSpaceEventsRequest

Alan etkinliklerini listeleme isteği 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 sonuç döndürebilir.

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

page_token

string

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

Sayfalandırma yaparken, 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 göndermek beklenmedik sonuçlara yol açabilir.

filter

string

Zorunlu. Sorgu filtresi.

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

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

  • start_time: Alan etkinliklerini listelemenin başlayacağı özel zaman damgası. 28 güne kadar önce gerçekleşen etkinlikleri listeleyebilirsiniz. Belirtilmemişse son 28 güne ait alan etkinliklerini listeler.
  • end_time: Alan etkinliklerinin listelendiği zaman damgası. Belirtilmemişse istek zamanına kadar olan etkinlikler listelenir.

Başlangıç veya bitiş saatini belirtmek için eşittir = operatörünü kullanın ve RFC-3339 biçimini uygulayın. Hem start_time hem de end_time'ye 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")

Aşağıdaki sorgular geçersiz:

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

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

ListSpaceEventsResponse

Alan etkinliklerini listelemeyle ilgili yanıt mesajı.

Alanlar
space_events[]

SpaceEvent

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

next_page_token

string

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

ListSpacesRequest

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

Alanlar
page_size

int32

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

Belirtilmemesi durumunda en fazla 100 alan döndürülür.

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

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

page_token

string

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

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

filter

string

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

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

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

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

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

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

ListSpacesResponse

Alanları listeleme isteğinin yanıtı.

Alanlar
spaces[]

Space

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

next_page_token

string

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

MatchedUrl

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

Alanlar
url

string

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

Üyelik

Google Chat'teki üyelik ilişkilerini (ör. bir kullanıcının veya Chat uygulamasının bir alana davet edilip edilmediği, alana dahil olup olmadığı ya da alandan ayrılıp ayrılmadığı) temsil eder.

Alanlar
name

string

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

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

state

MembershipState

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

role

MembershipRole

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

Bu alan yalnızca UpdateMembership alanında giriş olarak kullanılabilir.

create_time

Timestamp

İsteğe bağlı. Değişmez. Üyeliğin oluşturulduğu zaman (ör. üyenin alana katıldığı veya alana katılmaya davet edildiği zaman). Bu alan, yalnızca geçmiş üyelikleri içe aktarma modu alanlarından içe aktarmak için kullanıldığında çıkışa yöneliktir.

delete_time

Timestamp

İsteğe bağlı. Değişmez. Üyeliğin silinme zamanı (ör. üyenin alandan ayrıldığı veya alandan çıkarıldığı zaman). Bu alan, yalnızca geçmiş üyelikleri içe aktarma modu alanlarından içe aktarmak için kullanıldığında çıkışa yöneliktir.

Birlik alanı memberType. Bu üyelikle ilişkili üye. Gelecekte başka üye türleri de desteklenmeye başlayabilir. memberType yalnızca aşağıdakilerden biri olabilir:
member

User

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

group_member

Group

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

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

MembershipRole

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: Alanın üyesi değildir ancak davet edilebilir. Google Groups için: Bu role her zaman atanır (gelecekte başka enum değerleri kullanılabilir).
ROLE_MEMBER Alanın üyesi. Kullanıcı, alana mesaj gönderme gibi temel izinlere sahiptir. Bire bir görüşmelerde ve adsız grup görüşmelerinde herkes bu role sahiptir.
ROLE_MANAGER Alan yöneticisi Kullanıcı, tüm temel izinlere ve ayrıca alanı yönetmesine olanak tanıyan yönetici izinlerine (ör. üye ekleme veya kaldırma) sahiptir. Yalnızca SpaceType.SPACE sürümünde desteklenir.

MembershipState

Üyenin alanla ilişkisini belirtir. Gelecekte diğer üye ülkeler de desteklenmeye başlayabilir.

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 henüz katılmamıştır.
NOT_A_MEMBER Kullanıcı alana ait değilse ve alana katılmak için bekleyen davetiyesi yoksa

MembershipBatchCreatedEventData

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

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

Alanlar
memberships[]

MembershipCreatedEventData

Yeni üyeliklerin listesi.

MembershipBatchDeletedEventData

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

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

Alanlar
memberships[]

MembershipDeletedEventData

Silinen üyeliklerin listesi.

MembershipBatchUpdatedEventData

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

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

Alanlar
memberships[]

MembershipUpdatedEventData

Güncellenen üyeliklerin listesi.

MembershipCreatedEventData

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

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

Alanlar
membership

Membership

Yeni üyelik.

MembershipDeletedEventData

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

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

Alanlar
membership

Membership

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

MembershipUpdatedEventData

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

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

Alanlar
membership

Membership

Güncellenen üyelik.

Mesaj

Google Chat alanındaki bir mesaj.

Alanlar
name

string

Tanımlayıcı. Mesajın kaynak adı.

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

Burada {space}, mesajın yayınlandığı alanın kimliği, {message} ise mesaja 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 mesajı bir istekte belirtmek için bu kimliği kullanabilirsiniz. Örneğin, spaces/AAAAAAAAAAA/messages/client-custom-name. Ayrıntılar için Mesajlara ad verme başlıklı makaleyi inceleyin.

sender

User

Yalnızca çıkış. İletiyi oluşturan kullanıcı. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yaparsa çıkışta kullanıcı name ve type alanları doldurulur.

create_time

Timestamp

İsteğe bağlı. Değişmez. Chat'te oluşturulan alanlar için mesajın oluşturulduğu saat. Bu alan, içe aktarma modu alanlarında kullanıldığında hariç olmak üzere yalnızca çıkış içindir.

İçe aktarma modu alanları için bu alanı, orijinal oluşturulma zamanını korumak amacıyla ileti kaynağında oluşturulduğu tarihsel zaman damgasına ayarlayın.

last_update_time

Timestamp

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

delete_time

Timestamp

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

text

string

İsteğe bağlı. İletinin düz metin gövdesi. Bir resme, videoya veya web sayfasına ait ilk bağlantı, önizleme çipi oluşturur. Ayrıca bir Google Chat kullanıcısını@bahsetme veya alandaki herkesi etiketleyebilirsiniz.

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

formatted_text

string

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

  • Kalın, italik, üstü çizili, monospace, monospace blok ve madde işaretli liste için işaretleme söz dizimi.

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

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

  • :{emoji_name}: biçimini kullanan özel emoji (ör. :smile:). Bu durum, Unicode emojileri (ör. gülümseyen yüz emojisi için U+1F600) için geçerli değildir.

Daha fazla bilgi için İletiyle 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 ileti düz metin gövdesinin altında gösterilir. cards ve cards_v2 öğelerinin boyutu en fazla 32 KB olabilir.

cards_v2[]

CardWithId

İsteğe bağlı. Kart dizisi.

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

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

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

Kart Oluşturucu'yu açma

annotations[]

Annotation

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

thread

Thread

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

space

Space

Yalnızca çıkış. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yaparsa çıkış yalnızca alanı name doldurur.

fallback_text

string

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

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ış. Tüm Chat uygulamasından bahsetmelerin kaldırıldığı, mesajın düz metin gövdesi.

slash_command

SlashCommand

Yalnızca çıkış. Varsa eğik çizgi komutu bilgileri.

attachment[]

Attachment

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

matched_url

MatchedUrl

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

thread_reply

bool

Yalnızca çıkış. true olduğunda mesaj, bir yanıt mesaj dizisindeki yanıttır. false olduğunda mesaj, alanın üst düzey görüşmesinde bir mesaj dizisinin ilk mesajı veya mesaj dizisi yanıtı olmayan bir mesaj olarak görünür.

Alanda mesaj dizilerinde yanıt verme özelliği desteklenmiyorsa bu alan her zaman false olur.

client_assigned_message_id

string

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

emoji_reaction_summaries[]

EmojiReactionSummary

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

private_message_viewer

User

İsteğe bağlı. Değişmez. Mesaj oluşturmak için giriş, aksi takdirde yalnızca çıkış. Mesajın görüntüleyebileceği kullanıcı. Ayarlandığında mesaj gizlidir ve yalnızca belirtilen kullanıcı ve Chat uygulaması tarafından görülebilir. Bu alanı isteğinize dahil etmek için uygulama kimlik doğrulamasını kullanarak Chat API'yi çağırmanız ve aşağıdakileri atlamanız gerekir:

Ayrıntılı bilgi için Mesajları gizli olarak gönderme başlıklı makaleyi inceleyin.

deletion_metadata

DeletionMetadata

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

quoted_message_metadata

QuotedMessageMetadata

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

attached_gifs[]

AttachedGif

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

accessory_widgets[]

AccessoryWidget

İsteğe bağlı. Bir ileti dizisinin en altında görünen bir veya daha fazla etkileşimli widget. Metin, kart veya hem metin hem de kart içeren mesajlara aksesuar widget'ları ekleyebilirsiniz. İletişim kutuları içeren iletiler için desteklenmez. Ayrıntılar için Mesajın alt kısmına etkileşimli widget ekleme başlıklı makaleyi inceleyin.

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

MessageBatchCreatedEventData

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

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

Alanlar
messages[]

MessageCreatedEventData

Yeni mesajların listesi.

MessageBatchDeletedEventData

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

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

Alanlar
messages[]

MessageDeletedEventData

Silinen mesajların listesi.

MessageBatchUpdatedEventData

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

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

Alanlar
messages[]

MessageUpdatedEventData

Güncellenen mesajların listesi.

MessageCreatedEventData

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

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

Alanlar
message

Message

Yeni mesaj.

MessageDeletedEventData

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

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

Alanlar
message

Message

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

MessageUpdatedEventData

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

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

Alanlar
message

Message

Güncellenen mesaj.

QuotedMessageMetadata

Alıntılanan bir ileti hakkında bilgi.

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 en son güncellendiği zaman damgası.

Tepki

Mesaja verilen tepki.

Alanlar
name

string

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

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

user

User

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

emoji

Emoji

Zorunlu. Tepkide kullanılan emoji.

ReactionBatchCreatedEventData

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

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

Alanlar
reactions[]

ReactionCreatedEventData

Yeni tepkilerin listesi.

ReactionBatchDeletedEventData

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

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

Alanlar
reactions[]

ReactionDeletedEventData

Silinen tepkilerin listesi.

ReactionCreatedEventData

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

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

Alanlar
reaction

Reaction

Yeni tepki.

ReactionDeletedEventData

Silinmiş 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.

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

RichLinkType

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

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

SearchSpacesRequest

Sorguya göre bir alan listesi arama isteği.

Alanlar
use_admin_access

bool

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

Arayan kullanıcı, Chat ve Alanlar 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ını gerektirir.

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 sonuç döndürebilir.

Belirtilmemesi durumunda en fazla 100 alan döndürülür.

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

page_token

string

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

Sayfalandırma yapılırken sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler göndermek 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 zorunludur ve alanların hangi müşteriden getirileceğini belirtmek için kullanılır. Yalnızca customers/my_customer değeri desteklenir.

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

external_user_allowed, true veya false değerini kabul eder.

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

space_type gereklidir ve yalnızca SPACE değeri geçerlidir.

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

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

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

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

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

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

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

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

string

İsteğe bağlı. Alan listesinin sıralaması.

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

  • membership_count.joined_direct_human_user_count: Doğrudan bir alana katılan gerçek kullanıcıların sayısını belirtir.
  • last_active_time: Bu alanın herhangi bir konusuna son uygun öğenin eklendiği zamanı gösterir.
  • create_time: Alanın oluşturulduğu zamanı gösterir.

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

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

  • Azalan düzen için DESC.

Desteklenen söz dizimleri şunlardır:

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

SearchSpacesResponse

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

Alanlar
spaces[]

Space

İstenen alanların bulunduğu sayfa.

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 boşlukların toplam sayısı. Sonuç 10.000'den fazla boşluk içeriyorsa bu değer bir tahmindir.

SetUpSpaceRequest

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

Alanlar
space

Space

Zorunlu. Space.spaceType alanı zorunludur.

Alan oluşturmak için Space.spaceTypeSPACE olarak ayarlayın ve Space.displayName'yi ayarlayın. Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşunda mevcut bir alan bu görünen adı zaten kullanıyor olabilir.

Grup sohbeti oluşturmak için Space.spaceTypeGROUP_CHAT olarak ayarlayın. Space.displayName ayarını yapmayın.

Kullanıcılar arasında 1:1 görüşme oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm değerini ise false olarak ayarlayın. Space.displayName veya Space.spaceDetails ayarlanamaz.

Bir kullanıcı ile Chat uygulaması arasında 1:1 görüşme oluşturmak için Space.spaceTypeDIRECT_MESSAGE, Space.singleUserBotDm'yi ise true olarak ayarlayın. Space.displayName veya Space.spaceDetails ayarlanamaz.

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

request_id

string

İsteğe bağlı. Bu istek için benzersiz bir tanımlayıcı. Rastgele bir UUID kullanılması önerilir. Mevcut bir istek kimliği belirtmek, yeni bir alan oluşturmak yerine bu kimlikle oluşturulan alanı döndürür. Aynı Chat uygulamasında kimliği doğrulanmış farklı bir kullanıcının mevcut istek kimliğini belirtmek hata döndürür.

memberships[]

Membership

İsteğe bağlı. Alana katılmaya davet edilecek Google Chat kullanıcıları veya grupları. Arayan kullanıcı otomatik olarak ekleneceğinden bu kullanıcıyı atlayın.

Şu anda bu grupta arayan kullanıcıya ek olarak en fazla 20 üyelik oluşturulabilir.

Kullanıcı üyeliği için Membership.member alanında, name doldurulmuş (biçim: users/{user}) ve type User.Type.HUMAN olarak ayarlanmış bir user bulunmalıdır. Yalnızca alan oluştururken gerçek kullanıcıları ekleyebilirsiniz (Chat uygulamalarının eklenmesi yalnızca arama uygulamasıyla doğrudan mesaj oluşturma için desteklenir). {user} için takma ad olarak kullanıcının e-posta adresini kullanarak da üye ekleyebilirsiniz. Örneğin, user.name users/example@gmail.com olabilir. Gmail kullanıcılarını veya harici Google Workspace alanlarındaki kullanıcıları davet etmek için {user} parametresinde kullanıcının e-postası kullanılmalıdır.

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

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

Space.spaceType değerini GROUP_CHAT olarak ayarlama işleminde en az iki üyelikle birlikte gereklidir.

Tam olarak bir üyelikle birlikte gerçek bir kullanıcıyla Space.spaceTypeDIRECT_MESSAGE olarak ayarlama sırasında gereklidir.

Bir kullanıcı ile arayan Chat uygulaması arasında 1:1 görüşme oluştururken boş olmalıdır (Space.spaceType DIRECT_MESSAGE, Space.singleUserBotDm ise true olarak ayarlandığında).

SlashCommand

Google Chat'te eğik çizgiyle başlayan komut.

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

Komutunun çağrıldığı 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 Enum için varsayılan değer. Kullanmayın.
ADD Alana Chat uygulamasını ekleyin.
INVOKE Alanda eğik çizgi komutunu çağırın.

Boşluk

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

Alanlar
name

string

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

Biçim: spaces/{space}

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

type
(deprecated)

Type

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

space_type

SpaceType

İsteğe bağlı. 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ış.

single_user_bot_dm

bool

İsteğe bağlı. Alanın, bir Chat uygulaması ile tek bir kullanıcı arasında doğrudan mesaj olup olmadığı.

threaded
(deprecated)

bool

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceThreadingState kullanın. Bu alanda mesajların dizili olup olmadığı.

display_name

string

İsteğe bağlı. Alanın görünen adı. SPACE spaceType değerine sahip bir alan oluştururken gereklidir. Alan oluştururken veya displayName'yi güncellerken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşunda mevcut bir alan bu görünen adı zaten kullanıyor olabilir.

Doğrudan mesajlarda bu alan boş olabilir.

En fazla 128 karakter destekler.

external_user_allowed

bool

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

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

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

space_threading_state

SpaceThreadingState

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

space_details

SpaceDetails

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

space_history_state

HistoryState

İsteğe bağlı. Bu alandaki mesajlar ve ileti dizileri için 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'te oluşturulup oluşturulmadığı. Alanlar içe aktarılırken içe aktarma işlemi tamamlanana kadar kullanıcılar tarafından görülemez.

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

create_time

Timestamp

İsteğe bağlı. Değişmez. Chat'te oluşturulan alanlar için alanın oluşturulduğu saat. Bu alan, içe aktarma modu alanlarında kullanıldığında hariç olmak üzere yalnızca çıkış içindir.

İçe aktarma modundaki alanlar için bu alanı, orijinal oluşturma zamanını korumak amacıyla alanın kaynakta oluşturulduğu tarih damgasına ayarlayın.

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

last_active_time

Timestamp

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

admin_installed

bool

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

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

membership_count

MembershipCount

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

access_settings

AccessSettings

İsteğe bağlı. 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şmesi için URI.

import_mode_expire_time

Timestamp

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

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

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

customer

string

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

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

DM'ler için bu alan doldurulmaz.

Birlik alanı space_permission_settings. Bir alanın izin ayarlarını temsil eder. Yalnızca space_type SPACE olduğunda doldurulur.

Kullanıcı kimlik doğrulaması gerektirir. space_permission_settings yalnızca aşağıdakilerden biri olabilir:

predefined_permission_settings

PredefinedPermissionSettings

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

permission_settings

PermissionSettings

İsteğe bağlı. Mevcut alanlar için alan izni ayarları. Mevcut izin ayarlarının değiştirildiği tam alan izin ayarlarını güncellemek için giriş. Çıkışta mevcut izin ayarları listelenir.

AccessSettings

Alanın erişim ayarını temsil eder.

Alanlar
access_state

AccessState

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

audience

string

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

Biçim: audiences/{audience}

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

Hedef kitleyi okuma özelliği şunları destekler:

chat.bot kapsamı uygulama kimlik doğrulamasıyla kullanıldığında bu alan doldurulmaz.

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

AccessState

Alanın erişim durumunu gösterir.

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

Alan yöneticisi, bir hedef kitleye alana erişim izni verdiyse. Alana ayrı ayrı eklenen veya davet edilen kullanıcılar ya da Google Grupları da alanı bulup erişebilir. Daha fazla bilgi edinmek için Alanları belirli kullanıcılar tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin.

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

MembershipCount

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

Alanlar
joined_direct_human_user_count

int32

Yalnızca çıkış. Bir gruba üye olarak katılan kullanıcılar hariç, alana doğrudan katılan gerçek kullanıcıların sayısı.

joined_group_count

int32

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

PermissionSetting

Alan izin ayarını temsil eder.

Alanlar
managers_allowed

bool

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

members_allowed

bool

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

PermissionSettings

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

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

Alanlar
manage_members_and_groups

PermissionSetting

İsteğe bağlı. Bir alandaki üyeleri ve grupları yönetme ayarı.

modify_space_details

PermissionSetting

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

toggle_history

PermissionSetting

İsteğe bağlı. Alan geçmişini etkinleştirmek veya devre dışı bırakmak için kullanılan ayar.

use_at_mention_all

PermissionSetting

İsteğe bağlı. Bir alanda @all ifadesini kullanma ayarı.

manage_apps

PermissionSetting

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

manage_webhooks

PermissionSetting

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

post_messages

PermissionSetting

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

reply_messages

PermissionSetting

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

PredefinedPermissionSettings

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

Sıralamalar
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Belirtilmedi. Kullanmayın.
COLLABORATION_SPACE Alanı tüm üyelerin mesaj yayınlayabileceğ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 getirme 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ını açıklayın.

En fazla 150 karakter desteklenir.

guidelines

string

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

En fazla 5.000 karakter desteklenir.

SpaceThreadingState

Chat alanındaki mesaj dizilişi durumunun türünü belirtir.

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Rezerve edildi.
THREADED_MESSAGES İleti dizilerini destekleyen adlandırılmış alanlar. Kullanıcılar bir iletiyi yanıtlarken ileti dizisinde yanıt verebilir. Bu sayede, yanıtları orijinal ileti bağlamında kalır.
GROUPED_MESSAGES Görüşmenin konuya göre düzenlendiği adlandırılmış alanlar. Konular ve yanıtları birlikte gruplandırılır.
UNTHREADED_MESSAGES İki kişi arasındaki doğrudan mesajlar (DM'ler) ve 3 veya daha fazla kişi arasındaki grup görüşmeleri.

SpaceType

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

Sıralamalar
SPACE_TYPE_UNSPECIFIED Rezerve edildi.
SPACE Kullanıcıların mesaj gönderdiği, dosya paylaştığı ve ortak çalıştığı bir yerdir. SPACE, Chat uygulamaları içerebilir.
GROUP_CHAT 3 veya daha fazla kullanıcının yer aldığı grup görüşmeleri. GROUP_CHAT, Chat uygulamaları içerebilir.
DIRECT_MESSAGE İki gerçek kullanıcı veya bir gerçek kullanıcı ile Chat uygulaması arasında gerçekleşen 1:1 mesajlar.

Tür

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

Sıralamalar
TYPE_UNSPECIFIED Rezerve edildi.
ROOM İki veya daha fazla kişi arasındaki konuşmalar.
DM Bir kullanıcı ile Chat uygulaması arasında gerçekleşen ve tüm mesajların düz olduğu 1:1 Doğrudan Mesaj. Bu, iki kullanıcı arasındaki doğrudan mesajları kapsamaz.

SpaceBatchUpdatedEventData

Bir alanda 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

Google Chat alanındaki bir değişikliği veya etkinliği temsil eden bir 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 saat.

event_type

string

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

Mesajlar için desteklenen etkinlik türleri:

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

Üyelikler için desteklenen etkinlik türleri:

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

Tepkiler için desteklenen etkinlik türleri:

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

Alan ile ilgili desteklenen etkinlik türleri:

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

Birlik alanı payload.

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

message_created_event_data

MessageCreatedEventData

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

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

message_updated_event_data

MessageUpdatedEventData

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

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

message_deleted_event_data

MessageDeletedEventData

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

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

message_batch_created_event_data

MessageBatchCreatedEventData

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

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

message_batch_updated_event_data

MessageBatchUpdatedEventData

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

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

message_batch_deleted_event_data

MessageBatchDeletedEventData

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

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

space_updated_event_data

SpaceUpdatedEventData

Alan güncellemesi için etkinlik yükü.

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

space_batch_updated_event_data

SpaceBatchUpdatedEventData

Bir alanda 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 üyelik için etkinlik yükü.

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

membership_updated_event_data

MembershipUpdatedEventData

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

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

membership_deleted_event_data

MembershipDeletedEventData

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

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

membership_batch_created_event_data

MembershipBatchCreatedEventData

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

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

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

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

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

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

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

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

reaction_created_event_data

ReactionCreatedEventData

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

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

reaction_deleted_event_data

ReactionDeletedEventData

Silinmiş bir tepkinin etkinlik yükü.

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

reaction_batch_created_event_data

ReactionBatchCreatedEventData

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

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

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

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

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

SpaceNotificationSetting

Alandaki bir kullanıcının bildirim ayarları.

Alanlar
name

string

Tanımlayıcı. Alan bildirimi ayarının kaynak adı. Biçim: users/{user}/spaces/{space}/spaceNotificationSetting.

notification_setting

NotificationSetting

Bildirim ayarı.

mute_setting

MuteSetting

Alan bildirimlerini kapatma ayarı.

MuteSetting

Alan bildirimlerini kapatma ayarı türleri.

Sıralamalar
MUTE_SETTING_UNSPECIFIED Rezerve edildi.
UNMUTED Kullanıcı, bildirim ayarına bağlı olarak alanla ilgili bildirim alır.
MUTED Kullanıcı, bildirim ayarından bağımsız olarak alanla ilgili bildirim almaz.

NotificationSetting

Bildirim ayarı türleri.

Sıralamalar
NOTIFICATION_SETTING_UNSPECIFIED Rezerve edildi.
ALL Bildirimler @bahsetmeler, takip edilen mesaj dizileri ve yeni mesaj dizilerinin ilk mesajı ile ilgili olarak gönderilir. Kullanıcı tarafından manuel olarak takip edilmediği sürece tüm yeni ileti dizileri otomatik olarak takip edilir.
MAIN_CONVERSATIONS Bildirim, @bahsetmeler, takip edilen mesaj dizileri ve yeni mesaj dizilerinin ilk mesajı ile ilgili olarak tetiklenir. Bire bir doğrudan mesajlarda kullanılamaz.
FOR_YOU Bildirim, @bahsetmeler ve takip edilen mesaj dizileri tarafından tetiklenir. Bire bir doğrudan mesajlarda kullanılamaz.
OFF Bildirim kapalı.

SpaceReadState

Okunmuş ve okunmamış iletileri tanımlamak için kullanılan, kullanıcının alandaki okuma durumu.

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. Bu genellikle son okunan mesajın zaman damgasına veya kullanıcı tarafından bir alandaki son okunan konumu işaretlemek için belirtilen zaman damgasına karşılık gelir.

SpaceUpdatedEventData

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

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

Alanlar
space

Space

Güncellenen alan.

İleti dizisi

Google Chat alanındaki bir ileti dizisi. Örnek kullanım için Mesaj dizisi başlatma veya yanıtlama başlıklı makaleyi inceleyin.

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

Alanlar
name

string

Tanımlayıcı. İleti dizisinin kaynak adı.

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

thread_key

string

İsteğe bağlı. Mesaj dizisi oluşturmak veya güncellemek için giriş. Aksi takdirde yalnızca çıkış. İleti dizisinin kimliği. En fazla 4.000 karakter desteklenir.

Bu kimlik, ayarlayan Chat uygulamasına özgüdür. Örneğin, birden fazla Chat uygulaması aynı mesaj dizisi anahtarını kullanarak bir 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 dizisini yanıtlamak için bunun yerine mesaj dizisi name alanını belirtin.

ThreadReadState

Okunmuş ve okunmamış iletileri tanımlamak için kullanılan, kullanıcının bir ileti dizisindeki okuma durumu.

Alanlar
name

string

İleti dizisinin okunma durumunun kaynak adı.

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

last_read_time

Timestamp

Kullanıcının ileti dizisi okuma durumunun güncellendiği zaman. Bu değer genellikle bir ileti dizisindeki son okunan mesajın zaman damgasına karşılık gelir.

UpdateMembershipRequest

Üyelik güncelleme isteği mesajı.

Alanlar
membership

Membership

Zorunlu. Güncellenecek üyelik. Yalnızca update_mask ile belirtilen alanlar güncellenir.

update_mask

FieldMask

Zorunlu. Güncellenecek alan yolları. Birden fazla 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

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

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

chat.admin.memberships OAuth 2.0 kapsamını gerektirir.

UpdateMessageRequest

Mesaj güncelleme isteğinde bulunun.

Alanlar
message

Message

Zorunlu. Alanları güncellenmiş mesaj.

update_mask

FieldMask

Zorunlu. Güncellenecek alan yolları. Birden fazla 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 ve ileti bulunamazsa yeni bir ileti oluşturulur ve updateMask yoksayılır. Belirtilen ileti kimliği istemci tarafından atanmış olmalıdır. Aksi takdirde istek başarısız olur.

UpdateSpaceNotificationSettingRequest

Alan bildirim ayarlarını güncelleme isteğinde bulunabilirsiniz. Yalnızca arayan kullanıcının bildirim ayarının güncellenmesini destekler.

Alanlar
space_notification_setting

SpaceNotificationSetting

Zorunlu. Alan bildirim ayarlarının kaynak adı users/{user}/spaces/{space}/spaceNotificationSetting biçiminde doldurulmalıdır. Yalnızca update_mask ile belirtilen alanlar güncellenir.

update_mask

FieldMask

Zorunlu. Desteklenen alan yolları: - notification_setting - mute_setting

UpdateSpaceReadStateRequest

UpdateSpaceReadState API için istek mesajı.

Alanlar
space_read_state

SpaceReadState

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

Yalnızca arayan kullanıcının okuma durumunu güncellemeyi destekler.

Arayan kullanıcıyı belirtmek için aşağıdakilerden birini ayarlayın:

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

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

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

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

update_mask

FieldMask

Zorunlu. Güncellenecek alan yolları. Şu anda desteklenen alan yolları:

  • last_read_time

last_read_time, en son mesajın oluşturulduğu zamandan önceyse alan kullanıcı arayüzünde okunmamış olarak görünür.

Alanı okunmuş olarak işaretlemek için last_read_time değerini, en son mesajın oluşturulduğu zamandan sonraki bir değere (daha büyük) ayarlayın. last_read_time, en son mesajın oluşturulduğu zamanla eşleşecek şekilde zorlanacaktır. Alanın okunma durumunun yalnızca alanın üst düzey ileti dizisinde görünen mesajların okunma durumunu etkilediğini unutmayın. Mesaj dizilerindeki yanıtlar bu zaman damgasından etkilenmez ve bunun yerine ileti dizisinin okunma durumuna bağlıdı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 ile belirtilen alanlar güncellenir.

update_mask

FieldMask

Zorunlu. Birden fazla alan yolu varsa virgülle ayrılmış güncellenmiş alan yolları.

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

space_details: Alanın açıklamasını günceller. En fazla 150 karakter desteklenir.

display_name: Yalnızca spaceType alanının SPACE olduğu alanların görünen adını güncellemeyi destekler. ALREADY_EXISTS hata mesajını alırsanız farklı bir değer deneyin. Google Workspace kuruluşunda mevcut bir alan bu görünen adı zaten kullanıyor olabilir.

space_type: Yalnızca GROUP_CHAT alan türünün SPACE olarak değiştirilmesini destekler. Güncelleme maskesine space_type ile birlikte display_name öğesini ekleyin ve belirtilen alanın boş olmayan bir görünen ada ve SPACE alan türüne sahip olduğundan emin olun. Mevcut alanda zaten SPACE türü varsa görünen adı güncellerken belirtilen alana space_type maskesini ve SPACE türünü dahil etmek isteğe bağlıdır. Alan türünü başka yöntemlerle güncellemeye çalışmak geçersiz bağımsız değişken hatasına neden olur. space_type, useAdminAccess ile desteklenmez.

space_history_state: Alan 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ı etkinleştirilmişse desteklenir. Alan geçmişi durumunu güncellemek için isteğinizde diğer tüm alan maskelerini çıkarmanız gerekir. space_history_state, useAdminAccess ile desteklenmez.

access_settings.audience: spaceType alanının SPACE olduğu adlandırılmış alanda, alanı keşfedebilecek, alana katılabilecek ve mesajları önizleyebilecek kullanıcıların erişim ayarını günceller. Mevcut alanın hedef kitlesi varsa bu alan maskesi için bir değer atamadan kitleyi kaldırabilir ve alan erişimini kısıtlayabilirsiniz. Bir alanın erişim ayarlarını güncellemek için kimlik doğrulaması yapan kullanıcının alan yöneticisi olması ve isteğinizde diğer tüm alan maskelerini çıkarması gerekir. Alan içe aktarma modundaysa bu alanı güncelleyemezsiniz. Daha fazla bilgi edinmek için Alanları belirli kullanıcılar tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin. access_settings.audience, useAdminAccess ile desteklenmez.

permission_settings: Alanın izin ayarlarının değiştirilmesini destekler. İzin ayarlarını güncellerken yalnızca permissionSettings alan maskelerini belirtebilirsiniz. Aynı anda diğer alan maskelerini güncelleyemezsiniz. permissionSettings, useAdminAccess ile desteklenmez. Desteklenen alan maskeleri şunlardır:

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

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

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

chat.admin.spaces OAuth 2.0 kapsamını gerektirir.

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

Kullanıcı

Google Chat'teki bir kullanıcı. Chat uygulamanız bir istek sonucunda kullanıcı olarak kimlik doğrulaması yaparsa User kaynağının çıkışı yalnızca kullanıcının name ve type değerlerini doldurur.

Alanlar
name

string

Google Chat user kaynağının adı.

Biçim: users/{user}. users/app, bot kullanıcısının arayan uygulama 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 Kişi için id. Örneğin, Chat API'deki users/123456789, People API'deki 123456789 kişi profili kimliğiyle aynı kişiyi temsil eder.

  • Yönetici SDK'sı Directory API'de kullanıcı için id.

  • Kullanıcının e-posta adresi, API isteklerinde {user} için takma ad olarak kullanılabilir. Örneğin, user@example.com için People API kişi profili kimliği 123456789 ise users/123456789'e referans vermek üzere users/user@example.com takma adını kullanabilirsiniz. API'den yalnızca kurallı kaynak adı (örneğin, users/123456789) döndürülür.

display_name

string

Yalnızca çıkış. Kullanıcının görünen adı.

domain_id

string

Kullanıcının Google Workspace alanının benzersiz tanımlayıcısı.

type

Type

Kullanıcı türü.

is_anonymous

bool

Yalnızca çıkış. true olduğunda kullanıcı silinir veya profili görünmez.

Tür

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. KULLANMAYIN.
HUMAN Gerçek kullanıcı.
BOT Chat uygulaması kullanıcısı.

UserMentionMetadata

Kullanıcılardan bahsedilen (@) notlar için ek açıklama meta verileri.

Alanlar
user

User

Bahsedilen kullanıcı.

type

Type

Kullanıcının türü.

Tür

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

WidgetMarkup

Widget, metin ve resim sunan bir kullanıcı arayüzü öğesidir.

Alanlar
buttons[]

Button

Düğme listesi. Düğmeler de oneof data'dir ve bu alanlardan yalnızca biri ayarlanmalıdır.

Birlik alanı data. WidgetMarkup öğesinde yalnızca aşağıdaki öğelerden biri bulunabilir. Daha fazla öğe görüntülemek için birden fazla WidgetMarkup alanı kullanabilirsiniz. data yalnızca aşağıdakilerden biri olabilir:
text_paragraph

TextParagraph

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

image

Image

Bu widget'ta bir resim gösterin.

key_value

KeyValue

Bu widget'ta bir anahtar/değer öğesi gösterin.

Düğme

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

Alanlar

Birlik alanı type.

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

text_button

TextButton

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

image_button

ImageButton

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

FormAction

Form işlemi, form gönderildiğindeki davranışı tanımlar. Örneğin, formu işlemek için Apps Komut Dosyası'nı çağırabilirsiniz.

Alanlar
action_method_name

string

Yöntem adı, form gönderimini tetikleyen form bölümünü tanımlamak için kullanılır. Bu bilgiler, kart tıklama etkinliğinin bir parçası olarak Chat uygulamasına geri gönderilir. Ortak bir davranışı tetikleyen birden fazla öğe için aynı yöntem adını kullanabilirsiniz.

parameters[]

ActionParameter

İşlem parametrelerinin listesi.

ActionParameter

İşlem yöntemi çağrıldığında sağlanacak dize parametrelerinin listesi. Örneğin, üç erteleme düğmesi düşünelim: şimdi erteleyin, bir gün erteleyin, önümüzdeki hafta erteleyin. action method = snooze() değerini kullanarak, ertele türünü ve ertele süresini dize parametreleri listesine iletebilirsiniz.

Alanlar
key

string

İşlem komut dosyası için parametrenin 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 resim için doğru yüksekliği ayırmanıza olanak tanır. Bu, resmin yerleşik en boy oranını geçersiz kılmak için değildir. Ayarlanmamışsa sunucu, resmi önceden alarak doldurur.

ImageButton

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

Alanlar
on_click

OnClick

onclick işlemi.

name

string

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

Birlik alanı icons. Simge, Icon enum veya URL ile belirtilebilir. icons yalnızca aşağıdakilerden biri olabilir:
icon

Icon

Chat API tarafından sağlanan bir simgeyi dizine ekleyen enum ile belirtilen simge.

icon_url

string

URL ile belirtilen simge.

KeyValue

Kullanıcı arayüzü öğeleri bir anahtar (etiket) ve bir değer (içerik) içerir. Bu öğe, onclick düğmesi gibi bazı işlemler de içerebilir.

Alanlar
top_label

string

Üst etiketin metni. Biçimlendirilmiş metin desteklenir. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metin biçimlendirme ve Google Workspace eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

content

string

İçeriğin metni. Biçimlendirilmiş metin desteklenir ve her zaman gereklidir. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metin biçimlendirme ve Google Workspace eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

content_multiline

bool

İçeriğin çok satırlık olup olmayacağı.

bottom_label

string

Alttaki etiketin metni. Biçimlendirilmiş metin desteklenir. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metin biçimlendirme ve Google Workspace eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

on_click

OnClick

onclick işlemi. Yalnızca üst etiket, alt etiket ve içerik bölgesi tıklanabilir.

Birlik alanı icons. top_label ve bottom_label simgelerinden en az biri tanımlanmalıdır. icons yalnızca aşağıdakilerden biri olabilir:
icon

Icon

Chat API tarafından ilgili simge resmiyle değiştirilen bir enum değeri.

icon_url

string

URL ile belirtilen simge.

Birlik alanı control. Bir kontrol widget'ı. button veya switch_widget değerini ayarlayabilirsiniz ancak ikisini birden ayarlayamazsınız. control yalnızca aşağıdakilerden biri olabilir:
button

Button

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

OnClick

onclick işlemi (ör. bağlantı açma).

Alanlar

Birlik alanı data.

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

action

FormAction

Belirtilirse bu onclick işlemi bir form işlemini tetikler.

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 paragraf metin. Biçimlendirilmiş metin desteklenir. Metin biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metin biçimlendirme ve Google Workspace eklentilerinde metin biçimlendirme başlıklı makaleleri inceleyin.

Alanlar
text

string