Package google.chat.v1

Dizin

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Belirtilen alan için içe aktarma işlemini tamamlar ve alanı kullanıcılar için görünür hale getirir.

Kullanıcı kimlik doğrulaması ve yetkilendirme kapsamı ile alan genelinde yetki gerekir:

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

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

Yetkilendirme kapsamları

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

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

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

CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Özel emoji oluşturur.

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

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

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

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

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

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

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Çağıran Chat uygulaması, bir 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 bu üye davet edilir ve alana katılmadan önce alan davetini kabul etmesi gerekir. Aksi takdirde, üyelik oluşturulduğunda üye doğrudan belirtilen alana eklenir.

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

  • Yönetici onayı ve yetkilendirme kapsamı ile uygulama kimlik doğrulaması:

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

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

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

  • Alanın sahibi olan Workspace kuruluşunun dışından kullanıcıları davet etme
  • Alanlara Google Grubu ekleme
  • Bir alana Chat uygulaması ekleme

Örnek kullanım için şu sayfaya 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ılavuzunu inceleyin.

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.

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

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

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

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

Mesaj, uygulama kimlik doğrulamasıyla gönderildi

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östererek Chat uygulamasını mesaja bağlar. Mesajın içeriği yalnızca metin (text) içerebilir.

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

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

Webhook isteklerinde yanıt, mesajın tamamını içermez. Yanıtta, istekte bulunan bilgilere ek olarak yalnızca name ve thread.name alanları doldurulur.

Yetkilendirme kapsamları

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

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

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

CreateMessagePin

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

Mesaj sabitleme oluşturur.

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

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

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

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

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

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Tepki oluşturur ve mesaja ekler. Örnek için Mesaja tepki ekleme başlıklı makaleyi inceleyin.

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

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

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

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

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

CreateSection

rpc CreateSection(CreateSectionRequest) returns (Section)

Google Chat'te bölüm oluşturur. Bölümler, kullanıcıların görüşmeleri gruplandırmasına ve Chat gezinme panelinde gösterilen alan listesini özelleştirmesine yardımcı olur. Yalnızca CUSTOM_SECTION türünde bölümler oluşturulabilir. Ayrıntılı bilgi için Google Chat'te bölüm oluşturma ve düzenleme başlıklı makaleyi inceleyin.

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

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

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

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

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

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Alan oluşturur. Import mode uygulamasında adlandırılmış 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:

  • Yönetici onayı ve aşağıdaki yetkilendirme kapsamlarından biriyle uygulama kimlik doğrulaması:

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

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

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

Uygulama olarak kimlik doğrulaması yapıldığında Chat uygulaması, alanın üyesi olarak eklenir. Ancak gerçek kişi kimlik doğrulamasından farklı olarak Chat uygulaması, alan yöneticisi olarak eklenmez. Varsayılan olarak, Chat uygulaması tüm alan üyeleri tarafından alandan kaldırılabilir. Yalnızca alan yöneticilerinin uygulamayı alandan kaldırmasına izin vermek için space.permission_settings.manage_apps ayarını managers_allowed olarak belirleyin.

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

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

Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki 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ılavuzunu inceleyin.

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

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

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

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

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

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

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

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

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:

  • Yönetici onayı ve yetkilendirme kapsamı ile uygulama kimlik doğrulaması:

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

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

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

  • Google Gruplar'ı alandan kaldırma
  • Chat uygulamasını bir alandan kaldırma

Alan yöneticilerinin üyeliklerini silmek için istekte bulunan kullanıcının alan yöneticisi olması gerekir. Uygulama kimlik doğrulamasını kullanıyorsanız Chat uygulamasının alanı oluşturan uygulama olması gerekir.

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

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

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

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

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

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

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

Uygulama kimlik doğrulaması kullanılırken istekler yalnızca çağrıyı yapan Chat uygulaması tarafından oluşturulan mesajları silebilir.

Yetkilendirme kapsamları

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

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

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

DeleteMessagePin

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

Sabitlenmiş bir mesajı siler.

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

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

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

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

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

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Bir mesaja verilen tepkiyi siler. Örnek için Tepki silme bölümüne bakın.

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

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

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

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

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

DeleteSection

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

CUSTOM_SECTION türündeki bir bölümü siler.

Bölümde alanlar gibi öğeler varsa bu öğeler Google Chat'in varsayılan bölümlerine taşınır ve silinmez.

Ayrıntılı bilgi için Google Chat'te bölüm oluşturma ve düzenleme başlıklı makaleyi inceleyin.

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

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

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

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

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

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

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

  • Yönetici onayı ve yetkilendirme kapsamı ile uygulama kimlik doğrulaması:

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

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

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

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

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

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

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

Uygulama kimlik doğrulaması ile, belirtilen kullanıcı ile çağrıyı yapan 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ılavuzunu inceleyin.

FindGroupChats

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

spaceType == GROUP_CHAT içeren, gerçek kişi üyelikleri tam olarak çağrıyı yapan kullanıcıyı ve FindGroupChatsRequest.users içinde belirtilen kullanıcıları içeren tüm alanları döndürür. Yalnızca görüşmeye katılan üyeler desteklenir. Örnek için Grup sohbetlerini bulma başlıklı makaleyi inceleyin.

Çağrıyı yapan kullanıcı bazı kullanıcıları engellerse veya bazı kullanıcılar tarafından engellenirse ve belirtilen kullanıcı grubunun tamamını içeren alan bulunamazsa bu yöntem, engellenen veya engelleyen kullanıcıları içermeyen alanları döndürür.

Belirtilen kullanıcı grubu yalnızca insan (uygulama dışı) üyelikleri içermelidir. Gerçek kişi olmayan kullanıcılar içeren istekler hiçbir alan döndürmez.

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

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

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

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

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

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

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

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

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

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

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

GetAvailability

rpc GetAvailability(GetAvailabilityRequest) returns (Availability)

Google Chat'te gerçek bir kullanıcının müsaitlik durumu bilgisini döndürür. Örneğin, bir kullanıcının çevrimiçi veya uzakta olup olmadığını kontrol etmek ya da özel durum mesajını almak için bu yöntem kullanılabilir.

Bu yöntem yalnızca kimliği doğrulanmış kullanıcının müsaitlik durumunu alır.

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

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

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

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

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

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

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

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

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

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

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

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

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (yönetici onayı gerekir)
  • Aşağıdaki yetkilendirme kapsamlarından birini içeren kullanıcı kimlik doğrulaması:

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

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

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

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

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Bir mesajla ilgili ayrıntıları döndürür. Örnek için Bir mesajla ilgili ayrıntıları alma bölümüne bakın.

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

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

    • https://www.googleapis.com/auth/chat.bot: Bu yetkilendirme kapsamı kullanıldığında bu yöntem, Chat uygulamasının erişebildiği mesajlarla (ör. doğrudan mesajlar ve Chat uygulamasını çağıran eğik çizgi komutları) ilgili ayrıntıları döndürür.
    • https://www.googleapis.com/auth/chat.app.messages.readonly, yönetici onayı ile. Bu kimlik doğrulama kapsamı kullanıldığında bu yöntem, alandaki herkese açık bir mesajla ilgili ayrıntıları döndürür.
  • Aşağıdaki yetkilendirme kapsamlarından birini içeren kullanıcı kimlik doğrulaması:

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

Not: Engellenen bir üye veya alandan mesaj döndürebilir.

Yetkilendirme kapsamları

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

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

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

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

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

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

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

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

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

Uygulama kimlik doğrulamasında aşağıdaki sınırlamalar vardır:

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

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

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

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

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

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

İstenen verileri okumaya uygun bir yetkilendirme kapsamına sahip aşağıdaki kimlik doğrulama türlerini destekler:

  • Aşağıdaki yetkilendirme kapsamlarından biriyle yönetici onayı ile uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • Aşağıdaki yetkilendirme kapsamlarından birini içeren kullanıcı kimlik doğrulaması:

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

Bir etkinliği almak için kimliği doğrulanmış arayanın alanın üyesi olması gerekir.

Örnek için Google Chat alanındaki bir etkinlik hakkında ayrıntılı bilgi edinme başlıklı makaleyi inceleyin.

Yetkilendirme kapsamları

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

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

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

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Alan bildirim ayarını alır. Örnek için Arayanın alan bildirim ayarını alma bölümünü inceleyin.

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

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

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

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

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

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Kullanıcının bir alandaki okuma durumuyla ilgili ayrıntıları döndürür. Okunan ve okunmayan mesajları belirlemek için kullanılır. Örnek için Kullanıcının alan okuma durumuyla ilgili ayrıntıları alma başlıklı makaleyi inceleyin.

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

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

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

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

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

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Kullanıcının bir ileti dizisindeki okuma durumuyla ilgili ayrıntıları döndürür. Okunan ve okunmayan mesajları belirlemek için kullanılır. Örnek için Kullanıcının ileti dizisi okuma durumuyla ilgili ayrıntıları alma başlıklı makaleyi inceleyin.

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

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

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

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

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

ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Kimliği doğrulanmış kullanıcıya görünen özel emojileri listeler.

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

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

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

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

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

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

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (yönetici onayı gerekir)
  • Aşağıdaki yetkilendirme kapsamlarından birini içeren kullanıcı kimlik doğrulaması:

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

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

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

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

ListMessagePins

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

Bir alandaki sabitlenmiş mesajları listeler. Kullanıcılar, kolay erişim için alanlardaki önemli mesajları sabitleyebilir. Daha fazla bilgi için Google Chat'te görüşmeleri sabitleme veya sabitlemeyi kaldırma başlıklı makaleyi inceleyin.

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

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

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

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

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

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Arayanın üyesi olduğu bir alandaki mesajları (engellenen üyelerden ve alanlardan gelen mesajlar dahil) listeler. Yeni alan üyelerini duyuranlar gibi sistem mesajları dahil edilmez. Mesaj içermeyen bir alandaki mesajları listelerseniz yanıt boş bir nesne olur. REST/HTTP arayüzü kullanıldığında yanıt, boş bir JSON nesnesi ({}) içerir. Örnek için İletileri listeleme başlıklı makaleyi inceleyin.

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

  • Yetkilendirme kapsamıyla yönetici onayı ile uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Bu kimlik doğrulama kapsamı kullanıldığında bu yöntem yalnızca bir alandaki herkese açık mesajları döndürür. Özel mesajlar buna dahil değildir.
  • Aşağıdaki yetkilendirme kapsamlarından birini içeren kullanıcı kimlik doğrulaması:

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

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

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

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

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

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

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

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

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

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

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

ListSectionItems

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

Bir bölümdeki öğeleri listeler.

Bölüm öğeleri yalnızca alanlar olabilir. Ayrıntılı bilgi için Google Chat'te bölüm oluşturma ve düzenleme başlıklı makaleyi inceleyin.

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

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

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

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

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

ListSections

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse)

Chat kullanıcısının erişebileceği bölümleri listeler. Bölümler, kullanıcıların görüşmelerini gruplandırmasına ve Chat gezinme panelinde gösterilen alan listesini özelleştirmesine yardımcı olur. Ayrıntılı bilgi için Google Chat'te bölüm oluşturma ve düzenleme başlıklı makaleyi inceleyin.

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

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

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

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

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

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

İstenen verileri okumaya uygun bir yetkilendirme kapsamına sahip aşağıdaki kimlik doğrulama türlerini destekler:

  • Aşağıdaki yetkilendirme kapsamlarından biriyle yönetici onayı ile uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • Aşağıdaki yetkilendirme kapsamlarından birini içeren kullanıcı kimlik doğrulaması:

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

Etkinlikleri listelemek için kimliği doğrulanmış arayanı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.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

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

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

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

Yetkilendirme kapsamları

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

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

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

MarkAsActive

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability)

Kullanıcıyı Google Chat'te ACTIVE olarak işaretler.

Kullanıcının müsaitlik durumunu ACTIVE olarak ayarlar. ACTIVE durumu, belirtilen süre sonuna kadar devam eder. Bu noktada kullanıcının durumu AWAY olur. Kullanıcı Chat'i etkin bir şekilde kullanıyorsa ACTIVE durum süresinin, belirtilen bitiş tarihinden sonra da devam edebileceğini unutmayın.

Bu yöntem yalnızca kimliği doğrulanmış kullanıcının müsaitlik durumunu günceller.

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

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

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

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

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

MarkAsAway

rpc MarkAsAway(MarkAsAwayRequest) returns (Availability)

Kullanıcıyı Google Chat'te AWAY olarak işaretler.

Kullanıcının durumunu "Uzakta" olarak ayarlar ve kullanıcının etkinliğinden etkilenmez.

Bu yöntem yalnızca kimliği doğrulanmış kullanıcının müsaitlik durumunu günceller.

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

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

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

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

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

MarkAsDoNotDisturb

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability)

Kullanıcıyı Google Chat'te DO_NOT_DISTURB olarak işaretler.

Bir kullanıcının müsaitlik durumunu, belirtilen bitiş zamanına kadar DO_NOT_DISTURB olarak ayarlar. DO_NOT_DISTURB modundayken kullanıcılar genellikle bildirim almaz.

Bu yöntem yalnızca kimliği doğrulanmış kullanıcının müsaitlik durumunu günceller.

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

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

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

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

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

MoveSectionItem

rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse)

Bir öğeyi bir bölümden diğerine taşır. Örneğin, bir bölümde alanlar varsa bu yöntem, bir alanı farklı bir bölüme taşımak için kullanılabilir. Ayrıntılı bilgi için Google Chat'te bölüm oluşturma ve düzenleme başlıklı makaleyi inceleyin.

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

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

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

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

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

PositionSection

rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse)

Bir bölümün sıralama ölçütünü değiştirir. Ayrıntılı bilgi için Google Chat'te bölüm oluşturma ve düzenleme başlıklı makaleyi inceleyin.

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

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

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

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

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

ReplaceMessageCards

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

Mesajda yer alan kartları değiştirir.

Bir Chat uygulaması, yalnızca mesajda kartlar varsa ve kartlar uygulama tarafından oluşturulmuşsa kullanıcı tarafından oluşturulan bir mesajdaki kartları değiştirebilir.

Uygulama, kartları boş bir listeyle değiştirirse kartlar kaldırılır. Uygulama, kartları kaldırdıktan sonra mesaja tekrar kart ekleyemez.

Yetkilendirme kapsamı ile uygulama kimlik doğrulaması gerektirir: - https://www.googleapis.com/auth/chat.bot

Yetkilendirme kapsamları

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

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

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

SearchMessages

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

Google Chat'te, arayan kullanıcının erişebildiği mesajları arar. Arama ölçütleriyle eşleşen mesajların listesini döndürür.

Kullanıcının erişebildiği tüm alanlarda arama yapmak için parent değerini spaces/- olarak ayarlayın. parent için başka bir değer kullanılması INVALID_ARGUMENT hatasına neden olur. Döndürülen mesajların name alanı, mesajın bulunduğu belirli space bilgisini içeren tam kaynak adıyla doldurulur.

Bu API, tüm mesaj türlerini döndürmez. Aşağıda listelenen mesaj türleri yanıta dahil edilmez. Tüm mesajları listelemek için ListMessages kullanın.

  • Kimliği doğrulanmış kullanıcı tarafından görülebilen özel mesajlar.
  • Chat uygulamaları tarafından alanlarda veya grup sohbetlerinde yayınlanan mesajlar.
  • Chat uygulaması DM'sindeki mesajlar
  • Engellenen kullanıcılardan gelen mesajlar.
  • Arayanın sesini kapattığı alanlardaki mesajlar.

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

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
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

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

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Bir Google Workspace kuruluşundaki alanların listesini döndürür. Örnek için Alanları arama ve yönetme başlıklı makaleyi inceleyin.

