Method: spaces.messages.list

Arayanın üyesi olduğu bir alandaki mesajları (engellenen üyelerden ve alanlardan gelen mesajlar dahil) listeler. Mesaj içermeyen bir alandaki mesajları listelerseniz yanıt boş bir nesne olur. REST/HTTP arayüzü kullanıldığında yanıt, {} adlı boş bir JSON nesnesi içerir. Örnek için Mesajları listeleme bölümüne bakın.

Kullanıcı kimlik doğrulaması gerekir.

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

Biçim: spaces/{space}

Sorgu parametreleri

Parametreler
pageSize

integer

İsteğe bağlı. Döndürülen maksimum mesaj sayısı. Hizmet, bu değerden daha az ileti döndürebilir.

Belirtilmemesi durumunda en fazla 25 öğe 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 list mesajları çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalandırma 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 göndermek beklenmedik sonuçlara neden olabilir.

filter

string

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

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

İletileri oluşturuldukları tarihe göre filtrelemek için createTime öğesini RFC-3339 biçiminde bir zaman damgasıyla ve çift tırnak içinde belirtin. Örneğin, "2023-04-21T11:30:00-04:00". Bir zaman damgasından sonra oluşturulan iletileri listelemek için büyüktür operatörünü >, bir zaman damgasından önce oluşturulan iletileri listelemek için de küçüktür operatörünü < kullanabilirsiniz. Belirli bir zaman aralığındaki iletileri filtrelemek için iki zaman damgası arasına AND operatörünü ekleyin.

İleti dizisine göre filtrelemek için thread.name değerini spaces/{space}/threads/{thread} olarak biçimlendirerek 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

İsteğe bağlı. Mesaj listesinin sıralanma şekli. Sıralama işlemine göre sıralanmak üzere bir değer belirtin. Geçerli sipariş işlemi değerleri şunlardır:

  • Artan için ASC.

  • DESC için azalan.

Varsayılan sıralama createTime ASC'tür.

showDeleted

boolean

İsteğe bağlı. Silinen iletilerin dahil edilip edilmeyeceği. Silinen iletilerde, iletilerin silinme zamanı ve silinmeyle ilgili meta veriler yer alır ancak ileti içeriği kullanılamaz.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Listeleme mesajları için yanıt mesajı.

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

Sonuçların bir 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.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.