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ılırken yanıt boş bir JSON nesnesi ({}) içerir. Örnek için Mesajları 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 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 ileti döndürebilir.

Belirtilmezse en fazla 25 kod döndürülür.

Maksimum değer 1.000'dir. 1.000'den yüksek 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 list 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 diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler aktarmak 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 öğ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 mesajları listelemek için büyüktür operatörünü >, zaman damgasından sonra oluşturulan mesajları listelemek için ise küçüktür operatörünü (<) kullanabilirsiniz. Belirli bir zaman aralığı içindeki iletileri 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 özelliğini 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 ediliyorsa isteğe bağlıdır.

Mesaj listesinin sıralaması. Sıralama işlemine göre sıralanacak bir değer belirtin. Geçerli sipariş işlemi değerleri şunlardır:

  • Artan için ASC.

  • Azalan için DESC.

Varsayılan sıralama createTime ASC şeklindedir.

showDeleted

boolean

Silinen iletilerin eklenip eklenmeyeceğini belirtir. Silinen iletiler arasında, silinen zamanı ve silinme zamanıyla ilgili meta verileri içerir ancak ileti içeriği mevcut değildir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Mesajları listelemeyle ilgili 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 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.