Method: spaces.messages.list

Engellenen üyeler ve alanlardan gelen mesajlar da dahil olmak üzere, arayanın üyesi olduğu bir alandaki mesajları listeler. Örneğin, İletileri listeleme başlıklı makaleyi inceleyin. Kullanıcı kimlik doğrulaması gerektirir.

HTTP isteği

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

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

Yol parametreleri

Parametreler
parent

string

Zorunlu. Mesajların listelendiği alanın kaynak adı.

Biçim: spaces/{space}

Sorgu parametreleri

Parametreler
pageSize

integer

Döndürülen maksimum ileti sayısı. Hizmet bu değerden daha az mesaj döndürebilir.

Belirtilmemesi halinde en fazla 25 sonuç 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

Önceki bir sorgudan devam ettiriliyorsa isteğe bağlıdır.

Önceki bir liste mesajı çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalara ayırma sırasında, sağlanan diğer tüm parametreler sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler iletilmesi, beklenmeyen sonuçlara yol açabilir.

filter

string

Sorgu filtresi.

İletileri tarihe (createTime) ve ileti dizisine (thread.name) göre filtreleyebilirsiniz.

İletileri oluşturuldukları tarihe göre filtrelemek için createTime değerini RFC-3339 biçiminde ve çift tırnak işaretiyle belirtin. Örneğin, "2023-04-21T11:30:00-04:00". Zaman damgasından sonra oluşturulan iletileri listelemek için > ve üzeri operatörlerini, zaman damgasından önce oluşturulan iletileri listelemek için ise < değerinden küçük operatörlerini kullanabilirsiniz. Bir zaman aralığı içindeki iletileri filtrelemek için iki zaman damgası arasında AND operatörünü kullanın.

Mesaj dizisine göre filtrelemek için thread.name biçimini spaces/{space}/threads/{thread} olarak belirtin. Sorgu başına yalnızca bir thread.name belirtebilirsiniz.

Hem ileti dizisine hem de tarihe göre filtrelemek için sorgunuzda AND operatörünü kullanın.

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

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

orderBy

string

Önceki bir sorgudan devam ettiriliyorsa isteğe bağlıdır.

Mesaj listesi nasıl sıralanır? Bir sıralama işlemine göre sipariş edilecek değeri belirtin. Geçerli sipariş işlemi değerleri aşağıdaki gibidir:

  • Artan ASC.

  • Azalan sırada DESC.

Varsayılan sıralama createTime ASC şeklindedir.

showDeleted

boolean

Silinen mesajların dahil edilip edilmeyeceğini belirtir. Silinen iletiler, silinmiş oldukları zamanı ve silmeleriyle ilgili meta verileri içerir ancak ileti içeriği kullanılamaz.

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

object (Message)

Mesaj 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.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

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