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ı ile listeleme üyelikleri, Chat uygulamasının erişebildiği alanlardaki üyelikleri listeler ancak kendininkiler dahil olmak üzere Chat uygulaması üyeliklerini hariç tutar. Kullanıcı kimlik doğrulaması ile listeleme üyelikleri, kimliği doğrulanan kullanıcının erişebildiği alanlardaki üyelikleri listeler.

Kimlik doğrulama gerektirir. Uygulama kimlik doğrulaması 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şluklar/{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 sonuç döndürebilir.

Belirtilmemesi durumunda 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.

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 tüm diğer parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler geçirmek beklenmedik sonuçlara yol açabilir.

filter

string

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

Üyelikleri üyelerin 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.

Role ve 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.

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

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

Şu sorgular geçersiz:

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 döndürür. 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ürlerinin yanı sıra invited üyeleriyle ilişkili üyelikleri de döndürür. Filtre ayarlanırsa filtre ölçütleriyle eşleşmeyen invited üyelikler döndürülmez.

Şu an için kullanıcı kimlik doğrulaması gereklidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

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) sayfada üyeliklerin listesi.

nextPageToken

string

Bir sonraki sonuç sayfasını almak için pageToken olarak gönderebileceğiniz bir jeton. Boş bırakılırsa sonraki sayfa yoktur.

Yetkilendirme kapsamları

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

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