Package google.chat.v1

Dizin

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

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

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

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

Yetkilendirme kapsamları

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

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

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

CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Özel emoji oluşturur.

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

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

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

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

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

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

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Arama için Chat uygulaması, 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 etme politikası devre dışıysa bu üye davet edilir ve katılmadan önce alan davetini kabul etmesi gerekir. Aksi takdirde, üyelik oluşturulduğunda üye doğrudan belirtilen alana eklenir.

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

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

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

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

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

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

Örnek kullanım için bkz.:

Yetkilendirme kapsamları

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

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

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

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

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

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

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

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

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

Uygulama kimlik doğrulamasıyla gönderilen ileti

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

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

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

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

Yetkilendirme kapsamları

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

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

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

CreateMessagePin

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

Mesaj pimi 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ılavuzu'na bakın.

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ılavuzu'na bakın.

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ündeki 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ılavuzu'na bakın.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Alan oluşturur. Import mode içinde 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 biriyle 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ğrularken Chat uygulaması, alanın üyesi olarak eklenir. Ancak insan kimlik doğrulamasının aksine, Chat uygulaması alan yöneticisi olarak eklenmez. Varsayılan olarak, Chat uygulaması alandan tüm alan üyeleri tarafından kaldırılabilir. Uygulamayı alandan yalnızca alan yöneticilerinin kaldırmasına izin vermek için space.permission_settings.manage_apps seçeneğini managers_allowed olarak ayarlayın.

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

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

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

Yetkilendirme kapsamları

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

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

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

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

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

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

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

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

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

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

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

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

Yetkilendirme kapsamları

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

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

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

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

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

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

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

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

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

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

Yetkilendirme kapsamları

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

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

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

DeleteMessagePin

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

Mesaj sabitlemesini 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ılavuzu'na bakın.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

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

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

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

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

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

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

DeleteSection

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

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

Bölümde alan 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ılavuzu'na bakın.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

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

  • Yönetici onayı ve yetkilendirme kapsamıyla 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 biriyle kullanıcı kimlik doğrulaması:

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

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

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

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

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

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

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

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

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

Yetkilendirme kapsamları

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

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

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

FindGroupChats

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

spaceType == GROUP_CHAT ile başlayan, üyeliklerinde tam olarak arayan kullanıcıyı ve FindGroupChatsRequest.users içinde belirtilen kullanıcıları içeren tüm alanları döndürür. Yalnızca ileti dizisine katılan üyeler desteklenir. Örnek için Grup sohbetlerini bulma başlıklı makaleyi inceleyin.

Arayan kullanıcı bazı kullanıcıları engellerse veya bazı kullanıcılar tarafından engellenirse ve belirtilen kullanıcı grubunun tamamının bulunduğu 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ışı) üyeliklerini içermelidir. İnsan olmayan kullanıcılar içeren bir istek 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ılavuzu'na bakın.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

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

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

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

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

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

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

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

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

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

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

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

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

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

  • 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 biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında, 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ılavuzu'na bakın.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

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

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

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

    • https://www.googleapis.com/auth/chat.bot: Bu yetkilendirme kapsamı kullanılırken 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ıyla. Bu kimlik doğrulama kapsamı kullanılırken bu yöntem, bir alandaki herkese açık iletiyle ilgili ayrıntıları döndürür.
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

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

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

Yetkilendirme kapsamları

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

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

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

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Bir alanla ilgili ayrıntıları döndürür. Örnek için 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
    • https://www.googleapis.com/auth/chat.app.spaces Yönetici onayıyla
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında, 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ıyla ilgili sınırlamalar:

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

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

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

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

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

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

İstenen verilerin okunması için uygun bir yetkilendirme kapsamıyla aşağıdaki kimlik doğrulama türlerini destekler:

  • Aşağıdaki yetkilendirme kapsamlarından biriyle yönetici onayı içeren 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 biriyle 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

Etkinlik almak için kimliği doğrulanmış arayan, alanın üyesi olmalıdır.

Ö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ılavuzu'na bakın.

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

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

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

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

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

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

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

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

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

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

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

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

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

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

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

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

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

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

ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

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

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

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

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

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

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

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

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

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

  • 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 biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)
    • Kullanıcı kimlik doğrulaması, bir yönetici hesabı kimlik doğruladığında, 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ılavuzu'na bakın.

ListMessagePins

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

Bir alandaki mesaj sabitlemelerini listeler. Kullanıcılar, kolay erişim için alanlardaki önemli mesajları sabitleyebilir. Daha fazla bilgi için Google Chat'te bir görüşmeyi 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ılavuzu'na bakın.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Arayanın üyesi olduğu bir alandaki mesajları (engellenen üyelerden ve alanlardan gelen mesajlar dahil) listeler. 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ılırken yanıtta boş bir JSON nesnesi ({}) bulunur. Örnek için İletileri listeleme başlıklı makaleyi inceleyin.

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

  • Yetkilendirme kapsamı ile yönetici onayı içeren uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Bu kimlik doğrulama kapsamı kullanılırken bu yöntem yalnızca bir alandaki herkese açık mesajları döndürür. Özel mesajlar bu kapsamda değildir.
  • Aşağıdaki yetkilendirme kapsamlarından biriyle 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ılavuzu'na bakın.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

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

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

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

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

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

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

ListSectionItems

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

Bir bölümdeki öğeleri listeler.

Bölüm öğeleri yalnızca alan 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ılavuzu'na bakın.

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ılavuzu'na bakın.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

İstenen verilerin okunması için uygun bir yetkilendirme kapsamıyla aşağıdaki kimlik doğrulama türlerini destekler:

  • Aşağıdaki yetkilendirme kapsamlarından biriyle yönetici onayı içeren 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 biriyle 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, alanın üyesi olmalıdır.

Ö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ılavuzu'na bakın.

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

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

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

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

Yetkilendirme kapsamları

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

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

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

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ılavuzu'na bakın.

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ılavuzu'na bakın.

ReplaceMessageCards

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

Bir mesaja eklenen kartları değiştirir.

Bir Chat uygulaması, yalnızca mesajda kartlar varsa ve bu kartlar uygulama tarafından oluşturulmuşsa insan tarafından oluşturulan bir mesajdaki kartların yerini alabilir.

Uygulama, kartları boş bir liste ile değiştirirse kartlar kaldırılır. Kartlar kaldırıldıktan sonra uygulama, kartları mesaja tekrar 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ılavuzu'na bakın.

SearchMessages

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

Arayan kullanıcının erişimi olan Google Chat mesajlarını arar. Arama ölçütleriyle eşleşen iletilerin listesini döndürür.

Kullanıcının erişimi olan tüm alanlarda arama yapmak için parent seçeneğini spaces/- olarak ayarlayın. parent için başka bir değer kullanmak INVALID_ARGUMENT hatasına neden olur. Döndürülen iletilerin name alanı, iletinin bulunduğu belirli space'ı 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 iletileri listelemek için ListMessages simgesini kullanın.

  • Kimliği doğrulanmış kullanıcı tarafından görülebilen özel mesajlar.
  • Chat uygulamalarının alanlarda veya grup sohbetlerinde yayınladığı mesajlar
  • Chat uygulaması DM'lerindeki mesajlar
  • Engellenen kullanıcılardan gelen mesajlar
  • Arayanın yoksaydığı 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ılavuzu'na bakın.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Bir yöneticinin aramasına göre Google Workspace kuruluşundaki alanların listesini döndürür. İstek içinde use_admin_access değerini true olarak ayarlayın. Örnek için Alanları arama ve yönetme başlıklı makaleyi inceleyin.

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

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces
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ılavuzu'na bakın.

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

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

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

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

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

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

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

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

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

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

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

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

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

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

  • Yönetici onayı ve yetkilendirme kapsamıyla 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 biriyle kullanıcı kimlik doğrulaması:

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

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

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

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

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

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

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

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

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

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

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

