Method: spaces.messages.list

Engellenen üyeler ve alanlardan gelen mesajlar da dahil olmak üzere, arayanın üye olduğu bir alandaki mesajları listeler. Örnek için İletileri listeleme bölümüne bakın. 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ın listeleneceğ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 bu değer 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 mesajları çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu parametreyi sağlayın.

Sayfalara ayırırken, sağlanan tüm diğer parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler geçirmek beklenmedik 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 için RFC-3339 biçiminde bir zaman damgası ve çift tırnak işareti kullanın. Örneğin, "2023-04-21T11:30:00-04:00". Bir zaman damgasından sonra oluşturulan mesajları listelemek için büyüktür operatörünü (>), zaman damgasından önce oluşturulan mesajları listelemek içinse < küçüktür operatörünü kullanabilirsiniz. Belirli bir zaman aralığındaki mesajları filtrelemek için iki zaman damgası arasında AND operatörünü kullanın.

İleti dizisine göre filtrelemek için spaces/{space}/threads/{thread} olarak biçimlendirilmiş thread.name değerini belirtin. Sorgu başına yalnızca bir thread.name belirtebilirsiniz.

İleti dizisine ve 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 INVALID_ARGUMENT hatasıyla sunucu tarafından reddedilir.

orderBy

string

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

Mesaj listesinin sıralanma biçimi. Sıralama işlemine göre sıralanacak bir değer belirtin. Geçerli sıralama işlemi değerleri aşağıda verilmiştir:

  • Artan için ASC.

  • Azalan için DESC.

Varsayılan sıralama createTime ASC şeklindedir.

showDeleted

boolean

Silinen iletilerin dahil edilip edilmeyeceği. Silinen iletiler, silinen zamanı ve silme işlemiyle 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

Liste girişi 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

Bir sonraki sonuç sayfasını almak için pageToken olarak bir jeton gönderebilirsiniz. Boş bırakılırsa 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ılavuzu'na bakın.