use_admin_access, false olarak ayarlandığında sonuçlar, arayan kullanıcının katıldığı alanlarla sınırlı olur. Yönetici ayrıcalıklarıyla arama yapmak için use_admin_access değerini true olarak ayarlayı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.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

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

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

Eklenecek gerçek kişi üyeleri belirtmek için uygun membership.member.name ile üyelikler ekleyin. Gerçek kişi olan bir kullanıcı eklemek için users/{user} komutunu kullanın. Burada {user}, kullanıcının e-posta adresi olabilir. Aynı Workspace kuruluşundaki kullanıcılar için {user}, People API'deki kişinin id veya Directory API'deki kullanıcının id 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. Bir Google Grubu eklemek veya davet etmek için groups/{group} kullanın. Burada {group}, Cloud Identity Groups API'den alınan grubun 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-postası desteklenmez ve Google Gruplar yalnızca adlandırılmış alanlara üye olarak eklenebilir.

Adlandırılmış bir alan veya grup sohbetinde, arayan kişi bazı üyeleri engellerse veya 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 kişi kullanıcı arasında doğrudan mesaj (DM) oluşturmak için gerçek kişi kullanıcıyı temsil edecek tam olarak bir üyelik belirtin. Kullanıcılardan biri diğerini engellerse istek başarısız olur ve DM oluşturulmaz.

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

İki kullanıcı arasında zaten bir DM varsa istek yapıldığı sırada bir kullanıcı diğerini engellese bile mevcut DM döndürülür.

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

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

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

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

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

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

UpdateAvailability

rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability)

Gerçek bir kullanıcının müsaitlik bilgilerini günceller. Bu yöntemle yalnızca custom_status alanı güncellenebilir.

Bu yöntem yalnızca kimliği doğrulanmış kullanıcının müsaitlik durumunu günceller.

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

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

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

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

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

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

  • Yönetici onayı ve yetkilendirme kapsamı ile uygulama kimlik doğrulaması:

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

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

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

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

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

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

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

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

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

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

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

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

Yetkilendirme kapsamları

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

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

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

UpdateSection

rpc UpdateSection(UpdateSectionRequest) returns (Section)

Bir bölümü günceller. Yalnızca CUSTOM_SECTION türündeki bölümler güncellenebilir. Ayrıntılı bilgi için Google Chat'te bölüm oluşturma ve düzenleme başlıklı makaleyi inceleyin.

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

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

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

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

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

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

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

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

  • Yönetici onayı ve aşağıdaki yetkilendirme kapsamlarından biriyle uygulama kimlik doğrulaması:

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

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

Uygulama kimlik doğrulamasında aşağıdaki sınırlamalar vardır:

  • space.predefined_permission_settings veya space.permission_settings değerini güncellemek için uygulamanın alanı oluşturan uygulama olması gerekir.
  • Uygulama kimlik doğrulaması için space.access_settings.audience güncellemesi desteklenmiyor.
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ılavuzunu inceleyin.

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

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

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

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

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

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

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Bir kullanıcının alandaki okuma durumunu günceller. Okunan ve okunmayan mesajları belirlemek için kullanılır. Örnek için Kullanıcının alan okuma durumunu güncelleme başlıklı makaleyi inceleyin.

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

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

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

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

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

AccessoryWidget

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

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

ButtonList

Düğme listesi.

ActionResponse

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

Alanlar
type

ResponseType

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

url

string

Yalnızca giriş. Kullanıcıların kimlik doğrulaması 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 kutusuyla ilgili bir etkileşim etkinliğine verilen yanıt. ResponseType.Dialog ile birlikte kullanılmalıdır.

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 mesaj olarak yayınlama
UPDATE_MESSAGE Chat uygulamasının mesajını güncelleme 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ı mesajındaki kartları güncelleme Buna yalnızca eşleşen bir URL'ye sahip 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ğrulama veya yapılandırma isteyin.
DIALOG İletişim kutusu gösterir.
UPDATE_WIDGET Widget metni otomatik tamamlama seçenekleri sorgusu.

SelectionItems

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

Alanlar
items[]

SelectionItem

SelectionItem nesneleri dizisi.

UpdatedWidget

selectionInput widget'ları için çoklu seçim menüsüne yönelik otomatik tamamlama önerileri döndürür.

Alanlar
widget

string

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

updated_widget birleşik alanı. Widget, bir kullanıcı işlemine yanıt olarak güncellendi. updated_widget aşağıdakilerden yalnızca 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 gösterir.

Alanlar
status_code

Code

Durum kodu.

user_facing_message

string

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

Ek açıklama

Ek açıklamalar, mesajın düz metin gövdesiyle veya start_index ve length değeri 0 olan Google Dokümanlar ya da E-Tablolar gibi Google Workspace kaynaklarına bağlantı veren çiplerle ilişkilendirilebilir. Kısa mesajlara temel biçimlendirme eklemek için Kısa mesajları biçimlendirme başlıklı makaleyi inceleyin.

Düz metin e-posta mesajı ö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 notun türü.

length

int32

Bu ek açıklamanın karşılık geldiği düz metin e-posta mesajı gövdesindeki alt dizenin uzunluğu. Mevcut değilse uzunluğun 0 olduğunu gösterir.

start_index

int32

Bu ek açıklamanın karşılık geldiği düz metin e-posta mesajındaki başlangıç dizini (0 tabanlı, dahil).

metadata birleşik alanı. Notla ilgili ek meta veriler. metadata aşağıdakilerden yalnızca biri olabilir:
user_mention

UserMentionMetadata

Kullanıcıdan bahsetme meta verileri.

slash_command

SlashCommandMetadata

Eğik çizgi komutunun meta verileri.

custom_emoji_metadata

CustomEmojiMetadata

Özel emojinin meta verileri.

AnnotationType

Notun türü.

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

AppCommandMetadata

Chat uygulaması komutu ile ilgili meta veriler.

Alanlar
app_command_id

int32

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

app_command_type

AppCommandType

Chat uygulaması komutunun türü.

AppCommandType

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

Sıralamalar
APP_COMMAND_TYPE_UNSPECIFIED Varsayılan değer. Belirtilmedi.
SLASH_COMMAND Eğik çizgi komutu. Kullanıcı, komutu bir sohbet mesajında gönderir.
QUICK_COMMAND Hızlı komut. Kullanıcı, mesaj yanıt alanındaki Chat menüsünden komutu seçer.
MESSAGE_ACTION Mesaj işlemi. Kullanıcı, Chat'teki mesaj bağlam menüsünden komutu seçer.

AttachedGif

URL ile belirtilen bir GIF resmi.

Alanlar
uri

string

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

Ek

Google Chat'teki bir ek.

Alanlar
name

string

Tanımlayıcı. Ekin kaynak adı.

Biçim: spaces/{space}/messages/{message}/attachments/{attachment}.

content_name

string

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

content_type

string

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

thumbnail_uri

string

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

download_uri

string

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

source

Source

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

data_ref birleşik alanı. Eke veri referansı. data_ref aşağıdakilerden yalnızca biri olabilir:
attachment_data_ref

AttachmentDataRef

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

drive_data_ref

DriveDataRef

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

Kaynak

Ekin kaynağı.

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

AttachmentDataRef

Ek verilerine referans.

Alanlar
resource_name

string

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

attachment_upload_token

string

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

Kitle

Google Chat'teki bir hedef kitle. Hedef kitle, bir Google Workspace kuruluşunda yönetici tarafından tanımlanan bir kullanıcı grubunu temsil eder. Hedef kitleler, kaynakların erişim ve görünürlük ayarlarını yapılandırmak için kullanılır. Örneğin, bir alanı belirli bir kullanıcı grubu tarafından keşfedilebilir hale getirmek için hedef kitleleri kullanabilirsiniz.

Daha fazla bilgi için Hedef kitleler ve Alanları hedef kitleler tarafından bulunabilir hale getirme başlıklı makaleleri inceleyin.

Alanlar
name

string

Alanı keşfedebilecek veya alana katılabilecek hedef kitlenin kaynak adı. Ayrıntılar için Alanları hedef kitle tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin. Biçim: audiences/{audience}

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

Kullanılabilirlik

Kullanıcının Google Chat'teki mevcut müsaitlik durumu bilgilerini (ör. Etkin, Dışarıda, Rahatsız Etmeyin) ve özel durumunu temsil eder.

Alanlar
name

string

Tanımlayıcı. Kullanıcının müsaitlik durumunun kaynak adı.

Biçim: users/{user}/availability

{user}, People API veya Admin SDK Directory API'deki kişinin kimliğidir. Örneğin, users/123456789.

Kullanıcının e-posta adresi veya me, arayan kişiyi belirtmek için takma ad olarak da kullanılabilir. Örneğin, users/user@example.com veya users/me

state

State

Yalnızca çıkış. Kullanıcının mevcut müsaitlik durumu.

custom_status

CustomStatus

İsteğe bağlıdır. Kullanıcının özel durumu.

state_metadata birleşik alanı. Kullanıcının müsaitlik durumuyla ilişkili ek meta veriler. state_metadata aşağıdakilerden yalnızca biri olabilir:
do_not_disturb_metadata

DoNotDisturbMetadata

Yalnızca çıkış. Kullanıcı durumu DO_NOT_DISTURB olarak ayarlanmışsa meta veriler.

Eyalet

Kullanıcının mevcut müsaitlik durumunu gösterir.

Sıralamalar
STATE_UNSPECIFIED Varsayılan değer. Durum belirtilmemiş.
ACTIVE Kullanıcı, son etkinliğe göre şu anda etkindir.
IDLE Kullanıcı şu anda boştadır. Bu durum, ETKİN durumundan sonra, UZAKTA durumuna geçmeden önce bir süre işlem yapılmadığını gösterir.
AWAY Kullanıcı şu anda dışarıda. Bu durum, ETKİN veya BOŞTA durumunda bir süre işlem yapılmadığında otomatik olarak ya da kullanıcı tarafından manuel olarak ayarlanabilir. MarkAsAway üzerinden manuel olarak ayarlandığında bu durum, kullanıcı etkinliğinden bağımsız olarak devam eder.
DO_NOT_DISTURB Kullanıcı, manuel olarak ayarlanan Rahatsız Etmeyin durumundadır.

CalendarEventLinkData

Takvim etkinliği bağlantılarıyla ilgili veriler.

Alanlar
calendar_id

string

Bağlı Takvim'in Takvim tanımlayıcısı.

event_id

string

Bağlı Takvim etkinliğinin etkinlik tanımlayıcısı.

CardWithId

Google Chat sohbet mesajındaki kart.

Chat uygulamaları, uygulama kimlik doğrulaması ile kart oluşturabilir. Geliştirici Önizleme Programı kapsamında, Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa kart mesajları oluşturabilir. Chat uygulamanız Geliştirici Önizleme Programı'na dahil değilse kullanıcı kimlik doğrulaması içeren kartlar oluşturamaz.

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

Card Builder ile kart tasarlama ve önizleme

Kart Oluşturucu'yu açma

Alanlar
card_id

string

Mesajda birden fazla kart varsa zorunludur. Mesajdaki bir kartın benzersiz tanımlayıcısı.

card

Card

Kart. Maksimum boyut 32 KB'tır.

owner_user

User

Yalnızca çıkış. Kartın sahibi olan uygulama.

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}

Alıntı

Alıntılar, kullanıcılara satır içi referans hakkında daha ayrıntılı bilgi verebilen satır içi referanslardır. İlgili satır içi alıntılar, mesaj metninde <chat-citation data-id="{id}">{text}</chat-citation> işaretleme biçiminde bulunmalıdır. Alıntılar yalnızca mesajın markup_syntax değeri MARKDOWN olarak ayarlandığında desteklenir.

Elements.citations içindeki referanssız alıntılar (ileti metninde eşleşen bir <chat-citation> etiketi olmayanlar) yok sayılır ve iletinin reddedilmesine neden olmaz.

Alanlar
id

string

Zorunlu. Uygulama tarafından tanımlanan kimlik. Yalnızca ASCII harfleri ve rakamları içermeli ve 63 karakterden kısa olmalıdır.

cited_sources[]

CitedSource

İsteğe bağlıdır. Alıntıyla alakalı kaynakların listesi. Kaynaklar, bilgi kartında gösterilir.

CitedSource

Bir bilgi kaynağına yapılan atıf.

Alanlar
title

string

Zorunlu. CitedSource öğesinin düz metin başlığı. Bu alan, biçimlendirmeyi desteklemez.

uri

string

Zorunlu. Bu CitedSource tarafından referans verilen kaynağı işaret eden URI.

snippet

Snippet

İsteğe bağlıdır. Doğrudan kaynaktan bilgi içeren snippet.

footer

Footer

İsteğe bağlıdır. Snippet'in yanında altbilgi biçiminde gösterilecek ek bilgiler.

Kaynak için ilişkilendirme amacıyla kullanılan bir altbilgi.

Alanlar
text

string

İsteğe bağlıdır. Altbilgide gösterilecek metin.

Snippet

Daha büyük bir derlemden alıntıyı temsil eden snippet nesnesi.

Alanlar
text

string

İsteğe bağlıdır. Doğrudan derlemden alınan ve Chat'te gösterilebilecek kısa bir düz metin alıntısı. Markdown biçimini desteklemez.

image_preview

ElementsImage

İsteğe bağlıdır. Alıntı oluşturulurken giriş olarak sağlanan snippet'in resim önizlemesi.

CompleteImportSpaceRequest

Bir alanın içe aktarma işlemini tamamlamak 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şlemini tamamlamak için yanıt mesajı.

Alanlar
space

Space

İçe aktarma modu alanı.

ContextualAddOnMarkup

Bu türün alanı yok.

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

sections[]

Section

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

card_actions[]

CardAction

Bu kartın işlemleri.

name

string

Kartın adı.

CardAction

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

Google Chat uygulamaları tarafından desteklenmez.

Alanlar
action_label

string

İşlem menüsü öğesinde gösterilen etiket.

on_click

OnClick

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

CardHeader

Alanlar
title

string

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

subtitle

string

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

image_style

ImageStyle

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

image_url

string

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

ImageStyle

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

Bölüm

Bölüm, belirtildikleri sırayla (dikey olarak) oluşturulan bir widget koleksiyonu içerir. Tüm platformlarda kartların sabit bir genişliği vardır. Bu nedenle, şu anda düzen özelliklerine (ör. kayan) 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

Bölümlerde en az bir widget bulunmalıdır.

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.

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

  • Kullanıcı olarak kimlik doğrulaması yaparken chat.memberships yetkilendirme kapsamı gereklidir.

  • Uygulama olarak kimlik doğrulaması yaparken chat.app.memberships yetkilendirme kapsamı gereklidir.

  • user.type değerini HUMAN olarak ayarlayın ve user.name değerini users/{user} biçiminde ayarlayın. Burada {user}, kullanıcının e-posta adresi olabilir. Aynı Workspace kuruluşundaki kullanıcılar için {user}, People API'deki kişinin id değeri veya Directory API'deki kullanıcının id değeri de olabilir. Örneğin, user@example.com için People API kişisel profil 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ışından 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ı yapması ve chat.memberships.app kapsamını kullanması, user.type değerini BOT ve user.name değerini users/app olarak ayarlaması gerekir.

use_admin_access

bool

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

Arayan kullanıcı, 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şu dışındaki kullanıcılar için üyelik oluşturulması desteklenmez.

CreateMessageNotificationOptions

Mesaj yayınlandığında bildirim davranışıyla ilgili seçenekler.

Alanlar
notification_type

NotificationType

Mesajın bildirim türü.