Yetkilendirme kapsamları

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

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

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

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ılavuzu'na bakın.

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ı 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 biriyle kullanıcı kimlik doğrulaması:

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

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

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

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

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

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

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Alan bildirim ayarını günceller. Örnek için Arayanın alan 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ılavuzu'na bakın.

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

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

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

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

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

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

AccessoryWidget

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

Alanlar
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ı yapacağı veya yapılandıracağı URL. (Yalnızca REQUEST_CONFIG yanıt türleri için)

dialog_action

DialogAction

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

updated_widget

UpdatedWidget

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

ResponseType

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

Sıralamalar
TYPE_UNSPECIFIED NEW_MESSAGE olarak işlenen varsayılan tür.
NEW_MESSAGE Konuda yeni bir mesaj olarak yayınlama
UPDATE_MESSAGE Chat uygulamasının mesajını güncelleyin. Bu yalnızca, ileti gönderen türünün BOT olduğu bir CARD_CLICKED etkinliğinde izin verilir.
UPDATE_USER_MESSAGE_CARDS Kullanıcının mesajındaki kartları güncelleyin. Bu yalnızca, eşleşen URL'ye sahip bir MESSAGE etkinliğine veya mesaj gönderen türünün HUMAN olduğu bir CARD_CLICKED etkinliğine yanıt olarak izin verilir. Metin yoksayılır.
REQUEST_CONFIG Kullanıcıdan ek kimlik doğrulama veya yapılandırma yapmasını özel olarak 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ünde 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, 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 diyalog çağırma veya gönderme isteğinin durumunu gösterir.

Alanlar
status_code

Code

Durum kodu.

user_facing_message

string

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

Ek açıklama

Yalnızca çıkış. Açıklamalar, iletinin düz metin gövdesiyle veya start_index ve length ile 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.

Örnek düz metin e-posta mesajı:

Hello @FooBot how are you!"

İlgili ek açıklamaların meta verileri:

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

AnnotationType

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

length

int32

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

start_index

int32

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

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

UserMentionMetadata

Kullanıcı bahsetme meta verileri.

slash_command

SlashCommandMetadata

Eğik çizgi komutunun meta verileri.

custom_emoji_metadata

CustomEmojiMetadata

Özel emojinin meta verileri.

AnnotationType

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

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

AppCommandMetadata

Chat uygulaması komutu hakkındaki meta veriler.

Alanlar
app_command_id

int32

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

app_command_type

AppCommandType

Chat uygulaması komutunun türü.

AppCommandType

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

Sıralamalar
APP_COMMAND_TYPE_UNSPECIFIED Varsayılan değer. Belirtilmedi.
SLASH_COMMAND Eğik çizgi komutu. Kullanıcı, komutu Chat mesajı olarak gönderir.
QUICK_COMMAND Hızlı komut Kullanıcı, mesaj yanıt alanındaki Chat menüsünden komutu seçer.
MESSAGE_ACTION Önerilen 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ış. Eki bir kullanıcıya önizletmek için kullanılması gereken küçük resim URL'si. Sohbet uygulamaları, ek içeriğini indirmek için bu URL'yi kullanmamalıdır.

download_uri

string

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

source

Source

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

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

AttachmentDataRef

İsteğe bağlı. Ek verilerine yapılan bir 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 ekiyle ilgili bir referans. Bu alan, Google Drive API ile kullanılır.

Kaynak

Ekin kaynağı.

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

AttachmentDataRef

Ek verilerine yapılan bir referans.

Alanlar
resource_name

string

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

attachment_upload_token

string

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

CalendarEventLinkData

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

Alanlar
calendar_id

string

Bağlı takvimin takvim tanımlayıcısı.

event_id

string

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

CardWithId

Google Chat 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ının bir parçası değilse kullanıcı kimlik doğrulamasıyla kart oluşturamaz.

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

Kart Oluşturucu ile kart tasarlama ve önizleme

Kart Oluşturucu'yu açma

Alanlar
card_id

string

İleti birden fazla kart içeriyorsa zorunludur. Bir mesajdaki kart için benzersiz tanımlayıcı.

card

Card

Kart. Maksimum boyut 32 KB'tır.

ChatSpaceLinkData

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

Alanlar
space

string

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

Biçim: spaces/{space}

thread

string

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

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

message

string

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

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

CompleteImportSpaceRequest

Bir alanın içe aktarma işlemini tamamlamak için mesaj isteğinde bulunma.

Alanlar
name

string

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

Biçim: spaces/{space}

CompleteImportSpaceResponse

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

Alanlar
space

Space

İçe aktarma modundaki alan.

ContextualAddOnMarkup

Bu türde alan yok.

Geliştiricilerin bağlamsal bir eklentinin içeriğini belirtmesi için kullanılan işaretleme.

Kart

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

Alanlar
header

CardHeader

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

sections[]

Section

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

card_actions[]

CardAction

Bu kartın işlemleri.

name

string

Kartın adı.

CardAction

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

Google Chat uygulamaları tarafından desteklenmez.

Alanlar
action_label

string

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

on_click

OnClick

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

CardHeader

Alanlar
title

string

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

subtitle

string

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

image_style

ImageStyle

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

image_url

string

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

ImageStyle

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

Bölüm

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

Alanlar
header

string

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

widgets[]

WidgetMarkup

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

CreateCustomEmojiRequest

Özel emoji oluşturma isteği.

Alanlar
custom_emoji

CustomEmoji

Zorunlu. Oluşturulacak özel emoji.

CreateMembershipRequest

Üyelik oluşturma isteği mesajı.

Alanlar
parent

string

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

Biçim: spaces/{space}

membership

Membership

Zorunlu. Oluşturulacak üyelik ilişkisi.

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

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

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

  • Uygulama olarak kimlik doğrulaması yapılırken chat.app.memberships yetkilendirme kapsamı gerekir.

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

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

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

use_admin_access

bool

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

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

chat.admin.memberships OAuth 2.0 kapsamı gerektirir.

Yönetici erişimi kullanılarak uygulama üyelikleri oluşturulması veya yöneticinin Google Workspace kuruluşunun 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

İleti için bildirim türü seçenekleri.

Sıralamalar
NOTIFICATION_TYPE_NONE Varsayılan davranış. Bildirim davranışı, kullanıcının mesajı Chat kullanıcı arayüzünü kullanarak göndermesiyle aynıdır: Gönderene bildirim gönderilmez.
NOTIFICATION_TYPE_FORCE_NOTIFY

Alıcılara zorla bildirim gönderin. Bu işlem, kullanıcıların alan bildirim ayarlarını ve Chat'teki Rahatsız Etmeyin ayarlarını atlar. Bu seçenek, cihaz düzeyindeki Rahatsız Etmeyin ayarlarını atlamaz.

Uygulama kimlik doğrulaması gerektirir.

NOTIFICATION_TYPE_SILENT

Alıcılar Chat'te Rahatsız Etmeyin'i etkinleştirmiş veya alanı sessize almış gibi bildirimi sessize alın.

Uygulama kimlik doğrulaması gerektirir.

CreateMessagePinRequest

Mesaj pimi oluşturmak 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

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

request_id

string

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

message_reply_option

MessageReplyOption

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

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

message_id

string

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

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

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

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

create_message_notification_options

CreateMessageNotificationOptions

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

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

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

CreateReactionRequest

İletilere tepki oluşturur.

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 için istek 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 "true" olarak ayarlanmışsa kullanılabilir.

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

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

request_id

string

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

CustomEmoji

Özel emojiyi temsil eder.

Alanlar
name

string

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

Biçim: customEmojis/{customEmoji}

uid

string

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

emoji_name

string

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

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

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

Örnek: :valid-emoji-name:

temporary_image_uri

string

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

payload

CustomEmojiPayload

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

CustomEmojiPayload

Özel emoji için yük verileri.

Alanlar
file_content

bytes

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

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

filename

string

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

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

CustomEmojiMetadata

Özel emojiler için açıklama meta verileri.

Alanlar
custom_emoji

CustomEmoji

Özel emoji

DeleteCustomEmojiRequest

Özel bir emojinin silinmesi talebi.

Alanlar
name

