Method: spaces.members.list

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

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

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 listesinin alınacağı alanın kaynak adı.

Biçim: spaces/{space}

Sorgu parametreleri

Parametreler
pageSize

integer

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

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

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

Negatif değerler INVALID_ARGUMENT hatası döndürür.
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.

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

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

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

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

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

member.type != "BOT"

Aşağıdaki sorgular geçersiz:

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

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

boolean

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

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

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

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

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

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Alanın üyeliklerini listeleyen 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 bir sonraki sayfasını almak için pageToken olarak gönderebileceğiniz bir jeton. Boşsa sonraki 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ılavuzuna bakın.