Method: spaces.messages.list

Arayanın üyesi olduğu bir alandaki mesajları (engellenen üyelerden ve alanlardan gelen mesajlar dahil) listeler. Yeni alan üyelerini duyuranlar gibi sistem mesajları dahil edilmez. Mesaj içermeyen bir alandaki mesajları listelerseniz yanıt boş bir nesne olur. REST/HTTP arayüzü kullanılırken yanıtta boş bir JSON nesnesi ({}) bulunur. Örnek için İletileri listeleme başlıklı makaleyi inceleyin.

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

  • Yetkilendirme kapsamıyla geliştirici önizlemesinde yönetici onayı ile uygulama kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Bu kimlik doğrulama kapsamı kullanılırken bu yöntem yalnızca bir alandaki herkese açık mesajları döndürür. Özel mesajlar bu kapsamda değildir.
  • Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)

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. İletilerin 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 halinde en fazla 25 öğe 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

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

Sayfalama 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 iletmek beklenmedik sonuçlara yol açabilir.

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 değerini RFC-3339 biçiminde ve çift tırnak işaretleriyle zaman damgasıyla birlikte belirtin. Örneğin, "2023-04-21T11:30:00-04:00". Zaman damgasından sonra oluşturulan iletileri listelemek için büyüktür operatörünü (>), zaman damgasından önce oluşturulan iletileri listelemek için ise küçüktür operatörünü (<) kullanabilirsiniz. İletileri belirli bir zaman aralığında filtrelemek için iki zaman damgası arasında AND operatörünü kullanın.

İleti dizisine göre filtrelemek için thread.name değerini spaces/{space}/threads/{thread} olarak biçimlendirilmiş şekilde 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ı. İletilerin listesinin sıralanma şekli. Sıralama işlemine göre sıralanacak bir değer belirtin. Geçerli sıralama işlemi değerleri şunlardır:

  • Artan sıra için ASC.

  • Azalan düzende sıralamak için DESC.

Varsayılan sıralama createTime ASC'dır.

showDeleted

boolean

İsteğe bağlı. Silinen iletilerin dahil edilip edilmeyeceği Silinen iletiler, silinme zamanını ve silinmeyle 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

Listeleme iletileri 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

Sonraki sonuç 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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.