string

Zorunlu. Silinecek özel emojinin kaynak adı.

Biçim: customEmojis/{customEmoji}

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

DeleteMembershipRequest

Bir alandaki üyeliğin silinmesini isteme

Alanlar
name

string

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

Bir kullanıcı üyeliği silinirken chat.memberships kapsamı kullanıcı kimlik doğrulaması ile veya chat.memberships.app kapsamı uygulama kimlik doğrulaması ve spaces/{space}/members/{member} biçimiyle gerekir. E-postayı {member} için takma ad olarak kullanabilirsiniz. Örneğin, spaces/{space}/members/example@gmail.com ifadesinde 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ı. true olduğunda yöntem, kullanıcının Google Workspace yönetici ayrıcalıkları kullanılarak çalıştırılır.

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

chat.admin.memberships OAuth 2.0 kapsamı gerektirir.

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

DeleteMessagePinRequest

Mesaj sabitleme işlemini silme isteği mesajı.

Alanlar
name

string

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

DeleteMessageRequest

Mesaj silme isteği

Alanlar
name

string

Zorunlu. İletinin kaynak adı.

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

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

force

bool

İsteğe bağlı. true olduğunda, bir mesajı sildiğinizde mesaj dizili 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ğrulama sırasında geçerlidir. Chat uygulaması olarak kimlik doğrulaması yapılırken herhangi bir etkisi yoktur.

DeleteReactionRequest

Mesajlara verilen tepkileri siler.

Alanlar
name

string

Zorunlu. Silinecek tepkinin adı.

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

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

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

chat.admin.delete OAuth 2.0 kapsamı gerektirir.

DeletionMetadata

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

Alanlar
deletion_type

DeletionType

Mesajı kimin sildiğini gösterir.

DeletionType

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

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

Dialog

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

Alanlar
body

Card

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

DialogAction

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

Alanlar
action_status

ActionStatus

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

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

Dialog

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

DriveDataRef

Drive eki verilerine referans.

Alanlar
drive_file_id

string

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

DriveLinkData

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

Alanlar
drive_data_ref

DriveDataRef

Google Drive dosyasına referans veren bir DriveDataRef.

mime_type

string

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

Emoji

Bir mesaja tepki olarak kullanılan emoji.

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

string

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

custom_emoji

CustomEmoji

Özel emoji

EmojiReactionSummary

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

Alanlar
emoji

Emoji

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

reaction_count

int32

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

FindDirectMessageRequest

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

Alanlar
name

string

Zorunlu. Doğrudan mesajı bulmak istediğiniz kullanıcının kaynak adı.

Biçim: users/{user}. Burada {user}, People API'deki kişinin id'si veya Directory API'deki kullanıcının id'sidir. Örneğin, People API profil kimliği 123456789 ise name olarak users/123456789 değerini kullanarak ilgili kişiye gönderilen doğrudan mesajı bulabilirsiniz. Kullanıcı olarak kimlik doğruladığınızda e-postayı {user} için takma ad olarak kullanabilirsiniz. Örneğin, users/example@gmail.com ifadesinde 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ı. Arayan kullanıcıyla grup sohbetindeki tüm gerçek kullanıcıların kaynak adları. İsteğe Chat uygulamaları dahil edilemez.

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

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 iki başka kullanıcıyla yapılan tüm grup sohbetlerini bulmak için People API profil kimlikleri 123456789 ve 987654321 ile users/123456789 ve users/987654321 kullanabilirsiniz. E-postayı {user} için takma ad olarak da kullanabilirsiniz. Örneğin, users/example@gmail.com ifadesinde example@gmail.com, Google Chat kullanıcısının e-posta adresidir.

page_size

int32

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

Belirtilmemesi halinde en fazla 10 boşluk 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ı. Grup sohbetlerini bulmak için önceki bir çağrıdan alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalama yapılırken sağlanan diğer tüm parametreler, 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 olur. SPACE_VIEW_EXPANDED 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.

FindGroupChatsResponse

Arayan kullanıcı ve istenen kullanıcıların bulunduğu grup sohbeti alanlarını içeren bir yanıt.

Alanlar
spaces[]

Space

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

next_page_token

string

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

ForwardedMetadata

Bir iletinin 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 doğrudan mesajın 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. "A Kullanıcısı"). GROUP_CHAT için, üyelerin adlarına göre oluşturulan ve içerik üretici dahil 5 kişiyle sınırlı bir addır (ör. "Kullanıcı A, Kullanıcı B").

GetAttachmentRequest

Ek alma isteğinde bulunma

Alanlar
name

string

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

GetCustomEmojiRequest

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

Alanlar
name

string

Zorunlu. Özel emojinin kaynak adı.

Biçim: customEmojis/{customEmoji}

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

GetMembershipRequest

Alana üye olma isteğinde bulunma

Alanlar
name

string

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

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

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

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

use_admin_access

bool

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

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

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

Yönetici erişimi kullanılırken alanda uygulama üyelikleri edinme desteklenmez.

GetMessageRequest

Mesaj alma isteği

Alanlar
name

string

Zorunlu. İletinin kaynak adı.

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

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

GetSpaceEventRequest

Alan etkinliği almak için mesaj isteği.

Alanlar
name

string

Zorunlu. Alan etkinliğinin kaynak adı.

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

GetSpaceNotificationSettingRequest

Alan bildirimi ayarını almak için mesaj isteğinde bulunun. Yalnızca arayan kullanıcının bildirim ayarını almayı destekler.

Alanlar
name

string

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

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

GetSpaceReadStateRequest

GetSpaceReadState API'si için istek mesajı.

Alanlar
name

string

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

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

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

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

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

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

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

GetSpaceRequest

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

Alanlar
name

string

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

Biçim: spaces/{space}

use_admin_access

bool

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

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

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

GetThreadReadStateRequest

GetThreadReadStateRequest API'si için istek mesajı.

Alanlar
name

string

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

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

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

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

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

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

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

Grup

Google Chat'te Google Grubu.

Alanlar
name

string

Google Grubu'nun kaynak adı.

Cloud Identity Groups API'deki bir grubu temsil eder.

Biçim: groups/{group}

HistoryState

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

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

ListCustomEmojisRequest

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

Alanlar
page_size

int32

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

page_token

string

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

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

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

filter

string

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

İçerik üreticiye göre filtrelemeyi destekler.

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

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

creator("users/me")

Geçersiz sorgular INVALID_ARGUMENT hatasıyla reddedilir.

ListCustomEmojisResponse

Özel emojileri listeleme yanıtı.

Alanlar
custom_emojis[]

CustomEmoji

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

next_page_token

string

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

ListMembershipsRequest

Listeleme üyelikleri için istek mesajı.

Alanlar
parent

string

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

Biçim: spaces/{space}

page_size

int32

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

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

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

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

page_token

string

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

Sayfalara ayırma işlemi 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ı. Sorgu filtresi.

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

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

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

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

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

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

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

member.type != "BOT"

Şu sorgular geçersiz:

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

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

show_groups

bool

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

show_invited

bool

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

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

use_admin_access

bool

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

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

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

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

ListMembershipsResponse

Alan üyeliklerinin listesine yanıt verilir.

Alanlar
memberships[]

Membership

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

next_page_token

string

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

ListMessagePinsRequest

Listeleme mesajı pinleri için istek mesajı.

Alanlar
parent

string

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

page_size

int32

İsteğe bağlı. Döndürülen maksimum mesaj sabitleme sayısı. Hizmet, bu değerden daha az ileti 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 olarak değiştirilir. Belirtilmezse en fazla 100 mesaj sabitleme döndürülür. Negatif değerler INVALID_ARGUMENT hatası döndürür.

page_token

string

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

Sayfalara ayırma işlemi 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

Listeleme mesajı iğneleri 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. İletilerin listeleneceği alanın kaynak adı.

Biçim: spaces/{space}

page_size

int32

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

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

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

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

page_token

string

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

Sayfalara ayırma işlemi 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ı. Sorgu filtresi.

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

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

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

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

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

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

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

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

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