NotificationType

Mesajın bildirim türü seçenekleri.

Sıralamalar
NOTIFICATION_TYPE_NONE Varsayılan davranış. Bildirim davranışı, gerçek kullanıcının Chat kullanıcı arayüzünü kullanarak mesaj göndermesine benzer: Gerçek gönderene bildirim gönderilmez.
NOTIFICATION_TYPE_FORCE_NOTIFY

Alıcılara zorunlu bildirim gönderilir. Bu işlem, kullanıcıların alan bildirim ayarlarını ve Chat Rahatsız Etmeyin ayarlarını geçersiz kılar. Bu seçenek, cihaz düzeyindeki Rahatsız Etmeyin ayarlarını atlamaz.

Uygulama kimlik doğrulaması gerekir.

NOTIFICATION_TYPE_SILENT

Alıcılara bildirim göndermeyin ve iletiyi okunmadı olarak işaretlemeyin. Bu, kullanıcının görüşmeyi sessize almasına veya Chat'te Rahatsız Etmeyin özelliğini etkinleştirmesine benzer şekilde çalışır.

Uygulama kimlik doğrulaması gerekir.

CreateMessagePinRequest

Mesaj sabitleme işlemi için istek mesajı.

Alanlar
parent

string

Zorunlu. Mesaj sabitlemenin oluşturulacağı üst alan. Biçim: spaces/{space}

message_pin

MessagePin

Zorunlu. Oluşturulacak MessagePin.

CreateMessageRequest

Mesaj oluşturur.

Alanlar
parent

string

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

Biçim: spaces/{space}

message

Message

Zorunlu. E-posta mesajı.

thread_key
(deprecated)

string

İsteğe bağlıdır. Desteği sonlandırıldı: Bunun yerine thread.thread_key kullanın. İleti dizisinin kimliği. En fazla 4.000 karakter desteklenir. Yeni bir ileti dizisi başlatmak veya mevcut bir ileti dizisine ekleme yapmak için bir mesaj oluşturun ve threadKey veya thread.name değerini 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ıdır. Bu istek için benzersiz bir kimlik. Rastgele bir UUID önerilir. İstek kimliği belirtildiğinde istek, idempotent hale gelir. Bu sayede, aynı istek kimliğine sahip birden fazla aynı istek yalnızca tek bir mesajın oluşturulmasıyla sonuçlanır. Aynı istek kimliğine sahip sonraki istekler, mevcut mesajı döndürür ve istenen ayrıntılar mevcut durumdan farklı olsa bile mesajı güncellemez.

Bu alanı etkili bir şekilde kullanmak için:

  • Sonraki isteklerin aynı olduğundan ve orijinal istekle aynı kimlik doğrulama bilgilerini kullandığından emin olun.
  • Sağlanan istek kimliğiyle daha önce bir mesaj oluşturulmuşsa istek bu mesajı döndürür. Döndürülen mesajın tam olarak doldurulmayabileceğini unutmayın. API, isteğinizdeki mesajı sistem tarafından atanan kaynak adları doldurulmuş şekilde yansıtır. Mesajın en son meta verilerini almak için GetMessage yöntemini çağırın.
  • Mevcut bir istek kimliğinin farklı bir kimliği doğrulanmış kullanıcıyla yeniden kullanılması hataya neden olur.
message_reply_option

MessageReplyOption

İsteğe bağlıdır. Bir mesajın yeni bir mesaj dizisi mi başlattığını yoksa mevcut bir mesaj dizisini mi yanıtladığını belirtir. Yalnızca adlandırılmış alanlarda desteklenir.

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

message_id

string

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

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

  • client- ile başlar. Örneğin, client-custom-name geçerli bir özel kimliktir ancak custom-name geçerli değildir.
  • En fazla 63 karakterden oluşur ve yalnızca küçük harf, rakam ve kısa çizgi içerir.
  • Bir alanda benzersizdir. Chat uygulamaları, farklı mesajlar için aynı özel kimliği kullanamaz.

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

create_message_notification_options

CreateMessageNotificationOptions

İsteğe bağlıdır. Mesaj yayınlandığında bildirim davranışını kontrol eder. Daha fazla bilgi için Bildirimleri zorunlu kılma veya sessiz mesaj gönderme başlıklı makaleyi inceleyin.

MessageReplyOption

Mesajları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 thread ID veya thread_key yoksayılır.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD İletiyi, thread ID veya thread_key tarafından belirtilen ileti dizisine yanıt olarak oluşturur. Başarısız olursa mesaj yeni bir ileti dizisi başlatır.
REPLY_MESSAGE_OR_FAIL İletiyi, thread ID veya thread_key tarafından belirtilen ileti dizisine yanıt olarak oluşturur. Yeni bir thread_key kullanılırsa yeni bir ileti dizisi oluşturulur. Mesaj oluşturma işlemi başarısız olursa bunun yerine NOT_FOUND hatası döndürülür.

CreateReactionRequest

Mesajlara tepki bırakma

Alanlar
parent

string

Zorunlu. Tepkinin oluşturulduğu mesaj.

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

reaction

Reaction

Zorunlu. Oluşturulacak tepki.

CreateSectionRequest

Bölüm oluşturma isteği mesajı.

Alanlar
parent

string

Zorunlu. Bölümün oluşturulduğu üst kaynağın adı.

Biçim: users/{user}

section

Section

Zorunlu. Oluşturulacak bölüm.

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 değerine ayarlanırsa kullanılabilir.

ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki 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ıdır. Bu istek için benzersiz bir kimlik. Rastgele bir UUID önerilir. İstek kimliği belirtildiğinde istek, idempotent hale gelir. Bu sayede, aynı istek kimliğine sahip birden fazla aynı istek, yalnızca tek bir alanın oluşturulmasıyla sonuçlanır. Aynı istek kimliğine sahip sonraki istekler, istenen ayrıntılar mevcut durumdan farklı olsa bile mevcut alanı döndürür ve alanı güncellemez.

Bu alanı etkili bir şekilde kullanmak için:

  • Sonraki isteklerin aynı olduğundan ve orijinal istekle aynı kimlik doğrulama bilgilerini kullandığından emin olun.
  • Sağlanan istek kimliğiyle daha önce bir alan oluşturulmuşsa istek bu alanı döndürür. Döndürülen alanın tam olarak doldurulmayabileceğini unutmayın. API, isteğinizdeki alanı sistem tarafından atanan kaynak adıyla doldurur. Alanla ilgili en güncel meta verileri almak için GetSpace yöntemini çağırın.
  • Mevcut bir istek kimliğinin farklı bir kimliği doğrulanmış kullanıcıyla yeniden kullanılması hataya neden olur.

CustomEmoji

Özel emojiyi temsil eder.

Alanlar
name

string

Tanımlayıcı. Özel emojinin sunucu tarafından atanan kaynak adı.

Biçim: customEmojis/{customEmoji}

uid

string

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

emoji_name

string

İsteğe bağlıdır. Değiştirilemez. Ö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ış olarak 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 emoji için en az 10 dakika geçerli olan geçici bir resim URL'si. Özel emoji oluşturulduğunda bu alanın yanıtta doldurulmadığını unutmayın.

payload

CustomEmojiPayload

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

CustomEmojiPayload

Özel emoji için yük verileri.

Alanlar
file_content

bytes

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

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

filename

string

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

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

CustomEmojiMetadata

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

Alanlar
custom_emoji

CustomEmoji

Özel emoji.

CustomStatus

Kullanıcının Google Chat'teki özel durumunu temsil eder. Bu, kullanıcının müsaitlik durumu hakkında daha fazla bilgi vermek için ayarladığı isteğe bağlı bir emoji içeren kısa bir kısa mesajı içerir.

Alanlar
text

string

Zorunlu. Özel durumun metni. Bu, maksimum uzunluğu 64 olan bir dize olacaktır.

emoji

Emoji

Zorunlu. Özel durumun emojisi. Yalnızca Unicode emojiler desteklenir. Özel emojiler desteklenmez.

expiration birleşik alanı. Özel durumun geçerlilik süresi. Mutlak bir zaman damgası veya geçerlilik süresi olarak belirtilebilir. expiration aşağıdakilerden yalnızca biri olabilir:
expire_time

Timestamp

Özel durumun süresinin dolduğu zaman damgası.

ttl

Duration

Yalnızca giriş. Özel durumun süresinin dolacağı geçerlilik süresi.

DeleteCustomEmojiRequest

Özel emoji silme isteği.

Alanlar
name

string

Zorunlu. Silinecek özel emojinin kaynak adı.

Biçim: customEmojis/{customEmoji}

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

DeleteMembershipRequest

Bir alandaki üyeliği silme isteği gönderme

Alanlar
name

string

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

Bir kullanıcı üyeliği silinirken kullanıcı kimlik doğrulaması ile chat.memberships kapsamı veya uygulama kimlik doğrulaması ile chat.memberships.app kapsamı ve spaces/{space}/members/{member} biçimi gerekir. E-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).

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

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

use_admin_access

bool

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

Arayan kullanıcı, 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.

DeleteMessagePinRequest

Sabitlenmiş bir mesajı silmek için istek mesajı.

Alanlar
name

string

Zorunlu. Kaldırılacak mesaj sabitlemenin kaynak adı. Biçim: spaces/{space}/messagePins/{message_pin}

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 ayarladıysanız {message} için clientAssignedMessageId alanındaki değeri kullanabilirsiniz. Ayrıntılar için Mesaj adlandırma başlıklı makaleyi inceleyin.

force

bool

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

Yalnızca kullanıcı olarak kimlik doğrulaması yapıldığında geçerlidir. Chat uygulaması olarak kimlik doğrulaması yapıldığında etkisi olmaz.

DeleteReactionRequest

Bir mesaja verilen tepkiyi siler.

Alanlar
name

string

Zorunlu. Silinecek tepkinin adı.

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

DeleteSectionRequest

Bir bölümü silmek için istek mesajı.

Alanlar
name

string

Zorunlu. Silinecek bölümün adı.

Biçim: users/{user}/sections/{section}

DeleteSpaceRequest

Alan silme isteği

Alanlar
name

string

Zorunlu. Silinecek alanın kaynak adı.

Biçim: spaces/{space}

use_admin_access

bool

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

Arayan kullanıcı, 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 mesajlar silinir.

Alanlar
deletion_type

DeletionType

Mesajı kimin sildiğini gösterir.

DeletionType

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

Sıralamalar
DELETION_TYPE_UNSPECIFIED Bu değer kullanılmıyor.
CREATOR Kullanıcı kendi mesajını sildi.
SPACE_OWNER Mesaj bir sahip veya yönetici tarafından silindi.
ADMIN Bir Google Workspace yöneticisi mesajı sildi. Yöneticiler, alandaki herhangi bir mesajı silebilir. Buna, alan üyeleri veya Chat uygulamaları tarafından gönderilen mesajlar da dahildir.
APP_MESSAGE_EXPIRY Bir Chat uygulaması, süresi dolduğunda kendi mesajını sildi.
CREATOR_VIA_APP Bir Chat uygulaması, mesajı oluşturan kişi adına (kullanıcı kimlik doğrulaması kullanarak) mesajı sildi.
SPACE_OWNER_VIA_APP Bir Chat uygulaması, alan yöneticisi adına mesajı sildi (kullanıcı kimlik doğrulaması kullanılarak).
SPACE_MEMBER Alandaki bir üye mesajı sildi. Kullanıcılar, uygulamalar tarafından gönderilen mesajları silebilir.

Dialog

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

Alanlar
body

Card

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

DialogAction

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

Alanlar
action_status

ActionStatus

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

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

Dialog

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

DoNotDisturbMetadata

DO_NOT_DISTURB müsaitlik durumuyla ilişkili meta veriler, durumun ne zaman sona ereceğini belirtir.

Alanlar
expiration_time

Timestamp

Yalnızca çıkış. Kullanıcının DO_NOT_DISTURB olarak işaretlenmesi gereken zaman damgası. Bu tarih, en fazla 1 yıl sonrası olabilir.

DriveDataRef

Drive ekindeki verilere 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ü.

Öğeler

Öğeler, mesaj oluşturma sırasında sağlanan mesaj metniyle ilişkilendirilebilecek veya ilişkilendirilemeyecek ek bileşenlerdir.

Alanlar
cited_sources[]

CitedSource

Mesajın altında altbilgi bağlantıları olarak gösterilecek kaynakların listesi. Bunlara satır içinde referans verilmez. Satır içi referanslar için citations kullanın.

citations[]

Citation

Mesaj metninde (<chat-citation> etiketleri aracılığıyla) referans verilen ve etkileşimli bilgi kartları olarak oluşturulan satır içi alıntıların listesi.

ElementsImage

Bir resmi temsil etmenin farklı yollarını kapsayan nesne. Şu anda desteklenen temsiller: - Bir URI'den getirilen resim. Gelecekte başka gösterimler de desteklenebilir.

Alanlar
image birleşik alanı. Zorunlu. Desteklenen resim temsillerinden biri. image aşağıdakilerden yalnızca biri olabilir:
image_uri

string

Zorunlu. Bir resmin herkese açık URI'si.

Emoji

Mesaja tepki olarak kullanılan emoji.

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

string

İsteğe bağlıdır. Unicode dizesiyle temsil edilen temel bir emoji.

custom_emoji

CustomEmoji

Özel emoji.

EmojiReactionSummary

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

Alanlar
emoji

Emoji

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

reaction_count

int32

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

FindDirectMessageRequest

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

Alanlar
name

string

Zorunlu. Doğrudan mesajın bulunacağı kullanıcının kaynak adı.

Biçim: users/{user}. Burada {user}, People API'deki kişinin id değeri veya Directory API'deki kullanıcının id değeridir. Örneğin, People API profil kimliği 123456789 ise name olarak users/123456789 kullanarak bu kişiyle doğrudan mesaj bulabilirsiniz. Kullanıcı olarak kimlik doğrulaması yapıldığında e-posta adresini {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).

FindGroupChatsRequest

Kullanıcı kaynaklarına göre grup sohbeti alanlarını alma isteği.

Alanlar
users[]

string

İsteğe bağlıdır. Arayan kullanıcıyla grup sohbetinde olan tüm gerçek kullanıcıların kaynak adları. Chat uygulamaları isteğe dahil edilemez.

Tek bir istekte belirtilebilecek maksimum kullanıcı sayısı 49.

Biçim: users/{user}, burada {user}, People API'deki kişinin id'si veya Directory API'deki kullanıcının id'sidir. Örneğin, arayan kullanıcı ve diğer iki kullanıcıyla (People API profil kimlikleri 123456789 ve 987654321 olan) yapılan tüm grup sohbetlerini bulmak için users/123456789 ve users/987654321 değerlerini kullanabilirsiniz. Bu e-posta adresini {user} için takma ad olarak da kullanabilirsiniz. Örneğin, users/example@gmail.com (example@gmail.com, Google Chat kullanıcısının e-posta adresidir).

page_size

int32

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

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

Maksimum değer 30'dur. 30'dan büyük bir değer kullanırsanız bu değer otomatik olarak 30'a değiştirilir.

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

page_token

string

İsteğe bağlıdır. Grup sohbetlerini bulmak için yapılan ö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, jetonu sağlayan çağrıyla eşleşmelidir. Farklı değerler iletmek beklenmedik sonuçlara yol açabilir.

space_view

SpaceView

