Bu sayfada, Google Chat uygulamalarının ve geliştiricilerinin Chat kullanıcılarını nasıl tanımlayıp belirleyebileceği açıklanmaktadır.
Aşağıdakilerden herhangi birini yapmak için Chat uygulaması veya geliştiricisi bir kullanıcı belirtmelidir:
- Bir kullanıcıdan@ bahseden bir mesaj oluşturun.
- Bir kullanıcıyı mevcut bir alana davet edin veya ekleyin ya da bir kullanıcıyı yeni bir alana ekleyin.
- Chat uygulaması ile belirli bir kullanıcı veya iki kullanıcı arasındaki doğrudan mesajları bulabilirsiniz.
- Bir kullanıcının alandaki üyelik ayrıntılarını alma
- Kullanıcılara özel mesaj gönderme
- Google Workspace Events API'yi kullanarak bir kullanıcıya abone olun ve üyelik değişiklikleriyle ilgili etkinlikleri alın.
Chat, kullanıcıları nasıl tanımlar?
Google Chat API, Chat'i kullanan her kişi ve uygulama için bir User kaynağı oluşturur. User kaynağı aşağıdaki alanları içerir:
name:users/{user}olarak biçimlendirilmiş kaynak adı. Burada{user}benzersiz ve sabit bir tanımlayıcıyı temsil eder.users/appuygulamasını, arama için kullanılan Chat uygulamasının diğer adı olarak kullanabilirsiniz.displayName: Yalnızca çıkış. Kullanıcının görünen adı.avatarUrl: Yalnızca çıkış. Kullanıcının avatar resminin URL'si.email: Yalnızca çıkış. Kullanıcının e-posta adresi.domainId: Kullanıcının Google Workspace alanının benzersiz tanımlayıcısı.type: Kullanıcı türü. Kullanıcının bir sohbet uygulaması (BOT) mı yoksa bir kişi (HUMAN) mi olduğunu gösterir.isAnonymous: Yalnızca çıkış.truesimgesi, kullanıcının silindiğini veya profilinin görünür olmadığını gösterir.
Kullanıcı profili ayrıntıları ve görünürlük kuralları
Kullanıcı kimlik doğrulaması kullanılarak Mesajlar ve Üyelikler API'leri çağrıldığında Google Chat API, User kaynağını profil ayrıntılarıyla doldurur.
API, hem dahili kullanıcılar (Google Workspace kuruluşunuzdaki) hem de harici kullanıcılar (harici kuruluşlardaki veya kişisel Google Hesaplarındaki) için displayName, email ve avatarUrl değerlerini doldurur.
API'nin kullanıcı profillerini doldurduğu yerlere örnek olarak şunlar verilebilir:
Messageöğesininsender.- İleti
annotationsiçindeki kullanıcılar (ör. kullanıcı@mentions). Membershipkaynağındakimember.
Gizlilik ve görünürlük kuralları
Google Chat API, kullanıcı gizliliğini korumak için kullanıcının profil ayrıntılarının doldurulup doldurulmayacağını belirlerken belirli görünürlük kurallarını uygular:
- Doldurulmuş profil: Kullanıcı bir alan davetini kabul ettiyse (alanın üyesiyse) veya arayan kullanıcıyla daha önce etkileşimde bulunduysa (ör. doğrudan mesajlaşma etkileşimi geçmişi) API, profil ayrıntılarını (
displayName,emailveavatarUrlmevcutsa veisAnonymousfalseise) doldurur. - Anonim profil: Bir kullanıcı, üye olmadan ve arayan kullanıcıyla önceden bir yakınlığı olmadan bir alanda bahsedilirse profili anonim kalır. Anonim bir kullanıcı için
isAnonymous,trueolur vedisplayName,emailveavatarUrlgibi ayrıntılar atlanır. Ancak uygulama kimlik doğrulaması ile yapılan API isteklerindedisplayNamealanı her zaman doldurulur.
Aşağıdaki JSON örneğinde, bir API yanıtında veya etkileşim etkinliğinde döndürülen, profille ilgili ayrıntıların doldurulduğu bir User kaynağı gösterilmektedir:
{
"name": "users/12345678901234567890",
"displayName": "Sasha",
"domainId": "123abc",
"avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
"email": "sasha@example.com",
"type": "HUMAN",
"isAnonymous": false
}
Aşağıdaki JSON örneğinde, arayan kullanıcıya kullanıcı profili ayrıntılarının görünmediği anonim bir User kaynağı gösterilmektedir:
{
"name": "users/10987654321098765432",
"type": "HUMAN",
"isAnonymous": true
}
Google Chat API'ye yapılan bir çağrıda kullanıcı belirtme
Bir kullanıcıyı belirtmek için {user} değeri için aşağıdaki değerleri kullanın:
Google Workspace kuruluşunuzdaki kullanıcılar için aşağıdaki yaklaşımlardan birini kullanın:
- Chat API'deki
Userkaynağınınname, örneğinusers/123456789. - People API'deki
Personkaynağının adı için{person_id}. BuradaresourceName,people/{person_id}'dır. Örneğin, Chat API'dekiusers/123456789, People API'dekipeople/123456789ile aynı kişiyi temsil eder. - Directory API'deki
Userkaynağı içinid. Örneğin, Chat API'dekiusers/123456789, Directory API'dekiusers/123456789ile aynı kişiyi temsil eder. - Kullanıcı kimlik doğrulaması ile yapılan API istekleri için kullanıcının e-posta adresi, diğer ad olarak kullanılır. Örneğin,
users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com.
- Chat API'deki
Kuruluş dışındaki bir Google Workspace kuruluşunda bulunan veya Google Hesabı kullanan bir kullanıcı için aşağıdakilerden birini kullanın:
- E-posta takma adı (örneğin,
users/EMAIL_USERNAME@WORKSPACE_DOMAIN.comveyausers/EMAIL_USERNAME@gmail.com). - Önceki bir API çağrısından veya etkileşim etkinliğinden elde edilen
Userkaynağının standartname(ör.users/12345678901234567890).
- E-posta takma adı (örneğin,
API yanıtından veya etkileşim etkinliğinden kullanıcı tanımlama
API çağrılarından veya gelen etkinliklerden dönen kullanıcıları çeşitli şekillerde tanımlayabilirsiniz:
- Messages API: Gönderenin kimliğini
Message.senderveya bahsedilen kullanıcılarıMessage.annotations[].userMention.useradresinden alın. - Memberships API: Üyenin kimliğini
Membership.memberüzerinden alın. - Etkileşim etkinlikleri: Bir kullanıcı Chat uygulamasıyla etkileşimde bulunduğunda Chat,
Event.useriçinde kullanıcının kimliğiyle birlikte bir etkileşim etkinliği gönderir.
Google Chat API, kullanıcı kimlik doğrulaması kullanılırken hem kuruluş içi hem de kuruluş dışı kullanıcıların profillerini doldurduğu için geliştiricilerin, üyelerin ve mesaj gönderenlerin adlarını veya e-posta adreslerini çözümlemek için Directory API'yi çağırması gerekmez.
İlgili konular
- Google Chat kullanıcısı olarak kimliğinizi doğrulama ve yetkilendirme.
- Alana kullanıcı ekleme
- Bir alandaki üyeleri yönetme
- Bir iletide@ bahsetme özelliğini kullanarak bir kullanıcıdan bahsetme
Userresource REST API referansı.