Method: spaces.list

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

Kimlik doğrulama gerektirir. Hizmet hesabı kimlik doğrulamasını tam olarak destekler ve kullanıcı kimlik doğrulaması, chat.spaces veya chat.spaces.readonly yetkilendirme kapsamını gerektirir.

Arayan veya kimliği doğrulanmış kullanıcının görebileceği alanları listeler. Grup mesajları ve DM'ler, ilk mesaj gönderilene kadar listelenmez.

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 alan sayısı. Hizmet bu değerden daha düşük değer döndürebilir.

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

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

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

pageToken

string

İsteğe bağlı. Önceki liste alanları çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalara ayırma işlemi sırasında filtre değeri, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Farklı bir değer iletilmesi, beklenmeyen sonuçlara yol açabilir.

filter

string

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

Kullanıcı kimlik doğrulaması gerektirir.

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 belirtmelisiniz (spaceType değeri SPACE_TYPE_UNSPECIFIED olamaz). Birden fazla alan türünü sorgulamak için 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 sunucu tarafından INVALID_ARGUMENT hatasıyla reddedilir.

Hizmet hesabı kimlik doğrulaması ile bu alan yok sayılır ve sorgu her zaman tüm alanları döndürür. Ancak Chat API, sorgu söz dizimini hizmet hesaplarıyla doğrulamadan geçersiz sorgular yine de reddedilir.

İ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
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Alanlar
spaces[]

object (Space)

İstenen (veya ilk) sayfadaki alanların listesi.

nextPageToken

string

Sonraki sonuç sayfasını almak için bir jetonu pageToken olarak 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.