İstenen alan görünümü türü. Ayarlanmazsa varsayılan olarak SPACE_VIEW_RESOURCE_NAME_ONLY değerine ayarlanır. SPACE_VIEW_EXPANDED değerini belirten istekler, alan verilerinin okunmasına izin veren kapsamlar içermelidir (ör. https://www.googleapis.com/auth/chat.spaces veya https://www.googleapis.com/auth/chat.spaces.readonly).

FindGroupChatsResponse

Yalnızca arayan kullanıcıyı ve istenen kullanıcıları içeren grup sohbeti alanlarını içeren bir yanıt.

Alanlar
spaces[]

Space

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

next_page_token

string

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

ForwardedMetadata

Mesajın yönlendirildiği kaynak alanla ilgili meta veriler.

Alanlar
space

string

Yalnızca çıkış. Kaynak alanın kaynak adı. Biçim: spaces/{space}

space_display_name

string

Yalnızca çıkış. Yönlendirme sırasında kaynak alanın veya DM'nin görünen adı. SPACE için bu, alan adıdır. DIRECT_MESSAGE için bu, diğer katılımcının adıdır (ör. "Kullanıcı A"). GROUP_CHAT için bu, üyelerin adlarına göre oluşturulan bir addır ve içerik üretici dahil 5 kişiyle sınırlıdır (ör. "Kullanıcı A, Kullanıcı B").

GetAttachmentRequest

Ek almak için istekte bulunma

Alanlar
name

string

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

GetAvailabilityRequest

GetAvailability yöntemi için istek mesajı.

Alanlar
name

string

Zorunlu. Alınacak müsaitlik durumunun kaynak adı.

Biçim: users/{user}/availability

{user}, People API veya Admin SDK Directory API'deki kişinin kimliğidir. Örneğin, users/123456789.

Kullanıcının e-posta adresi veya me, arayan kişiyi belirtmek için takma ad olarak da kullanılabilir. Örneğin, users/user@example.com veya users/me

GetCustomEmojiRequest

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

Alanlar
name

string

Zorunlu. Özel emojinin kaynak adı.

Biçim: customEmojis/{customEmoji}

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

GetMembershipRequest

Bir alana üye olma 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 yöntemini 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ıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, 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 alandaki uygulama üyeliklerini alma işlemi desteklenmez.

GetMessageRequest

Mesaj almak için istekte bulunun.

Alanlar
name

string

Zorunlu. Mesajın kaynak adı.

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

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

markup_syntax

MarkupSyntax

İsteğe bağlıdır. Sohbet mesajı formatted_text alanı için istenen çıkış söz dizimini belirtir.

GetSpaceEventRequest

Alan etkinliği almak için istek mesajı.

Alanlar
name

string

Zorunlu. Alan etkinliğinin kaynak adı.

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

GetSpaceNotificationSettingRequest

Alan bildirimi ayarını almak için mesaj isteyin. Yalnızca arayan kullanıcı için bildirim ayarının alınmasını 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 okuma durumunun kaynak adı.

Yalnızca arayan kullanıcının okuma durumunu alma desteklenir.

Arayan kullanıcıya atıfta bulunmak için aşağıdakilerden birini ayarlayın:

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

  • Kullanıcının Workspace e-posta adresi. Ö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 döndürme isteği.

Alanlar
name

string

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

Biçim: spaces/{space}

use_admin_access

bool

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

Arayan kullanıcı, 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 dizisi okuma durumunun kaynak adı.

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

Arayan kullanıcıya atıfta bulunmak için aşağıdakilerden birini ayarlayın:

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

  • Kullanıcının Workspace e-posta adresi Ö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'teki bir Google Grubu.

Alanlar
name

string

Bir Google Grubu'nun kaynak adı.

Cloud Identity Groups API'de bir grubu temsil eder.

Biçim: groups/{group}

HistoryState

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

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

ListCustomEmojisRequest

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

Alanlar
page_size

int32

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

page_token

string

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

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

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

filter

string

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

İçerik üreticiye göre filtrelemeyi destekler.

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

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

creator("users/me")

Geçersiz sorgular INVALID_ARGUMENT hatasıyla reddedilir.

ListCustomEmojisResponse

Özel emojileri listelemek için bir yanıt.

Alanlar
custom_emojis[]

CustomEmoji

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

next_page_token

string

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

ListMembershipsRequest

Üyelikleri listelemek için istek mesajı.

Alanlar
parent

string

Zorunlu. Üyelik listesi alınacak alanın kaynak adı.

Biçim: spaces/{space}

page_size

int32

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

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

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

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

page_token

string

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

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 iletmek beklenmedik sonuçlara yol açabilir.

filter

string

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

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

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

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

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

use_admin_access, doğru olarak ayarlandığında member.type = "HUMAN" veya member.type != "BOT" zorunludur. 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ıdır. true olduğunda, diğer üyelik türlerine ek olarak bir Google Group ile ilişkili üyelikleri de döndürür. filter ayarlanırsa filtre ölçütleriyle eşleşmeyen Google Group üyelikleri döndürülmez.

show_invited

bool

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

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

use_admin_access

bool

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

Arayan kullanıcı, 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 alandaki uygulama üyeliklerinin listelenmesi desteklenmez.

ListMembershipsResponse

Alanın üyeliklerini listeleme isteğine yanıt.

Alanlar
memberships[]

Membership

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

next_page_token

string

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

ListMessagePinsRequest

Mesaj sabitlemelerini listelemek için istek mesajı.

Alanlar
parent

string

Zorunlu. Sabitlenmiş öğeler koleksiyonunun sahibi olan üst alan Biçim: spaces/{space}

page_size

int32

İsteğe bağlıdır. Döndürülen maksimum mesaj sabitleme sayısı. Hizmet, bu değerden daha az mesaj döndürebilir. Maksimum değer 100'dür. 100'den büyük bir değer kullanırsanız bu değer otomatik olarak 100'e değiştirilir. Belirtilmezse en fazla 100 sabitlenmiş mesaj döndürülür. Negatif değerler INVALID_ARGUMENT hatası döndürür.

page_token

string

İsteğe bağlıdır. Önceki bir liste mesaj sabitleme ç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 iletmek beklenmedik sonuçlara yol açabilir.

ListMessagePinsResponse

Mesaj sabitlemelerini listelemek için yanıt mesajı.

Alanlar
message_pins[]

MessagePin

Belirtilen alandaki sabitlenmiş mesajlar.

next_page_token

string

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

ListMessagesRequest

Kullanıcının üyesi olduğu, belirtilen alandaki 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ır. Döndürülen maksimum mesaj sayısı. Hizmet, bu değerden daha az mesaj döndürebilir.

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

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

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

page_token

string

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

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 iletmek beklenmedik sonuçlara yol açabilir.

filter

string

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

Mesajları tarihe (create_time) ve ileti dizisine (thread.name) göre filtreleyebilirsiniz.

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

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

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

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

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

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

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

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

thread.name = spaces/AAAAAAAAAAA/threads/123

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

order_by

string

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

  • Artan sıralama için ASC.

  • Azalan sıralama için DESC.

Varsayılan sıralama create_time ASC şeklindedir.

show_deleted

bool

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

markup_syntax

MarkupSyntax

İsteğe bağlıdır. Sohbet mesajı formatted_text alanı için istenen çıkış söz dizimini belirtir.

ListMessagesResponse

Mesajları listelemek için yanıt mesajı.

Alanlar
messages[]

Message

Mesaj listesi.

next_page_token

string

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

ListReactionsRequest

Bir mesaja verilen tepkileri listeler.

Alanlar
parent

string

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

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

page_size

int32

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

page_token

string

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

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

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

filter

string

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

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

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

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

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

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

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

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

ListReactionsResponse

Tepkileri listeleme isteğine verilen yanıt.

Alanlar
reactions[]

Reaction

İstenen (veya ilk) sayfadaki tepkilerin listesi.

next_page_token

string

Sonraki sonuç sayfasını almak için devam jetonu. Sonuçların son sayfası için bu alan boştur.

ListSectionItemsRequest

Bölüm öğelerini listelemek için istek mesajı.

Alanlar
parent

string

Zorunlu. Bu bölüm öğeleri koleksiyonunun sahibi olan bölüm kaynağı adı olan üst öğe. Yalnızca arayan kullanıcı için bölüm öğelerini listelemeyi destekler.

Alana göre filtreleme yaparken tüm bölümlerde arama yapmak için joker karakteri - kullanın. Örneğin, users/{user}/sections/-.

Biçim: users/{user}/sections/{section}

page_size

int32

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

Belirtilmezse en fazla 10 bölüm öğesi döndürülür.

Maksimum değer 100'dür. 100'den büyük bir değer kullanırsanız bu değer otomatik olarak 100'e değiştirilir.

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

page_token

string

İsteğe bağlıdır. Önceki bir bölüm öğelerini listeleme çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu değeri 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 iletmek beklenmedik sonuçlara yol açabilir.

filter

string

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

Şu anda yalnızca alana göre filtreleme desteklenmektedir.

Örneğin, space = spaces/{space}.

Geçersiz sorgular INVALID_ARGUMENT hatasıyla reddedilir.

ListSectionItemsResponse

Bölüm öğelerini listelemek için yanıt mesajı.

Alanlar
section_items[]

SectionItem

Belirtilen bölümdeki bölüm öğeleri.

next_page_token

string

Sonraki sayfayı almak için page_token olarak gönderilebilen bir jeton. Bu alan atlanırsa sonraki sayfa yoktur.

ListSectionsRequest

Bölümleri listelemek için istek mesajı.

Alanlar
parent

string

Zorunlu. Bu bölüm koleksiyonunun sahibi olan kullanıcı kaynağı adı olan üst öğe. Yalnızca arayan kullanıcı için bölümleri listelemeyi destekler. Arayan kullanıcıya atıfta bulunmak için aşağıdakilerden birini ayarlayın:

  • me takma adı. Örneğin, users/me.

  • Kullanıcının Workspace e-posta adresi. Örneğin, users/user@example.com.

  • Kullanıcı kimliği Örneğin, users/123456789.

Biçim: users/{user}

page_size

int32

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

Belirtilmezse en fazla 10 bölüm döndürülür.

Maksimum değer 100'dür. 100'den büyük bir değer kullanırsanız bu değer otomatik olarak 100'e değiştirilir.

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

page_token

string

İsteğe bağlıdır. Önceki bir liste bölümleri çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu değeri 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 iletmek beklenmedik sonuçlara yol açabilir.

ListSectionsResponse

Bölümleri listelemek için yanıt mesajı.

Alanlar
sections[]

Section

Belirtilen kullanıcıya ait bölümler.

next_page_token

string

Sonraki sayfayı almak için page_token olarak gönderilebilen bir jeton. Bu alan atlanırsa sonraki sayfa yoktur.

ListSpaceEventsRequest

Alan etkinliklerini listelemek için istek mesajı.

Alanlar
parent

string

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

Biçim: spaces/{space}.

page_size

int32

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

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

page_token

string

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

Sayfalandırma sırasında, alan etkinliklerini listelemek için sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler iletmek 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 atlayı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) toplu olarak da 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 filtreleyebilirsiniz:

  • start_time: Alan etkinliklerini listelemeye başlamak için özel zaman damgası. 28 gün öncesine kadar gerçekleşen etkinlikleri listeleyebilirsiniz. Belirtilmezse son 28 güne ait alan etkinlikleri listelenir.
  • end_time: Alan etkinliklerinin listelendiği zaman damgası (dahil). Belirtilmezse istek zamanına kadar olan etkinlikleri listeler.

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

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

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

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 listelemek için yanıt mesajı.

Alanlar
space_events[]

SpaceEvent

Sonuçlar kronolojik sırayla (en eski etkinlik ilk sırada olacak şekilde) 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 getirmek için kullanılan devam jetonu. Bu alan atlanırsa sonraki sayfa yoktur.

ListSpacesRequest

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

Alanlar
page_size

int32

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

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

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

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

page_token

string

İsteğe bağlıdır. Önceki bir alan listeleme ç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 iletmek beklenmedik sonuçlara yol açabilir.

filter

string

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

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

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

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

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

Geçersiz sorgular, 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

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

MarkAsActiveRequest

MarkAsActive yöntemi için istek mesajı.

Alanlar
name

string

Zorunlu. Etkin olarak işaretlenecek müsaitlik durumunun kaynak adı. Biçim: users/{user}/availability

{user}, People API veya Admin SDK Directory API'deki kişinin kimliğidir. Örneğin, users/123456789.

Kullanıcının e-posta adresi veya me, arayan kişiyi belirtmek için takma ad olarak da kullanılabilir. Örneğin, users/user@example.com veya users/me

expiration birleşik alanı. ETKİN kullanılabilirlik durumunun sona erme tarihi. Süre dolduktan sonra kullanıcı "Uzakta" olarak işaretlenir. Geçerlilik bitiş tarihi belirtilmezse ETKİN durumunun geçerliliği, geçerli zamandan 30 dakika sonra sona erer. expiration aşağıdakilerden yalnızca biri olabilir:
expire_time

Timestamp

ACTIVE durumunun süresinin dolduğu mutlak zaman damgası.

ttl

Duration

Şu andan ACTIVE durumunun sona ermesine kadar geçen süre. Kısa bir TTL kullanmak, kullanıcının durumunu bu kısa süreden sonraki etkinliğe göre etkili bir şekilde sıfırlayabilir.

MarkAsAwayRequest

MarkAsAway yöntemi için istek mesajı.

Alanlar
name

string

Zorunlu. Dışarıda olarak işaretlenecek müsaitlik durumunun kaynak adı. Biçim: users/{user}/availability

{user}, People API veya Admin SDK Directory API'deki kişinin kimliğidir. Örneğin, users/123456789.

Kullanıcının e-posta adresi veya me, arayan kişiyi belirtmek için takma ad olarak da kullanılabilir. Örneğin, users/user@example.com veya users/me

MarkAsDoNotDisturbRequest

MarkAsDoNotDisturb yöntemi için istek mesajı.

Alanlar
name

string

Zorunlu. "Rahatsız Etmeyin" olarak işaretlenecek müsaitlik durumunun kaynak adı. Biçim: users/{user}/availability

{user}, People API veya Admin SDK Directory API'deki kişinin kimliğidir. Örneğin, users/123456789.

Kullanıcının e-posta adresi veya me, arayan kişiyi belirtmek için takma ad olarak da kullanılabilir. Örneğin, users/user@example.com veya users/me

expiration birleşik alanı. Zorunlu. Rahatsız Etmeyin (DND) kullanılabilirlik durumunun sona erme zamanı. Süre dolduktan sonra kullanıcı "Uzakta" olarak işaretlenir. Bu süre, geçerli zamandan itibaren en fazla 1 yıl olabilir. expiration aşağıdakilerden yalnızca biri olabilir:
expire_time

Timestamp

Rahatsız Etmeyin durumunun sona erdiği mutlak zaman damgası.

ttl

Duration

Şu andan itibaren Rahatsız Etmeyin durumunun sona ereceği zamana kadar geçen süre.

MarkupSyntax

Sohbet mesajı metnini biçimlendirmek için kullanılan işaretleme söz dizimini belirtir. Message kaynağının text alanı için geçerlidir.

Sıralamalar
MARKUP_SYNTAX_UNSPECIFIED Belirtilmemiş değeri temsil eder.
MARKUP_SYNTAX_CHAT Google Chat'in işaretleme söz dizimini kullanır. Daha fazla bilgi için https://developers.google.com/workspace/chat/format-messages#format-texts adresini ziyaret edin.
MARKUP_SYNTAX_MARKDOWN Markdown söz dizimini kullanır. Bu söz dizimi, ek uzantılarla birlikte CommonMark spesifikasyonunu temel alır. Daha fazla bilgi için https://developers.google.com/workspace/chat/format-messages#format-texts adresini ziyaret edin.

MatchedUrl

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

MeetSpaceLinkData

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

Alanlar
meeting_code

string