thread.name = spaces/AAAAAAAAAAA/threads/123

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

order_by

string

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

  • Artan sıra için ASC.

  • DESC azalan için.

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

show_deleted

bool

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

ListMessagesResponse

Listeleme iletileri için yanıt iletisi.

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öndürülen maksimum tepki sayısı. Hizmet, bu değerden daha az tepki döndürebilir. Belirtilmediği takdirde varsayılan değer 25'tir. Maksimum değer 200'dür. 200'den yüksek değerler 200 olarak değiştirilir.

page_token

string

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

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

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

filter

string

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

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

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

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

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

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

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

Şu sorgular geçersiz:

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

Geçersiz sorgular INVALID_ARGUMENT hatasıyla reddedilir.

ListReactionsResponse

Tepkileri listeleme isteğine verilen yanıt.

Alanlar
reactions[]

Reaction

İstenen (veya ilk) sayfadaki tepkilerin listesi.

next_page_token

string

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

ListSectionItemsRequest

Listeleme bölümü öğeleri için istek mesajı.

Alanlar
parent

string

Zorunlu. Üst öğe, bu bölüm öğeleri koleksiyonuna sahip olan bölüm kaynak adıdır. Yalnızca arayan kullanıcı için liste bölümü öğelerini 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öndürülecek maksimum bölüm öğesi sayısı. Hizmet, bu değerden daha az sonuç döndürebilir.

Belirtilmemesi halinde 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 olarak değiştirilir.

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

page_token

string

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

Sayfalara ayırma işlemi yapılırken 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ı. 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

Listeleme bölümü öğeleri 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

Listeleme bölümleri 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ının listeleme bölümlerini destekler. Arayan kullanıcıya başvurmak için aşağıdakilerden birini ayarlayın:

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

  • Workspace e-posta adresleri Ö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öndürülecek maksimum bölüm sayısı. Hizmet, bu değerden daha az sonuç döndürebilir.

Belirtilmemişse 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 olarak değiştirilir.

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

page_token

string

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

Sayfalara ayırma işlemi yapılırken 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

Listeleme bölümleri için yanıt mesajı.

Alanlar
sections[]

Section

Belirtilen kullanıcının bölümleri.

next_page_token

string

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

ListSpaceEventsRequest

Listeleme alanı etkinlikleri için istek mesajı.

Alanlar
parent

string

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

Biçim: spaces/{space}.

page_size

int32

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

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

page_token

string

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

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

filter

string

Zorunlu. Sorgu filtresi.

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

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

  • start_time: Alan etkinliklerini listelemeye başlamak için kullanılan özel zaman damgası. 28 gün öncesine kadar olan etkinlikleri listeleyebilirsiniz. Belirtilmediyse son 28 gündeki alan etkinliklerini listeler.
  • end_time: Alan etkinliklerinin listelendiği son zaman damgası. Belirtilmediyse isteğin yapıldığı zamana kadar olan etkinlikleri listeler.

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

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

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

Şu sorgular geçersiz:

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

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

ListSpaceEventsResponse

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

Alanlar
space_events[]

SpaceEvent

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

next_page_token

string

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

ListSpacesRequest

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

Alanlar
page_size

int32

İsteğe bağlı. 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ı. Önceki bir list spaces çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

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

filter

string

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

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

Alan türüne göre filtrelemek için SPACE veya GROUP_CHAT gibi geçerli bir enum değeri belirtmeniz gerekir (space_type, SPACE_TYPE_UNSPECIFIED olamaz). Birden fazla alan türü için sorgu oluşturmak üzere 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: Liste istekleri için permissionSettings alanı, Space nesnesinde döndürülmez.

next_page_token

string

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

MatchedUrl

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

Alanlar
url

string

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

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ı. Yalnızca çıkış. Meet görüşmesi bir sohbet odası ise sohbet odasının durumunu gösterir. Aksi takdirde bu ayar kaldırılır.

HuddleStatus

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 Huddle sohbetine 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 sohbet odasıdır.

Üyelik

Google Chat'teki üyelik ilişkisini (ör. bir kullanıcının veya Chat uygulamasının bir alana davet edilip edilmediği, alanda bulunup bulunmadığı ya da alandan ayrılıp ayrılmadığı) gösterir.

Alanlar
name

string

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

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

state

MembershipState

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

role

MembershipRole

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

delete_time

Timestamp

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

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

User

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

group_member

Group

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

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

MembershipRole

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

Sıralamalar
MEMBERSHIP_ROLE_UNSPECIFIED Varsayılan değer. users için: Kullanıcı alanın üyesi değildir ancak davet edilebilir. Google Groups için: Bu rol her zaman atanır (gelecekte diğer enum değerleri kullanılabilir).
ROLE_MEMBER

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

Kullanıcı, alana mesaj gönderme gibi temel izinlere sahip olmalıdır. Yöneticiler ve sahipler, üyelere alanda aşağıdaki 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.
  • Alana yüklenen Chat uygulamalarını ve webhook'ları yönetebilirsiniz.

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

ROLE_MANAGER

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

Kullanıcı, alanı yönetmek için alan izinlerinin tamamına sahiptir. Bu izinler şunlardır:

  • Alandaki diğer üyelerin rollerini üye, yönetici veya sahip olarak değiştirme
  • Alanı silin.

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 Bu rol, Chat kullanıcı arayüzünde yönetici olarak adlandırılır.

Kullanıcı, ROLE_MEMBER ile ilgili tüm temel izinlere sahiptir ve bir sahip tarafından yönetim izinlerinin bir alt kümesi verilebilir. Varsayılan olarak, yöneticiler aşağıdakiler hariç sahiplerin yapabileceği tüm işlemleri yapabilir:

  • Alanı silin.
  • Başka bir alan üyesini sahip yapma
  • Sahibin rolünü değiştirme

Yöneticilerin izinleri varsayılan olarak aşağıdakileri içerir ancak bunlarla sınırlı değildir:

  • Başka bir üyeyi yönetici yapma.
  • Alandaki mesajları silme
  • Alan izinlerini yönetme
  • Yönetici, alan ayarlarında "Üyeleri yönet" iznine sahipse alana katılma istekleriyle ilgili bildirimler alma
  • Bir alanı herkese açık hâle getirme

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 alanla ilişkisini belirtir. Gelecekte diğer üye devletler de desteklenebilir.

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

MembershipBatchCreatedEventData

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

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

Alanlar
memberships[]

MembershipCreatedEventData

Yeni üyeliklerin listesi.

MembershipBatchDeletedEventData

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

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

Alanlar
memberships[]

MembershipDeletedEventData

Silinen üyeliklerin listesi.

MembershipBatchUpdatedEventData

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

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

Alanlar
memberships[]

MembershipUpdatedEventData

Güncellenen üyeliklerin listesi.

MembershipCreatedEventData

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

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

Alanlar
membership

Membership

Yeni üyelik.

MembershipDeletedEventData

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

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

Alanlar
membership

Membership

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

MembershipUpdatedEventData

Güncellenmiş üyelik için etkinlik yükü.

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

Alanlar
membership

Membership

Güncellenen üyelik.

Mesaj

Google Chat alanındaki bir mesaj.

Alanlar
name

string

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

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

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

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

sender

User

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

create_time

Timestamp

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

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

last_update_time

Timestamp

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

delete_time

Timestamp

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

text

string

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

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

formatted_text

