Method: spaces.list

Arayanın üyesi olduğu alanları listeler. Grup sohbetleri ve DM'ler, ilk mesaj gönderilene kadar listelenmez. Örnek için Alanları listeleme bölümüne bakın.

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

Tüm adlandırılmış alanları Google Workspace kuruluşuna göre listelemek için Workspace yönetici ayrıcalıklarını kullanarak spaces.search() yöntemini kullanın.

HTTP isteği

GET https://chat.googleapis.com/v1/spaces

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

Sorgu parametreleri

Parametreler
pageSize

integer

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

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

Maksimum değer 1.000'dür. 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ı. Önceki bir listSpaces çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalandırma yaparken filtre değeri, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Farklı bir değer göndermek beklenmedik sonuçlara yol açabilir.

filter

string

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

Alanları alan türüne (spaceType) göre filtreleyebilirsiniz.

Alan türüne göre filtrelemek için SPACE veya GROUP_CHAT gibi geçerli bir enum değeri belirtmeniz gerekir (spaceType SPACE_TYPE_UNSPECIFIED olamaz). Birden fazla alan türü için sorgu yapmak istiyorsanız OR operatörünü kullanın.

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

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Alanları listeleme isteğinin yanıtı.

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

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

object (Space)

İstenen (veya ilk) sayfadaki alanların listesi. Not: permissionSettings alanı, liste istekleri için Alan nesnesinde döndürülmez.

nextPageToken

string

Sonuçların sonraki sayfasını almak için pageToken olarak bir jeton gönderebilirsiniz. Boşsa sonraki sayfa yoktur.

Yetkilendirme kapsamları

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

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.