Bağlı Meet alanının toplantı kodu.

type

Type

Meet alanının türünü belirtir.

huddle_status

HuddleStatus

İsteğe bağlıdır. Yalnızca çıkış. Meet bir Hızlı Toplantı ise hızlı toplantının durumunu gösterir. Aksi takdirde bu ayar yapılmaz.

HuddleStatus

Hızlı toplantının durumu

Sıralamalar
HUDDLE_STATUS_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
STARTED Hızlı toplantı başladı.
ENDED Hızlı toplantı sona erdi. Bu durumda Meet alanı URI'si ve tanımlayıcıları artık geçerli olmaz.
MISSED Hızlı toplantıya yetişemediniz. Bu durumda Meet alanı URI'si ve tanımlayıcıları artık geçerli olmaz.

Tür

Meet alanının türü.

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
MEETING Meet alanı bir toplantıdır.
HUDDLE Meet alanı bir hızlı toplantıdır.

Üyelik

Google Chat'teki bir üyelik ilişkisini (ör. bir kullanıcının veya Chat uygulamasının bir alana davet edilip edilmediği, alanın bir parçası olup olmadığı ya da alanda bulunup bulunmadığı) 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ıdır. Kullanıcının Chat alanındaki rolü, alanda izin verilen işlemlerini belirler.

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

create_time

Timestamp

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

delete_time

Timestamp

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

affiliation

Affiliation

Yalnızca çıkış. Kullanıcının, alanın sahibi olan Workspace kuruluşuyla ilişkisi. Tüketici hesaplarına ait alanlarda tüm üyelerin ilişkilendirmesi EXTERNAL şeklindedir.

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

User

İsteğe bağlıdır. Üyeliğin karşılık geldiği Google Chat kullanıcısı veya uygulaması. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa çıkış, yalnızca alanın üyesi olan veya arayan kullanıcıyla önceden bir yakınlığı (ör. doğrudan mesaj (DM) görüşmesi) olan hem dahili hem de harici kullanıcılar için user name ve type alanlarını doldurur.

group_member

Group

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

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

İlişkilendirme

Kullanıcının, alanın sahibi olan Google Workspace kuruluşuyla olan ilişkisini temsil eder. Bu enum'a gelecekte daha fazla değer eklenebilir.

Sıralamalar
AFFILIATION_UNSPECIFIED Varsayılan değer. Bu değer kullanılmıyor.
INTERNAL Alanın sahibi olan Google Workspace kuruluşu tarafından yönetilen bir hesap.
EXTERNAL Alanın sahibi olan Google Workspace kuruluşunun dışındaki bir hesap (ör. tüketici hesabı veya farklı bir Workspace kuruluşu tarafından yönetilen bir hesap).
MANAGED_EXTERNAL Alanın sahibi olan Workspace kuruluşu tarafından yönetilen ancak kuruluş dışından bir kullanıcı (ör. misafir kullanıcı) için temel hazırlığı yapılan hesaplar. Davetliler hakkında daha fazla bilgi edinmek için https://support.google.com/chat/answer/16997417 adresini ziyaret edin.

MembershipRole

Kullanıcının bir 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 rol her zaman atanır (gelecekte başka enum değerleri kullanılabilir).
ROLE_MEMBER

Alanın bir üyesi. Chat kullanıcı arayüzünde bu rol, Üye olarak adlandırılır.

Kullanıcı, alana mesaj gönderme gibi temel izinlere sahiptir. Yöneticiler ve sahipler, üyelere bir alanda aşağıdakiler gibi ek izinler verebilir:

  • Üye ekleme veya kaldırma
  • Alan ayrıntılarını değiştirme
  • Geçmişi etkinleştirme veya devre dışı bırakma
  • @all ile alandaki herkesten bahsedin.
  • Alanda yüklü Chat uygulamalarını ve webhook'ları yönetme

Doğrudan mesajlarda ve adsız grup görüşmelerinde herkes bu role sahiptir.

ROLE_MANAGER

Alan sahibi. Chat kullanıcı arayüzünde bu role "Sahip" adı verilir.

Kullanıcı, alanı yönetmek için gereken tüm alan izinlerine sahiptir. Bu izinler arasında şunlar yer alır:

  • Alandaki diğer üyelerin rolünü üye, yönetici veya sahip olarak değiştirme
  • Alanı silme

Yalnızca SpaceType.SPACE (adlandırılmış alanlar) içinde desteklenir.

Daha fazla bilgi için Alan sahibi veya yöneticisi rolünüz hakkında daha fazla bilgi başlıklı makaleyi inceleyin.

ROLE_ASSISTANT_MANAGER

Alan yöneticisi. Chat kullanıcı arayüzünde bu rol, Yönetici olarak adlandırılır.

Kullanıcı, ROLE_MEMBER ile ilgili tüm temel izinlere sahiptir ve bir sahip tarafından yönetici izinlerinin bir alt kümesi verilebilir. Varsayılan olarak yöneticiler, aşağıdakiler hariç olmak üzere bir sahibin tüm izinlerine sahiptir:

  • Alanı silme
  • Başka bir alan üyesini sahip yapma
  • Bir sahibin rolünü değiştirme

Varsayılan olarak yöneticilerin izinleri aşağıdakileri kapsar ancak bunlarla sınırlı değildir:

  • Başka bir üyeyi yönetici yapma
  • Alandaki mesajları silme
  • Alan izinlerini yönetme
  • Yöneticinin alan ayarlarında "üyeleri yönetme" izni varsa alana katılma istekleriyle ilgili bildirimler alır.
  • Alanı bulunabilir yapma

Yalnızca SpaceType.SPACE (adlandırılmış alanlar) içinde desteklenir.

Daha fazla bilgi için Alan ayarlarını yönetme başlıklı makaleyi inceleyin.

MembershipState

Üyenin bir alanla ilişkisini belirtir. Gelecekte diğer üyelik durumları da desteklenebilir.

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

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

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

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

Alanlar
memberships[]

MembershipDeletedEventData

Silinen üyeliklerin listesi.

MembershipBatchUpdatedEventData

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

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

Alanlar
memberships[]

MembershipUpdatedEventData

Güncellenen üyeliklerin listesi.

MembershipCreatedEventData

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

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

Alanlar
membership

Membership

Yeni üyelik.

MembershipDeletedEventData

Silinen bir ü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}

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

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

sender

User

Yalnızca çıkış. Mesajı oluşturan kullanıcı. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa çıkış, yalnızca alanın üyesi olan veya arayan kullanıcıyla önceden bir yakınlığı (ör. doğrudan mesaj (DM) görüşmesi) olan hem dahili hem de harici kullanıcılar için user name ve type alanlarını doldurur.

create_time

Timestamp

İsteğe bağlıdır. Değiştirilemez. Chat'te oluşturulan alanlar için mesajın oluşturulduğu zaman. Bu alan, içe aktarma modundaki alanlarda kullanıldığı durumlar dışında salt çıkış alanıdır.

İçe aktarma modu alanları için bu alanı, mesajın kaynakta oluşturulduğu geçmiş zaman damgasına ayarlayarak orijinal oluşturma zamanını koruyun.

last_update_time

Timestamp

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

delete_time

Timestamp

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

text

string

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

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

formatted_text

string

Yalnızca çıkış. Biçimlendirmeyi belirtmek için eklenen işaretlemelerle birlikte 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, sabit boşluklu, sabit boşluklu blok, madde işaretli liste ve blok alıntı için işaretleme söz dizimi.

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

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

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

  • Yıldız işareti (*) kullanarak liste öğelerine madde işareti ekleyin (ör. * item).

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

cards[]
(deprecated)

Card

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

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

cards_v2[]

CardWithId

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

Chat uygulamaları, uygulama kimlik doğrulaması ile kart oluşturabilir. Geliştirici Önizleme Programı kapsamında, Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa kart mesajları oluşturabilir. Chat uygulamanız Geliştirici Önizleme Programı'na dahil değilse kullanıcı kimlik doğrulaması içeren kartlar oluşturamaz.

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

Card Builder ile kart tasarlama ve önizleme

Kart Oluşturucu'yu açma

annotations[]

Annotation

Yalnızca çıkış. Ek açıklamalar, mesajın düz metin gövdesiyle veya start_index ve length değeri 0 olan Google Dokümanlar ya da E-Tablolar gibi Google Workspace kaynaklarına bağlantı veren çiplerle ilişkilendirilebilir.

thread

Thread

İletinin ait olduğu mesaj 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ın kimliği kullanıcı olarak doğrulanırsa çıkış yalnızca alanı name doldurur.

fallback_text

string

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

action_response

ActionResponse

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

argument_text

string

Yalnızca çıkış. Sohbet uygulamasıyla ilgili tüm bahsetmelerin kaldırıldığı, iletinin düz metin gövdesi.

slash_command

SlashCommand

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

attachment[]

Attachment

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

matched_url

MatchedUrl

Yalnızca çıkış. Sohbet mesajı text alanında, 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, yanıt dizisindeki bir yanıttır. false olduğunda mesaj, alanın üst düzey görüşmesinde bir mesaj dizisinin ilk mesajı veya mesaj dizili yanıtları olmayan bir mesaj olarak görünür.

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

silent

bool

Yalnızca çıkış. Bu mesajın sessiz olup olmadığı. Sessiz mesajlar, Chat'in alıcılar için push bildirimlerini bastırdığı mesajlardır.

client_assigned_message_id

string

İsteğe bağlıdır. Mesaj için özel bir kimlik. Bu alanı bir mesajı tanımlamak veya bir mesajı almak, silmek ya da güncellemek için 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 tepkisi özetlerinin listesi.

private_message_viewer

User

İsteğe bağlıdır. Değiştirilemez. Mesaj oluşturmak için giriş, aksi takdirde yalnızca çıkış. Mesajı görüntüleyebilen kullanıcı. Bu alan ayarlandığında mesaj gizli olur ve yalnızca belirtilen kullanıcı ile 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 Gizli mesaj gönderme başlıklı makaleyi inceleyin.

deletion_metadata

DeletionMetadata

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

quoted_message_metadata

QuotedMessageMetadata

İsteğe bağlıdır. Başka bir mesajın alıntı yaptığı mesajla ilgili bilgiler.

Mesaj oluştururken aynı ileti dizisindeki mesajlardan alıntı yapabilir veya yeni bir kök mesaj oluşturmak için kök mesajdan alıntı yapabilirsiniz. Ancak farklı bir mesaj dizisindeki mesaj yanıtını alıntılayamazsınız.

Bir mesajı güncellerken quotedMessageMetadata alanını ekleyemez veya değiştiremezsiniz ancak kaldırabilirsiniz.

Örnek kullanım için Başka bir mesajdan alıntı yapma bölümüne bakın.

attached_gifs[]

AttachedGif

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

accessory_widgets[]

AccessoryWidget

İsteğe bağlıdır. Mesajın alt kısmı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 kutusu içeren mesajlarda desteklenmez. Ayrıntılı bilgi için Mesajın alt kısmına etkileşimli widget'lar ekleme başlıklı makaleyi inceleyin.

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

elements

Elements

İsteğe bağlıdır. Öğeler, mesaj oluşturma sırasında sağlanan ve mesaj metninin belirli bölümleriyle ilişkili olabilen veya olmayabilen ek bileşenlerdir. Bunlar, yalnızca çıkış olan ve mesaj parçalarına veya mesaj metninin tamamına bağlı ek bilgiler sunan ek açıklamalardan farklıdır.

markup_syntax

MarkupSyntax

İsteğe bağlıdır. Sunucunun, mesajın text alanındaki içeriği nasıl yorumlayacağını belirtir.

MessageBatchCreatedEventData

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

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

Alanlar
messages[]

MessageCreatedEventData

Yeni mesajların listesi.

MessageBatchDeletedEventData

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

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

Alanlar
messages[]

MessageDeletedEventData

Silinen mesajların listesi.

MessageBatchUpdatedEventData

Güncellenen birden fazla mesaj 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 mesajın etkinlik yükü.

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

Alanlar
message

Message

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

MessagePin

Sohbet mesajındaki raptiye. Daha fazla bilgi için Mesaj sabitleme başlıklı makaleyi inceleyin.

Alanlar
name

string

Tanımlayıcı. Mesaj sabitlemenin kaynak adı. Biçim: spaces/{space}/messagePins/{message_pin} Kaynak kimliği bileşeni, mesajın kaynak kimliği bileşeniyle eşleşir. Örneğin, spaces/AAA/messages/bbb.ccc içeren bir mesaj, spaces/AAA/messagePins/bbb.ccc kaynak adına sahip mesaj sabitleme işlemine karşılık gelir.

message

string

Zorunlu. Değiştirilemez. Sabitlenen mesajın kaynak adı. Biçim: spaces/{space}/messages/{message}

MessageUpdatedEventData

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

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

Alanlar
message

Message

Güncellenen mesaj.

MoveSectionItemRequest

Bir bölüm öğesini bölümler arasında taşımak için istek mesajı.

Alanlar
name

string

Zorunlu. Taşınacak bölüm öğesinin kaynak adı.

Biçim: users/{user}/sections/{section}/items/{item}

target_section

string

Zorunlu. Bölüm öğesinin taşınacağı bölümün kaynak adı.

Biçim: users/{user}/sections/{section}

MoveSectionItemResponse

Bölüm öğesini taşımayla ilgili yanıt mesajı.

Alanlar
section_item

SectionItem

Güncellenen bölüm öğesi.

PositionSectionRequest

Bir bölümü konumlandırmak için istek mesajı.

Alanlar
name

string

Zorunlu. Konumlandırılacak bölümün kaynak adı.

Biçim: users/{user}/sections/{section}

position birleşik alanı. Zorunlu. Bölümün yeni konumu. position aşağıdakilerden yalnızca biri olabilir:
sort_order

int32

İsteğe bağlıdır. Bölümün, bölüm listesindeki mutlak konumu. Konum 0'dan büyük olmalıdır. Konum, bölüm sayısından büyükse bölüm, listenin sonuna eklenir. Bu işlem, bölümü belirtilen konuma ekler ve bu konumdaki orijinal bölümü ve altındaki bölümleri bir sonraki konuma kaydırır.

relative_position

Position

İsteğe bağlıdır. Bölümün, bölüm listesindeki göreli konumu.

Konum

Bölümün konumu.

Sıralamalar
POSITION_UNSPECIFIED Belirtilmemiş konum.
START Bölüm listesinin başlangıcı.
END Bölüm listesinin sonu.

PositionSectionResponse

Bir bölümü konumlandırmak için yanıt mesajı.

Alanlar
section

Section

Güncellenen bölüm.

QuotedMessageMetadata

Başka bir mesajın alıntı yaptığı mesajla ilgili bilgiler.

Bir mesajı güncellerken quotedMessageMetadata alanını ekleyemez veya değiştiremezsiniz ancak kaldırabilirsiniz.

Örnek kullanım için Başka bir mesajdan alıntı yapma bölümüne bakın.

Alanlar
name

string

Zorunlu. Alıntılanan mesajın kaynak adı.

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

last_update_time

Timestamp

Zorunlu. Alıntılanan mesajın oluşturulduğu veya son güncellendiği zaman damgası.

Mesaj düzenlendiyse last_update_time alanını kullanın. Mesaj hiç düzenlenmediyse create_time değerini kullanın.

last_update_time, alıntılanan mesajın en yeni sürümüyle eşleşmezse istek başarısız olur.

quote_type

QuoteType

İsteğe bağlıdır. Alıntı türünü belirtir. Ayarlanmazsa geriye dönük uyumluluk için mesaj okuma/yazma yolunda varsayılan olarak REPLY kullanılır.

quoted_message_snapshot