string

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

  • Kalın, italik, üstü çizili, sabit genişlikli, sabit genişlikli blok, madde işaretli liste ve blok alıntı için biçimlendirme söz dizimi.

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

  • Biçimi <{url}|{rendered_text}> olan özel köprüler. Burada ilk dize URL, ikinci dize ise oluşturulan metindir (örneğin, <http://example.com|custom text>).

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

  • Madde işaretli liste öğeleri için yıldız işareti (*) kullanın. Örneğin, * item.

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

cards[]
(deprecated)

Card

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

Biçimlendirilmiş metinler, düğmeler ve tıklanabilir resimler gibi kullanıcı arayüzü öğelerini göstermek 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 olabilir.

cards_v2[]

CardWithId

İsteğe bağlı. Kartlar 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ının bir parçası değilse kullanıcı kimlik doğrulamasıyla kart oluşturamaz.

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

Kart Oluşturucu ile kart tasarlama ve önizleme

Kart Oluşturucu'yu açma

annotations[]

Annotation

Yalnızca çıkış. Açıklamalar, iletinin düz metin gövdesiyle veya start_index ve length ile 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 ileti dizisi. Kullanım örneği için Mesaj dizisi başlatma veya yanıtlama başlıklı makaleyi inceleyin.

space

Space

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

fallback_text

string

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

action_response

ActionResponse

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

argument_text

string

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

slash_command

SlashCommand

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

attachment[]

Attachment

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

matched_url

MatchedUrl

Yalnızca çıkış. Bağlantı önizleme kalıbıyla eşleşen bir URL, Sohbet mesajı text alanında yer almalıdır. 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 ileti, alandaki üst düzey görüşmede bir dizinin ilk iletisi veya dizili yanıt içermeyen bir ileti olarak görünür.

Alanda mesaj dizilerinde yanıtlama desteklenmiyorsa bu alan her zaman false olur.

silent

bool

Yalnızca çıkış. Bunun sessiz bir mesaj olup olmadığı. Sessiz mesajlar, Chat'in alıcılar için anlık bildirimleri bastırdığı mesajlardır.

client_assigned_message_id

string

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

emoji_reaction_summaries[]

EmojiReactionSummary

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

private_message_viewer

User

İsteğe bağlı. Değişmez. Mesaj oluşturmak için giriş, aksi takdirde yalnızca çıkış. Mesajı 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 Chat API'yi uygulama kimlik doğrulaması kullanarak çağırmalı ve aşağıdakileri atlamalısınız:

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

deletion_metadata

DeletionMetadata

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

quoted_message_metadata

QuotedMessageMetadata

İsteğe bağlı. Başka bir iletinin alıntıladığı iletiyle ilgili bilgiler.

Bir mesaj oluşturduğunuzda aynı ileti dizisindeki mesajları veya yeni bir kök mesaj oluşturmak için bir kök mesajı alıntılayabilirsiniz. Ancak farklı bir ileti dizisindeki mesaj yanıtlarını alıntılayamazsınız.

Bir mesajı güncellediğinizde quotedMessageMetadata alanını ekleyemez veya değiştiremezsiniz ancak kaldırabilirsiniz.

Kullanım örneği için Başka bir iletiyi alıntı yapma başlıklı makaleyi inceleyin.

attached_gifs[]

AttachedGif

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

accessory_widgets[]

AccessoryWidget

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

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

MessageBatchCreatedEventData

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

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

Alanlar
messages[]

MessageCreatedEventData

Yeni mesajların listesi.

MessageBatchDeletedEventData

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

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

Alanlar
messages[]

MessageDeletedEventData

Silinen iletilerin listesi

MessageBatchUpdatedEventData

Birden fazla güncellenmiş 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 ileti için 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

Chat mesajına sabitlenen notlar. Daha fazla bilgi için İleti 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, iletinin kaynak kimliği bileşeniyle eşleşir. Örneğin, spaces/AAA/messages/bbb.ccc içeren bir mesaj, kaynak adı spaces/AAA/messagePins/bbb.ccc olan mesaj iğnesine karşılık gelir.

message

string

Zorunlu. Değişmez. Sabitlenen iletinin kaynak adı. Biçim: spaces/{space}/messages/{message}

MessageUpdatedEventData

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

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

Alanlar
message

Message

Güncellenen mesaj.

MoveSectionItemRequest

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şıma işlemine yönelik 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ı. Bölümün, bölümler listesindeki mutlak konumu. Pozisyon 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 o konumdaki orijinal bölümü ve altındaki bölümleri bir sonraki konuma kaydırır.

relative_position

Position

İsteğe bağlı. Bölümün, bölümler 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ırma için yanıt mesajı.

Alanlar
section

Section

Güncellenen bölüm.

QuotedMessageMetadata

Başka bir iletinin alıntıladığı iletiyle ilgili bilgiler.

Bir mesaj oluşturduğunuzda aynı ileti dizisindeki mesajları veya yeni bir kök mesaj oluşturmak için bir kök mesajı alıntılayabilirsiniz. Ancak farklı bir ileti dizisindeki mesaj yanıtlarını alıntılayamazsınız.

Bir mesajı güncellediğinizde quotedMessageMetadata alanını ekleyemez veya değiştiremezsiniz ancak kaldırabilirsiniz.

Kullanım örneği için Başka bir iletiyi alıntı yapma başlıklı makaleyi inceleyin.

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

Mesaj düzenlendiyse bu alanı (last_update_time) kullanın. Mesaj hiç düzenlenmediyse create_time simgesini kullanın.

last_update_time, alıntılanan mesajın en son sürümüyle eşleşmezse istek başarısız olur.

quote_type

QuoteType

İsteğe bağlı. Alıntı türünü belirtir. Ayarlanmazsa geriye dönük uyumluluk için ileti okuma/yazma yolunda varsayılan olarak YANIT 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ı hakkındaki meta veriler. Yalnızca FORWARD teklif türü için doldurulur.

QuoteType

Alıntılanan iletinin alıntı türü.

Sıralamalar
QUOTE_TYPE_UNSPECIFIED Rezervasyon yapıldı. Bu değer kullanılmıyor.
REPLY

quote_type değeri REPLY ise şunları yapabilirsiniz:

  • Bir ileti dizisinde yanıt veriyorsanız bu dizideki başka bir iletiyi alıntılayabilirsiniz.

  • Kök ileti oluşturuyorsanız söz konusu alandaki başka bir kök iletiyi alıntılayabilirsiniz.

Farklı bir ileti dizisindeki mesaj yanıtını alıntılayamazsınız.

QuotedMessageSnapshot

Alıntılanan iletinin içeriğinin, alıntılama veya yönlendirme sırasındaki anlık görüntüsünü sağlar.

Alanlar
sender

string

Yalnızca çıkış. Alıntılanan mesajın yazarının adı. REPLY (YANITLA) ve FORWARD (YÖNLENDİR) alıntı türleri için doldurulur.

text

string

Yalnızca çıkış. Alıntılanan iletinin metin içeriğinin anlık görüntüsü.

formatted_text

string

Yalnızca çıkış. Köprüler, özel emojiler, biçimlendirme vb. gibi zengin biçimlendirmeyi desteklemek için eklenen işaretlemelerle birlikte alıntılanan mesajı text içerir. Yalnızca YÖNLENDİRME alıntı türü için doldurulur.

annotations[]

Annotation

Yalnızca çıkış. Alıntılanan iletinin 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 iletinin ekleri. Bunlar, alıntılanan iletinin ek meta verilerinin kopyalarıdır. Yalnızca FORWARD teklif türü için doldurulur.

Tepki

Mesajlara tepki verme

Alanlar
name

string

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

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

user

User

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

emoji

Emoji

Zorunlu. Tepkide kullanılan emoji.

ReactionBatchCreatedEventData

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

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

Alanlar
reactions[]

ReactionCreatedEventData

Yeni tepkilerin listesi

ReactionBatchDeletedEventData

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

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

Alanlar
reactions[]

ReactionDeletedEventData

Silinen tepkilerin listesi.

ReactionCreatedEventData

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

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

Alanlar
reaction

Reaction

Yeni tepki.

ReactionDeletedEventData

Silinen bir tepkinin etkinlik yükü.

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

Alanlar
reaction

Reaction

Silinen tepki.

ReplaceMessageCardsRequest

ReplaceMessageCards API yöntemi için istek mesajı.

Alanlar
name

string

Zorunlu. İletinin kaynak adı.

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

cards_v2[]

CardWithId

İsteğe bağlı. Mesaja eklenecek kartlar dizisi. Bu kartlar, mesajın mevcut kartlarının yerini alır. Boşsa iletideki orijinal kartlar temizlenir.

ReplaceMessageCardsResponse

Bu türde alan yok.

ReplaceMessageCards API'nin yanıt mesajı.

RichLinkMetadata

Bir kaynağın zengin bağlantısı. Zengin bağlantılar, iletinin 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ğlanan ç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 gelen bir Gmail çipi. API yalnızca GMAIL_MESSAGE zengin bağlantıları içeren mesajların okunmasını destekler.
MEET_SPACE Meet mesajı rich link türü. Örneğin, Meet çipi.
CALENDAR_EVENT Takvim mesajı zengin bağlantı türü. Örneğin, Takvim çipi.

SearchMessageResult

Bir ileti aramasından elde edilen tek bir sonuç öğesi.

Alanlar
message

Message

Eşleşen ileti.

space_mute_setting

MuteSetting

Mesajın yayınlandığı alanda, arayan kullanıcının sessize alma 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ğıran 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ğıran kimlik bilgilerinde aşağıdaki yetkilendirme kapsamlarından biri varsa döndürülür:

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

SearchMessagesRequest

İletileri aramak için istek mesajı.

Alanlar
parent

string

Zorunlu. İçinde 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 kullanmak INVALID_ARGUMENT hatasına neden olur.

Aramayı bir veya daha fazla alanla sınırlamak için filter bölümünde space.name veya space.display_name simgesini kullanın.

filter

string

Zorunlu. Arama sorgusu

Sorgu, sonuçları filtrelemek için kullanılan bir veya daha fazla arama anahtar kelimesi belirtebilir.

Ayrıca, aşağıdaki ileti alanlarını kullanarak da sonuçları filtreleyebilirsiniz:

  • create_time: RFC-3339 biçiminde bir zaman damgasını 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-postayı {user} için takma ad olarak kullanabilirsiniz. Örneğin, users/example@gmail.com. Burada example@gmail.com, Google Chat kullanıcısının e-posta adresidir.
  • space.name: İletinin 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: space.display_name (var) operatörünü destekler ve boşlukları 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" kelimesini içeren ilk beş alandaki mesajları arar.
  • attachment: Eklerin varlığını kontrol etmek için :* (herhangi bir) operatörünü destekler. attachment:* belirtilirse yalnızca en az bir ek içeren 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 bahseden iletileri döndürür. Alternatif olarak, arayan kullanıcıdan bahseden iletileri filtrelemek için me takma adı kullanılabilir. Örneğin: annotations.user_mentions.user.name:users/me. Ayrıca, e-posta adresini {user} için takma ad olarak da kullanabilirsiniz. Örneğin, 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(): Arayan kullanıcı tarafından okunan mesajları filtreler.

space.display_name filtresinin kullanılması için çağırma 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() filtresinin kullanılması için çağırma 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 varsayılır. Örneğin, sender.name = "users/1234567890" is_unread() geçerlidir ve önceki örnekle aynıdır. OR farklı alanlar arasında desteklenmediğinden sender.name = "users/1234567890" OR is_unread() geçersiz bir örnektir.

Aynı alan içinde:

  • 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, hem Project hem de Tasks içeren görünen adlara sahip alanlardaki iletileri döndürürken space.display_name:Project OR space.display_name:Tasks, Project veya Tasks ya da her ikisini de içeren görünen adlara sahip alanlardaki iletileri döndürür.
  • 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" her iki kullanıcıdan birinden veya her ikisinden de bahseden mesajları döndürür.

Aynı sorguda AND ve OR operatörleri birleştirilirken 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(). Aksi takdirde parantez kullanmak 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öndürülecek maksimum sonuç sayısı. Hizmet, bu değerden daha az sonuç döndürebilir.

Belirtilmemesi halinde 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 olarak değiştirilir.

page_token

string

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

Sayfalara ayırma işlemi 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ı. Sonuç listesinin nasıl sıralandığı.

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

  • create_time: Sonuçları iletinin oluşturulma zamanına göre sıralar. Varsayılan değer.
  • relevance: Sonuçları alaka düzeyine göre sıralar.

Varsayılan sıralama create_time desc'dır. Sorgu başına (create_time veya relevance) yalnızca tek bir sipariş desteklenir. Yalnızca azalan sıra (desc) desteklenir ve sıra özelliğinden sonra belirtilmelidir.

view

SearchMessagesView

İsteğe bağlı. Ne tür arama sonuçları 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çlara yalnızca eşleşen mesajlar dahil edilir, ancak ek meta veri dahil edilmez. Bu, varsayılan değerdir.
SEARCH_MESSAGES_VIEW_FULL Sonuçlardaki her şeyi (eşleşen iletiler ve ek meta veriler) içerir.

SearchMessagesResponse

İletileri 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ı, Sohbet ve alan görüşmelerini yönetme ayrıcalığına sahip bir Google Workspace yöneticisi olmalıdır.

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

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

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.

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

page_token

string

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

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

query

string

Zorunlu. Arama sorgusu

Aşağıdaki parametreleri kullanarak arama yapabilirsiniz:

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

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

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

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

external_user_allowed, true veya false'yi kabul eder.

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

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

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

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

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

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

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

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

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

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

string

İsteğe bağlı. Alan listesinin nasıl sıralandığı.

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ı gösterir.
  • last_active_time: Bu alanın herhangi bir konusuna son uygun öğenin eklendiği zamanı gösterir.
  • create_time: Alanın oluşturulma zamanını gösterir.

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

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

  • DESC azalan için.

Desteklenen söz dizimleri şunlardır:

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

SearchSpacesResponse

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

Alanlar
spaces[]

Space

İstenen alanların sayfası.

next_page_token

string

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

total_size

int32

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

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ğ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 bir 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ı. Bölümün görünen adı. Yalnızca CUSTOM_SECTION türündeki bölümler için doldurulur. En fazla 80 karakteri destekler. CUSTOM_SECTION oluştururken gereklidir.

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 insan kullanıcı arasındaki DIRECT_MESSAGE veya herhangi bir özel bölüme ait olmayan GROUP_CHAT alanlarını 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ının tanımladığı 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ı. 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 ve Space.displayName değerini ayarlayın. Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

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

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

Bir insan ile arama 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 ayarlamayın.

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

request_id

string

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

memberships[]

Membership

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

Set şu anda arayan kişi dışında en fazla 49 üyeliğe izin veriyor.

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

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

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

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

Space.spaceType, bir kullanıcıyla birlikte tam olarak bir üyelik olacak şekilde DIRECT_MESSAGE olarak ayarlanırken gereklidir.

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

SlashCommand

Google Chat'teki eğik çizgi komutu hakkında meta veriler.

Alanlar
command_id

int64

Eğik çizgi komutunun kimliği.

SlashCommandMetadata

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

Alanlar
bot

User

Komutu çağrılan Chat uygulaması.

type

Type

Eğik çizgi komutunun türü.

command_name

string

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

command_id

int64

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

triggers_dialog

bool

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

Tür

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

Boşluk

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

Alanlar
name

string

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

Biçim: spaces/{space}

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

type
(deprecated)

Type

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

space_type

SpaceType

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

single_user_bot_dm

bool

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

threaded
(deprecated)

bool

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

display_name

string

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

Doğrudan mesajlarda bu alan boş olabilir.

En fazla 128 karakter desteklenir.

external_user_allowed

bool

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

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

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

space_threading_state

SpaceThreadingState

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

space_details

SpaceDetails

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

space_history_state

HistoryState

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

import_mode

bool

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

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

create_time

Timestamp

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

İçe aktarma modu alanları için bu alanı, orijinal oluşturma zamanını korumak amacıyla alandaki kaynağın oluşturulduğu tarihi zaman damgası olarak ayarlayın.

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

last_active_time

Timestamp

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

admin_installed

bool

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

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

membership_count

MembershipCount

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

access_settings

AccessSettings

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

space_uri

string

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

import_mode_expire_time

Timestamp

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

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

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

customer

string

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

customers/{customer} biçiminde. Burada customer, Admin SDK müşteri kaynağındaki id değeridir. Özel uygulamalar, alanı uygulama ile aynı Google Workspace kuruluşunda oluşturmak için customers/my_customer diğer adını da kullanabilir.

Bu alan, doğrudan mesajlar (DM) 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ı. Yalnızca giriş. Önceden tanımlanmış alan izni ayarları, yalnızca alan oluşturulurken girilir. Alan ayarlanmamışsa bir ortak çalışma alanı oluşturulur. Alanı oluşturduktan sonra ayarlar PermissionSettings alanına doldurulur.

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

permission_settings

PermissionSettings

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

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

AccessSettings

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

Alanlar
access_state

AccessState

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

audience

string

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

Biçim: audiences/{audience}

Google Workspace kuruluşunun varsayılan hedef kitlesini kullanmak için audiences/default olarak ayarlayın.

Hedef kitleyi okuma şu özellikleri destekler:

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

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

AccessState

Alan erişim durumunu gösterir.

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

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

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

MembershipCount

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

Alanlar
joined_direct_human_user_count

int32

Yalnızca çıkış. Katılan bir grupta üyeliği olduğu için 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

Alan izin ayarını temsil eder.

Alanlar
managers_allowed

bool

İsteğe bağlı. Alan sahiplerinin (ROLE_MANAGER) bu izne sahip olup olmadığı

members_allowed

bool

İsteğe bağlı. Temel alan üyelerinin (ROLE_MEMBER) bu izne sahip olup olmadığı.

assistant_managers_allowed

bool

İsteğe bağlı. 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 ayarlarını belirlemek için isteğinizde PredefinedPermissionSettings alanını belirtin.

Alanlar
manage_members_and_groups

PermissionSetting

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

modify_space_details

PermissionSetting

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

toggle_history

PermissionSetting

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

use_at_mention_all

PermissionSetting

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

manage_apps

PermissionSetting

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

manage_webhooks

PermissionSetting

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

post_messages

PermissionSetting

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

reply_messages

PermissionSetting

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

PredefinedPermissionSettings

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

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

SpaceDetails

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

Alanlar
description

string

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

En fazla 150 karakteri destekler.

guidelines

string

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

5.000 karaktere kadar destekler.

SpaceThreadingState

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

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Rezervasyon yapıldı.
THREADED_MESSAGES Mesaj dizilerini destekleyen alanlar Kullanıcılar bir iletiye yanıt verirken ileti dizisi içinde yanıtlayabilir. Bu sayede yanıtları orijinal iletinin bağlamında kalır.
GROUPED_MESSAGES Görüşmenin konuya göre düzenlendiği adlandırılmış alanlar. Konular ve yanıtları birlikte gruplandırılır.
UNTHREADED_MESSAGES

İleti dizisi görünümünü desteklemeyen alanlar Bu alan ileti dizisi durumu yalnızca aşağıdakiler gibi özel durumlarda kullanılır:

  • İş parçacığı oluşturmanın kasıtlı olarak devre dışı bırakıldığı kesintisiz toplantı sohbeti
  • 2022'den önce oluşturulan eski grup görüşmeleri.

SpaceType

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

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

Tür

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

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

SpaceBatchUpdatedEventData

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

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

Alanlar
spaces[]

SpaceUpdatedEventData

Güncellenen alanların listesi.

SpaceEvent

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

Alanlar
name

string

Alan etkinliğinin kaynak adı.

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

event_time

Timestamp

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

event_type

string

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

Mesajlar için desteklenen etkinlik türleri:

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

Üyelikler için desteklenen etkinlik türleri:

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

Tepkiler için desteklenen etkinlik türleri:

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

Alan hakkında desteklenen etkinlik türleri:

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

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

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

message_deleted_event_data

MessageDeletedEventData

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

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

message_batch_created_event_data

MessageBatchCreatedEventData

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

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

message_batch_updated_event_data

MessageBatchUpdatedEventData

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

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

message_batch_deleted_event_data

MessageBatchDeletedEventData

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

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

space_updated_event_data

SpaceUpdatedEventData

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

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

space_batch_updated_event_data

SpaceBatchUpdatedEventData

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

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

membership_created_event_data

MembershipCreatedEventData

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

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

membership_updated_event_data

MembershipUpdatedEventData

Güncellenmiş üyelik için etkinlik yükü.

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

membership_deleted_event_data

MembershipDeletedEventData

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

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

membership_batch_created_event_data

MembershipBatchCreatedEventData

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

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

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

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

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

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

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

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

reaction_created_event_data

ReactionCreatedEventData

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

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

reaction_deleted_event_data

ReactionDeletedEventData

Silinen bir tepkinin etkinlik yükü.

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

reaction_batch_created_event_data

ReactionBatchCreatedEventData

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

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

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

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

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

SpaceNotificationSetting

Bir alandaki kullanıcının bildirim ayarı.

Alanlar
name

string

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

notification_setting

NotificationSetting

Bildirim ayarı.

mute_setting

MuteSetting

Alan bildirimini kapatma ayarı.

MuteSetting

Alan bildirimlerini yoksayma ayarı türleri.

Sıralamalar
MUTE_SETTING_UNSPECIFIED Rezervasyon yapıldı.
UNMUTED Kullanıcı, bildirim ayarına göre alanla ilgili bildirimler alır.
MUTED Kullanıcı, bildirim ayarı ne olursa olsun alanla ilgili bildirim almaz.

NotificationSetting

Bildirim ayarı türleri. Gelecekte başka türler de desteklenebilir.

Sıralamalar
NOTIFICATION_SETTING_UNSPECIFIED Rezervasyon yapıldı.
ALL Bildirimler; @bahisler, takip edilen mesaj dizileri ve yeni dizilerdeki ilk mesaj tarafından tetiklenir. Kullanıcı tarafından manuel olarak takibi bırakılmadığı sürece tüm yeni ileti dizileri otomatik olarak takip edilir.
MAIN_CONVERSATIONS Bildirim; @bahisler, takip edilen mesaj dizileri ve yeni dizilerdeki ilk mesaj tarafından tetiklenir. Bire bir doğrudan mesajlarda kullanılamaz.
FOR_YOU Bildirim, @bahisler ve takip edilen mesaj dizileri tarafından tetiklenir. Bire bir doğrudan mesajlarda kullanılamaz.
OFF Bildirim kapalı.

SpaceReadState

Okunmuş ve okunmamış mesajları belirlemek için kullanılan, kullanıcının bir alandaki okuma durumu.

Alanlar
name

string

Alan okunma durumunun kaynak adı.

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

last_read_time

Timestamp

İsteğe bağlı. Kullanıcının alan okuma durumunun güncellendiği zaman. Bu genellikle son okunan mesajın zaman damgasına veya kullanıcının bir alanda son okunan konumu işaretlemek için belirttiği bir zaman damgasına karşılık gelir.

SpaceUpdatedEventData

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

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

Alanlar
space

Space

Güncellenen alan.

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

İplik

Google Chat alanındaki bir ileti dizisi. Kullanım örneği için Mesaj dizisi başlatma veya yanıtlama başlıklı makaleyi inceleyin.

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

Alanlar
name

string

Tanımlayıcı. İş parçacığının kaynak adı.

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

thread_key

string

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

Bu kimlik, onu ayarlayan Chat uygulamasına özeldir. Örneğin, birden fazla sohbet uygulaması aynı ileti dizisi anahtarını kullanarak ileti oluşturursa iletiler farklı ileti dizilerinde yayınlanır. Bir kişi veya başka bir Chat uygulaması tarafından oluşturulan mesaj dizisinde yanıtlamak için bunun yerine name mesaj dizisi alanını belirtin.

ThreadReadState

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

Alanlar
name

string

Okunan ileti dizisi durumunun kaynak adı.

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

last_read_time

Timestamp

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

UpdateMembershipRequest

Üyeliği güncelleme için istek mesajı.

Alanlar
membership

Membership

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

update_mask

FieldMask

Zorunlu. Güncellenecek alan yolları. Birden çok değeri virgülle ayırın veya tüm alan yollarını güncellemek için * simgesini kullanın.

Şu anda desteklenen alan yolları:

  • role
use_admin_access

bool

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

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

chat.admin.memberships OAuth 2.0 kapsamı gerektirir.

UpdateMessageRequest

Mesaj güncelleme isteğinde bulunma

Alanlar
message

Message

Zorunlu. Alanları güncellenmiş ileti.

update_mask

FieldMask

Zorunlu. Güncellenecek alan yolları. Birden çok değeri virgülle ayırın veya tüm alan yollarını güncellemek için * simgesini kullanın.

Şu anda desteklenen alan yolları:

allow_missing

bool

İsteğe bağlı. true ve ileti bulunamazsa yeni bir ileti oluşturulur ve updateMask yoksayılır. Belirtilen ileti kimliği istemci tarafından atanmış olmalıdır. Aksi takdirde istek başarısız olur.

UpdateSectionRequest

Bir bölümü güncelleme isteği mesajı.

Alanlar
section

Section

Zorunlu. Güncellenecek bölüm.

update_mask

FieldMask

Zorunlu. Hangi alanların güncelleneceğini belirtmek için kullanılan 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 okundu durumu ve güncellenecek alanlar.

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

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

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

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

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

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

update_mask

FieldMask

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

  • last_read_time

last_read_time, en son mesaj oluşturma zamanından önceyse alan, kullanıcı arayüzünde okunmamış olarak görünür.

Alanı okunmuş olarak işaretlemek için last_read_time değerini en son mesajın oluşturulma zamanından sonraki (daha büyük) bir değere ayarlayın. last_read_time, en son mesaj oluşturma zamanıyla eşleşecek şekilde zorlanır. Alan okunma durumunun yalnızca alanın üst düzey ileti dizisinde görünen mesajların okunma durumunu etkilediğini unutmayın. İleti dizilerindeki yanıtlar bu zaman damgasından etkilenmez ve bunun yerine ileti dizisinin okunma durumuna göre belirlenir.

UpdateSpaceRequest

Tek bir alanı güncelleme isteği.

Alanlar
space

Space

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

update_mask

FieldMask

Zorunlu. Güncellenen alan yolları (birden fazla varsa virgülle ayrılmış).

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

space_details: Alanın açıklamasını ve kurallarını günceller. Güncelleme isteğinde hem açıklamayı hem de yönergeleri SpaceDetails olarak iletmeniz gerekir. Yalnızca alanlardan birini güncellemek istiyorsanız diğer alanın mevcut değerini 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ı kullanıyor olabilir.

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

space_history_state: Alanın geçmişini açarak veya kapatarak alan geçmişi ayarlarını günceller. Yalnızca Google Workspace kuruluşu için geçmiş ayarları etkinse desteklenir. Alan geçmişi durumunu güncellemek için isteğinizdeki diğer tüm alan maskelerini atlamanız gerekir. space_history_state, useAdminAccess ile desteklenmez.

access_settings.audience: spaceType alanının SPACE olduğu adlandırılmış alanda, alanı kimlerin keşfedebileceği, alana kimlerin katılabileceği ve mesajları kimlerin önizleyebileceğiyle ilgili erişim ayarını günceller. Mevcut alanın hedef kitlesi varsa bu alan maskesi için bir değer atlamadan kitleyi kaldırabilir ve alan erişimini kısıtlayabilirsiniz. Bir alanın erişim ayarlarını güncellemek için kimliği doğrulanan kullanıcının alan yöneticisi olması ve isteğinizdeki diğer tüm alan maskelerini atlaması gerekir. Alan içe aktarma modundaysa bu alanı güncelleyemezsiniz. Daha fazla bilgi edinmek için Belirli kullanıcıların alanları bulmasını sağlama başlıklı makaleyi inceleyin. access_settings.audience, useAdminAccess ile desteklenmez.

permission_settings: Alanın izin ayarlarını değiştirmeyi destekler. İzin ayarlarını güncellerken yalnızca permissionSettings alan maskelerini belirtebilirsiniz. Diğer alan maskelerini aynı anda güncelleyemezsiniz. Desteklenen alan maskeleri şunlardır:

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

bool

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

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

chat.admin.spaces OAuth 2.0 kapsamı gerektirir.

Bazı FieldMask değerleri yönetici erişimi kullanılarak desteklenmez. Ayrıntılar için update_mask açıklamasını inceleyin.

Kullanıcı

Google Chat'teki bir kullanıcı. Bir istekten çıkış olarak döndürüldüğünde, Chat uygulamanız kullanıcı olarak kimlik doğrulaması yaparsa User kaynağının çıkışında yalnızca kullanıcının name ve type değerleri doldurulur.

Alanlar
name

string

Google Chat user için kaynak adı.

Biçim: users/{user}. users/app, arama uygulaması bot kullanıcısı için takma ad olarak kullanılabilir.

human users için {user}, aşağıdakiyle aynı kullanıcı tanımlayıcıdır:

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

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

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

display_name

string

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

domain_id

string

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

type

Type

Kullanıcı türü.

is_anonymous

bool

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

Tür

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

UserMentionMetadata

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

Alanlar
user

User

Bahsedilen kullanıcı.

type

Type

Kullanıcı bahsetme türü.

Tür

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

WidgetMarkup

Widget, metin ve resimleri gösteren bir kullanıcı arayüzü öğesidir.

Alanlar
buttons[]

Button

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

data birleşik alanı. Bir WidgetMarkup yalnızca aşağıdaki öğelerden birine sahip olabilir. Daha fazla öğe görüntülemek 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ğindeki 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 birkaç öğe için aynı yöntem adını kullanabilirsiniz.

parameters[]

ActionParameter

İşlem parametrelerinin listesi.

ActionParameter

İşlem yöntemi çağrıldığında sağlanacak dize parametrelerinin listesi. Örneğin, üç erteleme düğmesi olduğunu düşünelim: şimdi ertele, bir gün ertele, gelecek hafta ertele. Dize parametreleri listesinde erteleme türünü ve erteleme süresini ileterek action method = snooze() kullanabilirsiniz.

Alanlar
key

string

İşlem komut dosyasının parametresinin adı.

value

string

Parametrenin değeri.

Simge

Desteklenen simgeler kümesi.

Sıralamalar
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Resim

URL ile belirtilen ve onclick işlemi içerebilen bir resim.

Alanlar
image_url

string

Resmin URL'si.

on_click

OnClick

onclick işlemi.

aspect_ratio

double

Bu resmin en boy oranı (genişlik ve yükseklik). Bu alan, resmin yüklenmesini beklerken doğru yüksekliği ayırmanıza olanak tanır. Bu özellik, resmin yerleşik en boy oranını geçersiz kılmak için tasarlanmamıştır. Ayarlanmamışsa sunucu, resmi önceden getirerek bu alanı doldurur.

ImageButton

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

Alanlar
on_click

OnClick

onclick işlemi.

name

string

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

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 simgeye indekslenen enum ile belirtilen simge.

icon_url

string

URL ile belirtilen simge.

KeyValue

Bir kullanıcı arayüzü öğesi, anahtar (etiket) ve değer (içerik) içerir. Bu öğe, onclick düğmesi gibi bazı işlemleri de içerebilir.

Alanlar
top_label

string

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

content

string

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

content_multiline

bool

İçeriğin çok satırlı olup olmadığı.

bottom_label

string

Alt etiketin metni. Biçimlendirilmiş metin desteklenir. Metni biçimlendirme hakkında daha fazla bilgi için Google Chat uygulamalarında metni biçimlendirme ve Google Workspace eklentilerinde metni 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, top_label ve bottom_label özelliklerinden en az biri 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ğerini 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

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

Alanlar

data birleşik alanı.

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

action

FormAction

Belirtilmişse bu onclick işlemiyle bir form işlemi tetiklenir.

TextButton

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

Alanlar
text

string

Düğmenin metni.

on_click

OnClick

Düğmenin onclick işlemi.

TextParagraph

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

Alanlar
text

string