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 ü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 yönetici ayrıcalıkları verir, useAdminAccess true olur ve aşağıdaki yetkilendirme kapsamlarından biri kullanılır:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

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 getirileceği alanın kaynak adı.

Biçim: spaces/{space}

Sorgu parametreleri

Parametreler
pageSize

integer

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

string

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

Sayfalama 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ıdır. 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.

useAdminAccess doğru olarak ayarlandığında member.type = "HUMAN" veya member.type != "BOT" gereklidir. Diğer üyelik 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.
showGroups

boolean

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

boolean

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

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

boolean

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

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

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Alan üyeliklerinin listesine yanıt verilir.

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