QuotedMessageSnapshot

Yalnızca çıkış. Alıntılanan mesajın içeriğinin anlık görüntüsü.

forwarded_metadata

ForwardedMetadata

Yalnızca çıkış. Alıntılanan mesajın kaynak alanıyla ilgili meta veriler. Yalnızca FORWARD teklif türü için doldurulur.

QuoteType

Alıntılanan mesajın alıntı türü.

Sıralamalar
QUOTE_TYPE_UNSPECIFIED Ayrıldı. Bu değer kullanılmıyor.
REPLY

quote_type, REPLY olduğunda şunları yapabilirsiniz:

  • Bir mesaj dizisinde yanıt veriyorsanız o mesaj dizisindeki başka bir mesajı alıntılayabilirsiniz.

  • Kök mesaj oluşturuyorsanız o alandaki başka bir kök mesajı alıntılayabilirsiniz.

FORWARD

quote_type, FORWARD olduğunda şunlardan alıntı yapabilirsiniz:

  • Farklı bir alandan mesaj.

  • Aynı alandaki farklı bir mesaj dizisinden gelen mesaj yanıtı.

QuotedMessageSnapshot

Alıntılama veya yönlendirme sırasında alıntılanan mesajın içeriğinin anlık görüntüsünü sağlar.

Alanlar
sender

string

Yalnızca çıkış. Alıntılanan mesajın yazarının adı. Hem YANITLA hem de YÖNLENDİR alıntı türleri için doldurulur.

text

string

Yalnızca çıkış. Alıntılanan mesajın metin içeriğinin anlık görüntüsü.

formatted_text

string

Yalnızca çıkış. Köprüler, özel emojiler, işaretleme vb. zengin biçimlendirmeyi desteklemek için eklenen işaretlemelerle birlikte alıntılanan text mesajını içerir. Yalnızca FORWARD alıntı türü için doldurulur.

annotations[]

Annotation

Yalnızca çıkış. Alıntılanan mesajın metin gövdesinden ayrıştırılan ek açıklamalar. Yalnızca FORWARD teklif türü için doldurulur.

attachments[]

Attachment

Yalnızca çıkış. Alıntılanan mesajın parçası olan ekler. Bunlar, alıntılanan mesajın ek meta verilerinin kopyalarıdır. Yalnızca FORWARD teklif türü için doldurulur.

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

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

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

Alanlar
reactions[]

ReactionDeletedEventData

Silinen tepkilerin listesi.

ReactionCreatedEventData

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

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

Alanlar
reaction

Reaction

Yeni tepki.

ReactionDeletedEventData

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

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

Alanlar
reaction

Reaction

Silinen tepki.

ReplaceMessageCardsRequest

ReplaceMessageCards API yöntemi için istek mesajı.

Alanlar
name

string

Zorunlu. Mesajın kaynak adı.

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

cards_v2[]

CardWithId

İsteğe bağlıdır. Mesaja dahil edilecek kart dizisi. Bu kartlar, mesajın mevcut kartlarının yerini alır. Boş bırakılırsa mesajda yer alan orijinal kartlar temizlenir.

ReplaceMessageCardsResponse

Bu türün alanı yok.

ReplaceMessageCards API için yanıt mesajı.

RichLinkMetadata

Bir kaynağa yönlendiren zengin bağlantı. Zengin bağlantılar, mesajın düz metin gövdesiyle ilişkilendirilebilir veya start_index ve length değeri 0 olan Google Dokümanlar ya da E-Tablolar gibi Google Workspace kaynaklarına bağlantı veren çipleri temsil edebilir.

Alanlar
uri

string

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

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

RichLinkType

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

Sıralamalar
DRIVE_FILE Google Drive zengin bağlantı türü.
CHAT_SPACE Chat alanı zengin bağlantı türü. Örneğin, alan akıllı çipi.
GMAIL_MESSAGE Gmail iletisi zengin bağlantı türü. Özellikle Chat'te paylaş'tan bir Gmail çipi. API, yalnızca GMAIL_MESSAGE zengin bağlantıları içeren mesajların okunmasını destekler.
MEET_SPACE Meet mesajı zengin bağlantı türü. Örneğin, Meet çipi.
CALENDAR_EVENT Takvim mesajı zengin bağlantı türü. Örneğin, Takvim çipi.

SearchMessageResult

Mesaj aramasından elde edilen tek bir sonuç öğesi.

Alanlar
message

Message

Eşleşen mesaj.

space_mute_setting

MuteSetting

Mesajın yayınlandığı alan için arayan kullanıcının ses kapatma ayarı. Arayan uygulama, alanın kullanıcı için sessize alınıp alınmadığına bağlı olarak mesajın nasıl işleneceğine karar vermek için bu bilgileri kullanabilir.

Yalnızca istek görünümü SEARCH_MESSAGES_VIEW_FULL ise ve çağrı kimlik bilgileri aşağıdaki yetkilendirme kapsamını içeriyorsa döndürülür:

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

bool

Eşleşen mesajın, arayan kullanıcı tarafından okunup okunmadığını gösterir.

Yalnızca istek görünümü SEARCH_MESSAGES_VIEW_FULL ise ve çağrı kimlik bilgileri aşağıdaki yetkilendirme kapsamlarından birini içeriyorsa döndürülür:

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

SearchMessagesRequest

Mesaj aramak için istek mesajı.

Alanlar
parent

string

Zorunlu. Arama yapılacak alanın kaynak adı.

Kullanıcının erişebildiği tüm alanlarda arama yapmak için bu alanı spaces/- olarak ayarlayın. parent için başka bir değer kullanılması INVALID_ARGUMENT hatasına neden olur.

Aramayı bir veya daha fazla alanla sınırlamak için filter içinde space.name veya space.display_name kullanın.

filter

string

Zorunlu. Arama sorgusu.

Sorgu, sonuçları filtrelemek için kullanılan bir veya daha fazla arama ağı anahtar kelimesi belirtebilir.

Sonuçları aşağıdaki mesaj alanlarını kullanarak da filtreleyebilirsiniz:

  • create_time: RFC-3339 biçiminde bir zaman damgası kabul eder ve desteklenen karşılaştırma operatörleri şunlardır: < ve >=.
  • sender.name: Gönderenin kaynak adı (users/{user}). Yalnızca = desteklenir. E-posta adresini {user} için takma ad olarak kullanabilirsiniz. Örneğin, users/example@gmail.com. Burada example@gmail.com, Google Chat kullanıcısının e-posta adresidir.
  • space.name: Mesajın yayınlandığı alanın kaynak adı. (spaces/{space}). Yalnızca = desteklenir. Bu filtre ayarlanmazsa arama, kullanıcının alan üyesi olarak erişebildiği tüm doğrudan mesajlarda ve alanlarda gerçekleştirilir.
  • space.display_name: : (içerir) operatörünü destekler ve alanları, görünen adlarının kısmi eşleşmesine göre filtreler. Sonuçlar, en iyi beş alan eşleşmesiyle sınırlıdır. Örneğin, space.display_name:Project, görünen adlarında "Proje" kelimesi bulunan ilk beş alandaki mesajları arar.
  • space.space_type: Alanın türü. Yalnızca = desteklenir. Örneğin, space.space_type="DIRECT_MESSAGE" yalnızca doğrudan mesajlardaki mesajları döndürür. Olası değerler DIRECT_MESSAGE, GROUP_CHAT ve SPACE'dir.
  • attachment: Eklerin varlığını kontrol etmek için :* (herhangi birine sahip) operatörünü destekler. attachment:* belirtilirse yalnızca en az bir eki olan iletiler döndürülür.
  • annotations.user_mentions.user.name: Bahsedilen kullanıcının kaynak adı (users/{user}). Yalnızca : (has) desteklenir. Örneğin: annotations.user_mentions.user.name:"users/1234567890", yalnızca belirtilen kullanıcıdan bahsedilen mesajları döndürür. Alternatif olarak, arayan kullanıcıdan bahseden mesajları filtrelemek için me takma adı kullanılabilir. Örneğin: annotations.user_mentions.user.name:users/me. E-posta adresini {user} için takma ad olarak da kullanabilirsiniz (ör. users/example@gmail.com).

Gelişmiş filtreleme için aşağıdaki işlevler de kullanılabilir:

  • has_link(): Yalnızca ileti metninde en az bir köprü bulunan iletileri döndürür.
  • is_unread(): Çağrıyı yapan kullanıcı tarafından okunan mesajları filtreler.

space.display_name veya space.space_type filtrelerini kullanmak için çağrı kimlik bilgilerinin aşağıdaki yetkilendirme kapsamlarından birini içermesi gerekir:

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

is_unread() filtresini kullanmak için çağrı kimlik bilgilerinin aşağıdaki yetkilendirme kapsamlarından birini içermesi gerekir:

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

Farklı alanlarda yalnızca AND operatörleri desteklenir. Geçerli bir örnek: sender.name = "users/1234567890" AND is_unread(). AND kelimesi isteğe bağlıdır ve atlanırsa ima edilir. Örneğin, sender.name = "users/1234567890" is_unread() geçerlidir ve önceki örnekle eşdeğerdir. sender.name = "users/1234567890" OR is_unread() geçersiz bir örnektir çünkü OR farklı alanlar arasında desteklenmez.

Aynı alanda:

  • create_time yalnızca AND değerini destekler ve yalnızca create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00" gibi bir aralığı temsil etmek için kullanılabilir.
  • sender.name yalnızca OR operatörünü destekler. Örneğin: sender.name = "users/1234567890" OR sender.name = "users/0987654321".
  • space.name yalnızca OR operatörünü destekler. Örneğin: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
  • space.display_name, AND ve OR operatörlerini destekler ancak ikisinin karışımını desteklemez. Örneğin: space.display_name:Project AND space.display_name:Tasks, görünen adlarında hem Project hem de Tasks bulunan alanlardaki mesajları döndürürken space.display_name:Project OR space.display_name:Tasks, görünen adlarında Project veya Tasks ya da her ikisi bulunan alanlardaki mesajları döndürür.
  • space.space_type yalnızca OR operatörünü destekler. Örneğin: space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT".
  • annotations.user_mentions.user.name, AND ve OR operatörlerini destekler ancak ikisinin karışımını desteklemez. Örneğin: annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" yalnızca her iki kullanıcıdan da bahseden mesajları döndürürken annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321", kullanıcılardan birinden veya her ikisinden de bahseden mesajları döndürür.

Aynı sorguda AND ve OR operatörlerini birleştirirken operatör önceliğini netleştirmek için parantez kullanılması gerekir. Örneğin: (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). Bunun dışında parantez kullanımı isteğe bağlıdır.

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

