Method: spaces.members.list

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

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

HTTP isteği

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

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

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

Sorgu parametreleri

Parametreler
pageSize

integer

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

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

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

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

pageToken

string

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

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

filter

string

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

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

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

Türe göre filtrelemek için member.type değerini HUMAN veya BOT olarak ayarlayın. Geliştirici Önizlemesi: != operatörünü kullanarak member.type için de filtre uygulayabilirsiniz.

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

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

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

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

member.type != "BOT"

Şu sorgular geçersizdir:

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

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

showGroups

boolean

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

showInvited

boolean

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

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

useAdminAccess

boolean

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

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

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

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

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Alan üyeliklerini listeleme yanıtı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Alanlar
memberships[]

object (Membership)

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

nextPageToken

string

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

Yetkilendirme kapsamları

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

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

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