"Pending reports" AND create_time >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (create_time < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

Maksimum sorgu uzunluğu 1.000 karakterdir.

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

page_size

int32

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

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

Maksimum değer 100'dür. 100'den büyük bir değer kullanırsanız bu değer otomatik olarak 100'e değiştirilir.

page_token

string

İsteğe bağlıdır. Önceki mesaj arama çağrısından alınan 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 iletmek beklenmedik sonuçlara yol açabilir.

order_by

string

İsteğe bağlıdır. Sonuç listesinin nasıl sıralandığı.

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

  • create_time: Sonuçları mesajın oluşturulma zamanına göre sıralar. Varsayılan değer.
  • relevance: Sonuçları alaka düzeyine göre sıralar. ( Geliştirici Önizlemesi)

Varsayılan sıralama create_time desc şeklindedir. Sorgu başına yalnızca tek bir sıralama (create_time veya relevance) desteklenir. Yalnızca azalan sıralama (desc) desteklenir ve sıralama özelliğinden sonra belirtilmelidir.

markup_syntax

MarkupSyntax

İsteğe bağlıdır. Sohbet mesajı formatted_text alanı için istenen çıkış söz dizimini belirtir.

view

SearchMessagesView

İsteğe bağlıdır. Ne tür bir arama sonucu görünümünün döndürüleceğini belirtir. Varsayılan değer: SEARCH_MESSAGES_VIEW_BASIC.

SearchMessagesView

Kısmi arama sonuçları için desteklenen görünüm türleri.

Sıralamalar
SEARCH_MESSAGES_VIEW_UNSPECIFIED Varsayılan / ayarlanmamış değer. API, varsayılan olarak BASIC görünümüne ayarlanır.
SEARCH_MESSAGES_VIEW_BASIC Sonuçlarda yalnızca eşleşen mesajları içerir, ek meta veri içermez. Bu, varsayılan değerdir.
SEARCH_MESSAGES_VIEW_FULL Sonuçlardaki her şeyi içerir: eşleşen mesajlar ve ek meta veriler.

SearchMessagesResponse

Mesaj arama için yanıt mesajı.

Alanlar
results[]

SearchMessageResult

Sorguyla eşleşen arama sonuçlarının listesi.

next_page_token

string

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

SearchSpacesRequest

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

Alanlar
use_admin_access

bool

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

Arayan kullanıcı, 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.

page_size

int32

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

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

useAdminAccess, true olarak ayarlandığında maksimum değer 1.000'dir. Aksi takdirde maksimum değer 100'dür. Maksimum değerden daha yüksek bir değer kullanırsanız bu değer otomatik olarak maksimum değere değiştirilir.

page_token

string

Önceki alan arama çağrısından alınan 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 iletmek beklenmedik sonuçlara yol açabilir.

query

string

Zorunlu. Arama sorgusu.

useAdminAccess, true olarak ayarlandığında aşağıdaki parametreleri kullanarak arama yapabilirsiniz:

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

useAdminAccess, false olarak ayarlandığında:

  • display_name
  • external_user_allowed
  • space_type

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

useAdminAccess, true olarak ayarlandığında customer gereklidir ve alanların hangi müşteriden alınacağını belirtmek için kullanılır. Yalnızca customers/my_customer değeri desteklenir.

display_name yalnızca HAS (:) operatörünü kabul eder. Eşleştirilecek metin önce parçalara ayrılır ve her parça, alanın display_name içinde herhangi bir yerde alt dize olarak büyük/küçük harfe duyarlı olmadan ve bağımsız olarak önekle eşleştirilir. Örneğin, Fun Eve ifadesi Fun event veya The evening was fun ile eşleşir ancak notFun event veya even ile eşleşmez. useAdminAccess, false olarak ayarlandığında anlamlı sonuçlar elde etmek için display_name gereklidir. Aksi takdirde, varsayılan davranış boş bir yanıt döndürmektir.

external_user_allowed, true veya false değerini kabul eder.

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

space_type zorunludur ve geçerli tek değer SPACE değeridir.

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.

useAdminAccess, true olarak ayarlandığında 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")

useAdminAccess, false olarak ayarlandığında aşağıdaki örnek sorgular geçerlidir:

display_name:"Hello World" AND space_type = "SPACE"

(display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"

(external_user_allowed = "true" AND space_type = "SPACE") // Returns an
empty response.

(external_user_allowed = "true" AND display_name:"Hello" AND space_type =
"SPACE")

Maksimum sorgu uzunluğu 1.000 karakterdir.

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

order_by

string

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

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

  • membership_count.joined_direct_human_user_count: Bir alana doğrudan katılan gerçek kullanıcıların sayısını belirtir.
  • last_active_time: Son uygun öğenin bu alandaki herhangi bir konuya eklendiği zamanı belirtir.
  • create_time: Alanın oluşturulma zamanını belirtir.

useAdminAccess, false olduğunda sıralama için yalnızca create_time ve relevance desteklenir. Yönetici olmayan aramalarda bu alanlar için yalnızca DESC desteklenir.

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

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

  • Azalan sıralama için DESC.

useAdminAccess, true olarak ayarlandığında desteklenen söz dizimi ş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

useAdminAccess, false olarak ayarlandığında:

SearchSpacesResponse

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

Alanlar
spaces[]
(deprecated)

Space

Desteği sonlandırıldı: Lütfen bunun yerine yeni results alanını kullanın. İstenen alanların bir sayfası. Bu alan yalnızca useAdminAccess, true olarak ayarlandığında doldurulur ve yeni results alanı lehine kullanımdan kaldırılır.

next_page_token

string

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

Yalnızca useAdminAccess, true olarak ayarlandığında doldurulur.

total_size

int32

Tüm sayfalarda sorguyla eşleşen alanların toplam sayısı. Sonuç 10.000'den fazla alan ise bu değer bir tahmindir.

Yalnızca useAdminAccess, true olarak ayarlandığında doldurulur.

results[]

SearchSpaceResult

Yalnızca çıkış. Sorguyla eşleşen arama sonuçlarının listesi.

SearchSpaceResult

Alan aramasından tek bir sonuç öğesi.

Alanlar
space

Space

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

Bölüm

Google Chat'teki bir bölümü temsil eder. Bölümler, kullanıcıların alanlarını düzenlemesine yardımcı olur. İki tür bölüm vardır:

  1. Sistem bölümleri: Bunlar, Google Chat tarafından yönetilen önceden tanımlanmış bölümlerdir. Kaynak adları sabittir ve oluşturulamaz, silinemez veya display_name değerleri değiştirilemez. Örnekler:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps
  2. Özel bölümler: Kullanıcı tarafından oluşturulan ve yönetilen bölümlerdir. CreateSection kullanarak özel bölüm oluşturmak için display_name gerekir. Özel bölümler UpdateSection kullanılarak güncellenebilir ve DeleteSection kullanılarak silinebilir.

Alanlar
name

string

Tanımlayıcı. Bölümün kaynak adı.

Sistem bölümleri için bölüm kimliği sabit bir dizedir:

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

Biçim: users/{user}/sections/{section}

display_name

string

İsteğe bağlıdır. Bölümün görünen adı. Yalnızca CUSTOM_SECTION türündeki bölümler için doldurulur. En fazla 80 karakter desteklenir. CUSTOM_SECTION oluştururken zorunludur.

sort_order

int32

Yalnızca çıkış. Bölümün diğer bölümlere göre sırası. Daha düşük sort_order değerine sahip bölümler, daha yüksek değere sahip bölümlerden önce görünür.

type

SectionType

Zorunlu. Bölümün türü.

SectionType

Bölüm türleri.

Sıralamalar
SECTION_TYPE_UNSPECIFIED Belirtilmemiş bölüm türü.
CUSTOM_SECTION Özel bölüm.
DEFAULT_DIRECT_MESSAGES İki kullanıcı arasında DIRECT_MESSAGE veya herhangi bir özel bölüme ait olmayan GROUP_CHAT alanları içeren varsayılan bölüm.
DEFAULT_SPACES Herhangi bir özel bölüme ait olmayan varsayılan alanlar.
DEFAULT_APPS Kullanıcının yüklü uygulamalarını içeren varsayılan bölüm.

SectionItem

Kullanıcı tarafından tanımlanan bölüm öğesi. Bu, bir bölüm altında gruplandırılmış alanlar gibi bölüm öğelerini temsil etmek için kullanılır.

Alanlar
name

string

Tanımlayıcı. Bölüm öğesinin kaynak adı.

Biçim: users/{user}/sections/{section}/items/{item}

item birleşik alanı. Zorunlu. Bölüm öğesi. item aşağıdakilerden yalnızca biri olabilir:
space

string

İsteğe bağlıdır. Alan kaynağının adı.

Biçim: spaces/{space}

SetUpSpaceRequest

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

Alanlar
space

Space

Zorunlu. Space.spaceType alanı zorunludur.

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

Grup sohbeti oluşturmak için Space.spaceType değerini GROUP_CHAT olarak ayarlayın. Space.displayName ayarlanmasın.

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

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

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

request_id

string

İsteğe bağlıdır. Bu istek için benzersiz bir kimlik. Rastgele bir UUID önerilir. İstek kimliği belirtildiğinde istek, idempotent hale gelir. Bu sayede, aynı istek kimliğine sahip birden fazla aynı istek, yalnızca tek bir alanın oluşturulmasıyla sonuçlanır. Aynı istek kimliğine sahip sonraki istekler, istenen ayrıntılar mevcut durumdan farklı olsa bile mevcut alanı döndürür ve alanı güncellemez.

Bu alanı etkili bir şekilde kullanmak için:

  • Sonraki isteklerin aynı olduğundan ve orijinal istekle aynı kimlik doğrulama bilgilerini kullandığından emin olun.
  • Sağlanan istek kimliğiyle daha önce bir alan oluşturulmuşsa istek bu alanı döndürür. Döndürülen alanın tam olarak doldurulmayabileceğini unutmayın. API, isteğinizdeki alanı sistem tarafından atanan kaynak adıyla doldurur. Alanla ilgili en güncel meta verileri almak için GetSpace yöntemini çağırın.
  • Mevcut bir istek kimliğinin farklı bir kimliği doğrulanmış kullanıcıyla yeniden kullanılması hataya neden olur.
memberships[]

Membership

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

Grup şu anda en fazla 49 üyeliğe (arayan hariç) izin veriyor.

Kişi ü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. Alan oluştururken yalnızca gerçek kullanıcıları ekleyebilirsiniz (Chat uygulamaları yalnızca telefon 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 kullanıcının e-posta adresi {user} için kullanılmalıdır.

Google Grubu üyeliği için Membership.group_member alanında name değeri doldurulmuş bir group bulunmalıdır (biçim: groups/{group}). Google Grupları yalnızca Space.spaceType değeri SPACE olarak ayarlandığında ekleyebilirsiniz.

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

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

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

Bir kullanıcı ile çağrıyı yapan Chat uygulaması arasında bire bir görüşme oluşturulurken (Space.spaceType, DIRECT_MESSAGE ve Space.singleUserBotDm, true olarak ayarlanırken) boş olmalıdır.

SlashCommand

Google Chat'teki bir eğik çizgi komutu ile ilgili meta veriler.

Alanlar
command_id

int64

Eğik çizgi komutunun kimliği.

SlashCommandMetadata

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

Alanlar
bot

User

Komutu çağrılan Chat uygulaması.

type

Type

Eğik çizgi komutunun türü.

command_name

string

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

command_id

int64

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

triggers_dialog

bool

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

Tür

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

Boşluk

Google Chat alanları. 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}

{space}, alan için 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 türü.

space_type

SpaceType

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

single_user_bot_dm

bool

İsteğe bağlıdır. Alanın, bir Chat uygulaması ile tek bir kişi arasındaki DM olup olmadığı.

threaded
(deprecated)

bool

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceThreadingState kullanın. Bu alandaki mesajların ileti dizisi halinde olup olmadığı.

display_name

string

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

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

En fazla 128 karakter desteklenir.

external_user_allowed

bool

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

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

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

space_threading_state

SpaceThreadingState

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

space_details

SpaceDetails

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

space_history_state

HistoryState

İsteğe bağlıdır. Bu alandaki mesajların ve mesaj dizilerinin mesaj geçmişi durumu.

import_mode

bool

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

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

create_time

Timestamp

İsteğe bağlıdır. Değiştirilemez. Chat'te oluşturulan alanlar için alanın oluşturulduğu zaman. Bu alan, içe aktarma modundaki alanlarda kullanıldığı durumlar dışında salt çıkış alanıdır.

İçe aktarma modu alanları için bu alanı, alanın kaynakta oluşturulduğu geçmiş zaman damgasına ayarlayarak orijinal oluşturma zamanını koruyun.

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 bir Chat uygulamasıyla doğrudan mesaj yükleyebilir ve ayarlayabilir.

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

membership_count

MembershipCount

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

access_settings

AccessSettings

İsteğe bağlıdır. Alanı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şmek için kullanacağı URI.

import_mode_expire_time

Timestamp

Yalnızca çıkış. İçe aktarma modunda kalması durumunda 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 moduyla oluşturulan alanlar için doldurulur.

customer

string

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

customers/{customer} biçiminde. Burada customer, Admin SDK müşteri kaynağındaki id değeridir. Özel uygulamalar, uygulamayla aynı Google Workspace kuruluşunda alan oluşturmak için customers/my_customer takma adını da kullanabilir.

Bu alan, doğrudan mesajlar (DM'ler) için veya alan Google Workspace kullanıcısı olmayan kişiler tarafından oluşturulduğunda doldurulmaz.

space_permission_settings birleşik alanı. Bir alanın izin ayarlarını temsil eder. Yalnızca space_type, SPACE olduğunda doldurulur. space_permission_settings aşağıdakilerden yalnızca biri olabilir:
predefined_permission_settings

PredefinedPermissionSettings

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

Önceden tanımlanmış izin ayarlarını belirlemek şunları destekler:

permission_settings

PermissionSettings

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

İzin ayarlarını okuma ve güncelleme özelliği şunları destekler:

AccessPermissionSetting

Erişim izin seti ayarı.

Alanlar
principals[]

Principal

İsteğe bağlıdır. Sırasız liste. Bu izin için izin verilenler.

AccessPermissionSettings

Bir alanın izin ayarlarına erişme

Alanlar
discover_space_setting

AccessPermissionSetting

İsteğe bağlıdır. Alanı keşfetmek için erişim izni ayarı.

join_space_setting

AccessPermissionSetting

İsteğe bağlıdır. Alana katılmak için erişim izni ayarı.

view_space_membership_setting

AccessPermissionSetting

İsteğe bağlıdır. Alan üyeliğini görüntülemek için erişim izni ayarı. Alan üyeliğini kimlerin görüntüleyebileceği güncellenirken güncelleme maskesinde ve istek gövdesinde PermissionSettings.view_space_membership ile birlikte belirtilmelidir. Bir hedef kitleye görüntüleme erişimi verirken aynı istekte tüm üyelere PermissionSettings.view_space_membership de vermeniz gerekir. Mevcut bir hedef kitleyi kaldırmak için (ör. görüntüleme erişimini yalnızca alan yöneticileri veya yönetici yardımcılarıyla kısıtlamak için) boş bir AccessPermissionSetting (principals olmadan) belirtin.

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ıdır. Alanı keşfedebilen, alana katılabilen ve alandaki mesajları önizleyebilen hedef kitlenin kaynak adı. Bu ayar yapılmazsa alana yalnızca tek tek davet edilen veya eklenen kullanıcılar ya da Google Grupları erişebilir. Ayrıntılar için Alanları hedef kitle tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin.

Biçim: audiences/{audience}

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

Hedef kitleyi okuma şunları destekler:

Uygulama kimlik doğrulaması ile chat.bot kapsamı kullanılırken bu alan doldurulmaz.

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

access_permission_settings

AccessPermissionSettings

İsteğe bağlıdır. Alan için erişim izni ayarları.

Alan oluştururken hedef kitleyi ayarlamak için isteğinizde accessSettings.audience alanını belirtin.

AccessState

Alanın erişim durumunu temsil eder.

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

Alan yöneticisi, hedef kitleye alana erişim izni verdiğinde Alana tek tek eklenen veya davet edilen kullanıcılar ya da Google Grupları da alanı bulabilir ve alana 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 kategorilere göre gruplandırılmış üyelik sayısını temsil eder.

Alanlar
joined_direct_human_user_count

int32

Yalnızca çıkış. Katılan 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ış. Alana doğrudan katılan tüm grupların sayısı.

PermissionSetting

Bir alan izin ayarını temsil eder.

Alanlar
managers_allowed

bool

İsteğe bağlıdır. Alan sahiplerinin (ROLE_MANAGER) bu izne sahip olup olmadığı.

members_allowed

bool

İsteğe bağlıdır. Temel alan üyelerinin (ROLE_MEMBER) bu izne sahip olup olmadığı.

assistant_managers_allowed

bool

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

PermissionSettings

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

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

Alanlar
manage_members_and_groups

PermissionSetting

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

modify_space_details

PermissionSetting

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

toggle_history

PermissionSetting

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

use_at_mention_all

PermissionSetting

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

manage_apps

PermissionSetting

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

manage_webhooks

PermissionSetting

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

post_messages

PermissionSetting

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

reply_messages

PermissionSetting

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

view_space_membership

PermissionSetting

İsteğe bağlıdır. Alan üyeliğini görüntüleme ayarı. Alan üyeliğini kimlerin görüntüleyebileceği güncellenirken güncelleme maskesinde ve istek gövdesinde AccessPermissionSettings.view_space_membership_setting ile birlikte belirtilmelidir. Görüntüleme erişimini belirli rollerle (ör. yalnızca alan yöneticileri veya yönetici yardımcıları) kısıtlarken istediğiniz rol izinlerini burada belirtin ve aynı istekte boş bir AccessPermissionSettings.view_space_membership_setting sağlayın. AccessPermissionSettings.view_space_membership_setting içinde bir hedef kitle yapılandırılmışsa bu ayar tüm üyelere verilmelidir.

PredefinedPermissionSettings

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

Sıralamalar
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Belirtilmedi. Kullanmayın.
COLLABORATION_SPACE Alanı, tüm üyelerin mesaj gönderebileceği bir ortak çalışma alanı haline getirme ayarı.
ANNOUNCEMENT_SPACE Alanı, yalnızca alan yöneticilerinin mesaj yayınlayabileceği bir duyuru alanı haline getirme ayarı.

Ana hesap

Erişim izni verilen bir tüzel kişiyi temsil eden bir alt öğe.

Alanlar
principal_type birleşik alanı. Yetki verilen kişinin türü. principal_type aşağıdakilerden yalnızca biri olabilir:
audience

Audience

Kitle.

SpaceDetails

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

Alanlar
description

string

İsteğe bağlıdır. 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 4.096 karakter desteklenir.

guidelines

string

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

En fazla 5.000 karakter desteklenir.

SpaceThreadingState

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

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Ayrıldı.
THREADED_MESSAGES Mesaj dizilerini destekleyen alanlar. Kullanıcılar bir mesaja yanıt verirken ileti dizisi içinde yanıt verebilir. Bu sayede yanıtları orijinal mesajın 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

Mesaj dizilerini desteklemeyen alanlar. Bu alan mesaj dizisi oluşturma durumu yalnızca aşağıdaki gibi özel durumlarda kullanılır:

  • Mesaj dizilerinin kasıtlı olarak devre dışı bırakıldığı kesintisiz toplantı sohbeti.
  • 2022'den önce oluşturulan eski 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 Ayrıldı.
SPACE Kullanıcıların mesaj gönderdiği, dosya paylaştığı ve ortak çalıştığı yer. SPACE, Chat uygulamaları içerebilir.
GROUP_CHAT 3 veya daha fazla kişiyle yapılan grup görüşmeleri. GROUP_CHAT, Chat uygulamaları içerebilir.
DIRECT_MESSAGE İki kişi veya bir kişi ile Chat uygulaması arasındaki bire bir mesajlar.

Tür

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

Sıralamalar
TYPE_UNSPECIFIED Ayrıldı.
ROOM İki veya daha fazla kişi arasındaki görüşmeler.
DM Bir kullanıcı ile Chat uygulaması arasında, tüm mesajların düz olduğu bire bir doğrudan mesaj. İki kişi arasındaki doğrudan mesajların buna dahil olmadığını unutmayın.

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 etkinlik. Daha fazla bilgi edinmek için Google Chat'teki etkinliklerle çalışma başlıklı makaleyi inceleyin.

Alanlar
name

string

Alan etkinliğinin kaynak adı.

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

event_time

Timestamp

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

event_type

string

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

Mesajlar için desteklenen etkinlik türleri:

  • Yeni mesaj: google.workspace.chat.message.v1.created
  • Güncellenen mesaj: google.workspace.chat.message.v1.updated
  • Silinen mesaj: google.workspace.chat.message.v1.deleted
  • Birden fazla yeni mesaj: google.workspace.chat.message.v1.batchCreated
  • Birden fazla güncellenmiş mesaj: google.workspace.chat.message.v1.batchUpdated
  • Birden fazla silinen mesaj: 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 üyelik güncellendi: google.workspace.chat.membership.v1.batchUpdated
  • Birden fazla silinen üyelik: google.workspace.chat.membership.v1.batchDeleted

Tepkiler için desteklenen etkinlik türleri:

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

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

payload birleşik alanı.

payload aşağıdakilerden yalnızca 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 mesajın etkinlik yükü.

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

message_deleted_event_data

MessageDeletedEventData

Silinen bir mesajın 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

Güncellenen birden fazla mesaj için etkinlik yükü.

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

message_batch_deleted_event_data

MessageBatchDeletedEventData

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

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

space_updated_event_data

SpaceUpdatedEventData

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

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

space_batch_updated_event_data

SpaceBatchUpdatedEventData

Bir 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 bir ü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 bir ü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

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

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

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

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

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

reaction_created_event_data

ReactionCreatedEventData

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

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

reaction_deleted_event_data

ReactionDeletedEventData

Silinen bir tepki için 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

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

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

SpaceNotificationSetting

Bir alandaki kullanıcının bildirim ayarı.

Alanlar
name

string

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

notification_setting

NotificationSetting

Bildirim ayarı.

mute_setting

MuteSetting

Alan bildirimlerini sessize alma ayarı.

MuteSetting

Alan bildirimi kapatma ayarı türleri.

Sıralamalar
MUTE_SETTING_UNSPECIFIED Ayrıldı.
UNMUTED Kullanıcı, bildirim ayarına göre alanla ilgili bildirimler alır.
MUTED Kullanıcı, bildirim ayarından bağımsız olarak alanla ilgili bildirim almaz.

NotificationSetting

Bildirim ayarı türleri. Gelecekte diğer türler de desteklenebilir.

Sıralamalar
NOTIFICATION_SETTING_UNSPECIFIED Ayrıldı.
ALL Bildirimler; @bahsetmeler, takip edilen mesaj dizileri ve yeni mesaj dizilerinin ilk mesajı tarafından tetiklenir. Kullanıcı manuel olarak takibi bırakmadığı sürece tüm yeni mesaj dizileri otomatik olarak takip edilir.
MAIN_CONVERSATIONS Bildirim; @bahsetmeler, takip edilen mesaj dizileri ve yeni mesaj dizilerinin ilk mesajı tarafından 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

Kullanıcının bir alandaki okuma durumu. Okunan ve okunmayan mesajları belirlemek için kullanılır.

Alanlar
name

string

Alan okuma durumunun kaynak adı.

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

last_read_time

Timestamp

İsteğe bağlıdır. Kullanıcının alan okuma durumunun güncellendiği zaman. Bu genellikle son okunan mesajın zaman damgasına veya kullanıcının bir alandaki son okunan konumu işaretlemek için belirttiği zaman damgasına karşılık gelir.

SpaceUpdatedEventData

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

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

Alanlar
space

Space

Güncellenen alan.

SpaceView

Space kaynağında hangi alanların doldurulması gerektiğini belirten bir görünüm. Gelecekteki sürümlerle uyumluluğu sağlamak için kodunuzun ek değerleri hesaba katmasını öneririz.

Sıralamalar
SPACE_VIEW_UNSPECIFIED Varsayılan / ayarlanmamış değer.
SPACE_VIEW_RESOURCE_NAME_ONLY Yalnızca alan kaynağı adını doldurur.
SPACE_VIEW_EXPANDED Alan kaynağı alanlarını doldurur. Not: permissionSettings alanı doldurulmaz. SPACE_VIEW_EXPANDED değerini belirten istekler, alan verilerinin okunmasına izin veren kapsamları (ör. https://www.googleapis.com/auth/chat.spaces veya https://www.googleapis.com/auth/chat.spaces.readonly) içermelidir.

Mesaj dizisi

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

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

Alanlar
name

string

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

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

thread_key

string

İsteğe bağlıdır. 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, kimliği ayarlayan Chat uygulamasına özeldir. Örneğin, birden fazla Chat uygulaması aynı mesaj dizisi anahtarını kullanarak mesaj oluşturursa mesajlar farklı mesaj dizilerinde yayınlanır. Bir kullanıcı veya başka bir Chat uygulaması tarafından oluşturulan mesaj dizisini yanıtlamak için mesaj dizisi name alanını belirtin.

ThreadReadState

Kullanıcının bir ileti dizisindeki okuma durumu. Okunan ve okunmayan mesajları belirlemek için kullanılır.

Alanlar
name

string

Mesaj dizisi okuma durumunun kaynak adı.

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

last_read_time

Timestamp

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

UpdateAvailabilityRequest

UpdateAvailability yöntemi için istek mesajı.

Alanlar
availability

Availability

Zorunlu. Güncellenecek stok durumu.

update_mask

FieldMask

Zorunlu. Güncellenecek alanların listesi. Yalnızca custom_status alanı güncellenebilir.

UpdateMembershipRequest

Üyelik güncelleme isteği mesajı.

Alanlar
membership

Membership

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

update_mask

FieldMask

Zorunlu. Güncellenecek alan yolları. Birden 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ıdır. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

Arayan kullanıcı, 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ği.

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ıdır. true ise ve mesaj bulunamazsa yeni bir mesaj oluşturulur ve updateMask yoksayılır. Belirtilen mesaj kimliği istemci tarafından atanmış olmalıdır. Aksi takdirde istek başarısız olur.

UpdateSectionRequest

Bir bölümü güncellemek için istek mesajı.

Alanlar
section

Section

Zorunlu. Güncellenecek bölüm.

update_mask

FieldMask

Zorunlu. Hangi alanların güncelleneceğini belirten maske.

Şu anda desteklenen alan yolları:

  • display_name

UpdateSpaceNotificationSettingRequest

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

Alanlar
space_notification_setting

SpaceNotificationSetting

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

update_mask

FieldMask

Zorunlu. Desteklenen alan yolları:

  • notification_setting

  • mute_setting

UpdateSpaceReadStateRequest

UpdateSpaceReadState API için istek mesajı.

Alanlar
space_read_state

SpaceReadState

Zorunlu. Alan okuma durumu ve güncellenecek alanlar.

Yalnızca arayan kullanıcının okuma durumunun güncellenmesini destekler.

Arayan kullanıcıya atıfta bulunmak için aşağıdakilerden birini ayarlayın:

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

  • Kullanıcının Workspace e-posta adresi. Ö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şturulma zamanından önce olduğunda alan, kullanıcı arayüzünde okunmamış olarak görünür.

Alanı okundu olarak işaretlemek için last_read_time değerini, en son mesajın oluşturulma zamanından daha sonraki (daha büyük) bir değere ayarlayın. last_read_time, en son mesajın oluşturulma zamanıyla eşleşecek şekilde zorlanır. Alan okuma durumunun yalnızca alanın üst düzey görüşmesinde görünen mesajların okuma durumunu etkilediğini unutmayın. Mesaj dizilerindeki yanıtlar bu zaman damgasından etkilenmez ve bunun yerine mesaj dizisinin okundu durumunu temel alır.

UpdateSpaceRequest

Tek bir alanı güncelleme isteği.

Alanlar
space

Space

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

update_mask

FieldMask

Zorunlu. Güncellenen alan yolları (birden fazla varsa virgülle ayrılmış şekilde).

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

space_details: Alanın açıklamasını ve kurallarını günceller. Güncelleme isteğinde hem açıklamayı hem de kuralları SpaceDetails olarak iletmeniz gerekir. Alanlardan yalnızca birini güncellemek istiyorsanız diğer alan için mevcut değeri iletin.

display_name: Yalnızca spaceType alanının SPACE olduğu alanların görünen adının güncellenmesini destekler. ALREADY_EXISTS hata mesajını alırsanız farklı bir değer deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı 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 değerini ekleyin ve belirtilen alanın boş olmayan bir görünen adı ve SPACE alan türü olduğundan emin olun. Mevcut alanda SPACE türü zaten varsa görünen ad güncellenirken belirtilen alana space_type maskesinin ve SPACE türünün eklenmesi isteğe bağlıdır. Alan türünü başka yöntemlerle güncellemeye çalışırsanız geçersiz bağımsız değişken hatası alırsınız. space_type, useAdminAccess ile desteklenmiyor.

space_history_state: Alan için geçmişi etkinleştirerek veya devre dışı bırakarak alan geçmişi ayarlarını günceller. Yalnızca Google Workspace kuruluşu için geçmiş ayarları etkinleştirilmişse desteklenir. Alan geçmişi durumunu güncellemek için isteğinizdeki diğer tüm alan maskelerini çıkarmanız gerekir. space_history_state, useAdminAccess ile desteklenmiyor.

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

access_settings.access_permission_settings: spaceType alanının SPACE olduğu alanı kimlerin bulabileceğini ve alana kimlerin katılabileceğini belirleyen erişim izni ayarlarını günceller. Alana katılmasına izin verilen kullanıcıların alanı bulmasına da izin verilmelidir. Bir alanın erişim izni ayarlarını güncellemek için kimlik doğrulama yapan kullanıcının alan yöneticisi veya yönetici yardımcısı olması ve istekteki diğer tüm alan maskelerini atlaması 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.access_permission_settings, useAdminAccess ile desteklenmiyor. Desteklenen alan maskeleri şunlardır:

  • access_settings.access_permission_settings.discoverSpaceSetting
  • access_settings.access_permission_settings.joinSpaceSetting
  • access_settings.access_permission_settings.viewSpaceMembershipSetting

permission_settings: Bir alanın izin ayarlarını değiştirmeyi destekler. İzin ayarlarını güncellerken yalnızca permissionSettings alan maskelerini belirtebilirsiniz. Diğer alan maskelerini aynı anda güncelleyemezsiniz. 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
  • permission_settings.viewSpaceMembership
use_admin_access

bool

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

Arayan kullanıcı, 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ılar için update_mask açıklamasına bakın.

Kullanıcı

Google Chat'teki bir kullanıcı.

İstekten çıkış olarak döndürüldüğünde, Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa User kaynağının çıkışı (ör. Mesajlar ve Üyelikler API'lerinde), alanın üyesi olmadıkları veya arayan kullanıcıyla önceden yakınlıkları olmadığı sürece hem dahili hem de harici kullanıcılar için yalnızca name ve type alanlarını doldurur.

Alanlar
name

string

Google Chat user için kaynak adı.

Biçim: users/{user}. users/app, arama uygulaması bot kullanıcısı için takma ad olarak kullanılabilir.

human users için {user}, şu kullanıcı kimliğiyle aynı:

  • 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 bir kullanıcı için id.

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

display_name

string

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

Hem uygulama kimlik doğrulaması hem de kullanıcı kimlik doğrulaması için doldurulur. Bu alan, uygulama kimlik doğrulaması ile yapılan istekler için her zaman doldurulur. Messages ve Memberships API'leri kullanıcı kimlik doğrulaması ile çağrıldığında bu alan, kullanıcının alanın üyesi olması veya arayan kullanıcıyla önceden yakınlığı olması koşuluyla, bir mesajın sender, annotations içindeki kullanıcılar (ör. kullanıcıdan bahsetmeler) ve Membership kaynakları için hem dahili hem de harici kullanıcılar için doldurulur.

avatar_url

string

Yalnızca çıkış. Kullanıcının avatar resmi URL'si.

Messages ve Memberships API'leri kullanıcı kimlik doğrulaması ile çağrıldığında bu alan, kullanıcının alanın üyesi olması veya arayan kullanıcıyla önceden yakınlığı olması koşuluyla, bir mesajın sender, annotations içindeki kullanıcılar (ör. kullanıcıdan bahsetmeler) ve Membership kaynakları için hem dahili hem de harici kullanıcılar için doldurulur.

email

string

Yalnızca çıkış. Kullanıcının e-posta adresi.

Messages ve Memberships API'leri kullanıcı kimlik doğrulaması ile çağrıldığında bu alan, kullanıcının alanın üyesi olması veya arayan kullanıcıyla önceden yakınlığı olması koşuluyla, bir mesajın sender, annotations içindeki kullanıcılar (ör. kullanıcıdan bahsetmeler) ve Membership kaynakları için hem dahili hem de harici kullanıcılar için doldurulur.

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. Örneğin, bir kullanıcı üye olmadan ve arayan kullanıcıyla önceden yakınlığı olmadan bir alanda bahsedildiğinde bu durum geçerlidir.

Tür

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. DO NOT USE.
HUMAN Gerçek kişi.
BOT Chat uygulaması kullanıcısı.

UserMentionMetadata

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

Alanlar
user

User

Bahsedilen kullanıcı.

type

Type

Kullanıcıdan bahsetme türü.

Tür

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

WidgetMarkup

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

Alanlar
buttons[]

Button

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

data birleşik alanı. WidgetMarkup yalnızca aşağıdaki öğelerden birini içerebilir. Daha fazla öğe göstermek için birden fazla WidgetMarkup alanı kullanabilirsiniz. data aşağıdakilerden yalnızca 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

A düğmesi. Metin düğmesi veya resim düğmesi olabilir.

Alanlar

type birleşik alanı.

type aşağıdakilerden yalnızca 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ğinde gerçekleşen davranışı açıklar. Örneğin, formu işlemek için Apps Komut Dosyası'nı çağırabilirsiniz.

Alanlar
action_method_name

string

Yöntem adı, formun hangi bölümünün form gönderimini tetiklediğini belirlemek için kullanılır. Bu bilgiler, kart tıklama etkinliğinin bir parçası olarak Chat uygulamasına geri gönderilir. Ortak bir davranışı tetikleyen 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 olduğunu varsayalım: şimdi ertele, bir gün ertele, gelecek hafta ertele. Dize parametreleri listesinde erteleme türünü ve erteleme süresini ileterek action method = snooze() kullanabilirsiniz.

Alanlar
key

string

İşlem komut dosyasının parametre adı.

value

string

Parametrenin değeri.

Simge

Desteklenen simgeler.

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ızı sağlar. Resmin yerleşik en boy oranını geçersiz kılmak için kullanılmaz. Ayarlanmazsa sunucu, resmi önceden getirerek doldurur.

ImageButton

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

Alanlar
on_click

OnClick

onclick işlemi.

name

string

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

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

Icon

Chat API tarafından sağlanan bir simgeyi belirten enum ile tanımlanan simge.

icon_url

string

URL ile belirtilen simge.

KeyValue

Kullanıcı arayüzü öğesi 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ı olup olmayacağı.

bottom_label

string

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

on_click

OnClick

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

icons birleşik alanı. Simgelerden en az biri (top_label ve bottom_label) tanımlanmalıdır. icons aşağıdakilerden yalnızca 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.

control birleşik alanı. Kontrol widget'ı. button veya switch_widget değerlerinden birini ayarlayabilirsiniz ancak ikisini birden ayarlayamazsınız. control aşağıdakilerden yalnızca biri olabilir:
button

Button

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

OnClick

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

Alanlar

data birleşik alanı.

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

action

FormAction

Belirtilmişse bu onclick işlemi tarafından bir form işlemi tetiklenir.

TextButton

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

Alanlar
text

string

Düğmenin metni.

on_click

OnClick

Düğmenin onclick işlemi.

TextParagraph

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

Alanlar
text

string