- HTTP isteği
- Yol parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- SearchMessagesView
- SearchMessageResult
- Deneyin.
Kullanıcının erişimi olan tüm alanlarda arama yapmak için parent seçeneğini spaces/- olarak ayarlayın. parent için başka bir değer kullanmak INVALID_ARGUMENT hatasına neden olur. Döndürülen iletilerin name alanı, iletinin bulunduğu belirli space dahil olmak üzere tam kaynak adıyla doldurulur.
Bu API, tüm mesaj türlerini döndürmez. Aşağıda listelenen mesaj türleri yanıta dahil edilmez. Tüm iletileri listelemek için messages.list simgesini kullanın.
- Kimliği doğrulanmış kullanıcı tarafından görülebilen özel mesajlar.
- Chat uygulamalarının alanlarda veya grup sohbetlerinde yayınladığı mesajlar
- Chat uygulaması DM'lerindeki mesajlar
- Engellenen kullanıcılardan gelen mesajlar
- Arayanın yoksaydığı alanlardaki mesajlar.
Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:
https://www.googleapis.com/auth/chat.messages.readonlyhttps://www.googleapis.com/auth/chat.messages
HTTP isteği
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages:search
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
| Parametreler | |
|---|---|
parent |
Zorunlu. İçinde arama yapılacak alanın kaynak adı. Kullanıcının erişebildiği tüm alanlarda arama yapmak için bu alanı Aramayı bir veya daha fazla alanla sınırlamak için |
İstek metni
İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:
| JSON gösterimi |
|---|
{
"filter": string,
"pageSize": integer,
"pageToken": string,
"orderBy": string,
"view": enum ( |
| Alanlar | |
|---|---|
filter |
Zorunlu. Arama sorgusu Sorgu, sonuçları filtrelemek için kullanılan bir veya daha fazla arama anahtar kelimesi belirtebilir. Ayrıca, aşağıdaki ileti alanlarını kullanarak da sonuçları filtreleyebilirsiniz:
Gelişmiş filtreleme için aşağıdaki işlevler de kullanılabilir:
Farklı alanlarda yalnızca Aynı alan içinde:
Aynı sorguda Aşağıdaki örnek sorgular geçerlidir: Maksimum sorgu uzunluğu 1.000 karakterdir. Geçersiz sorgular, sunucu tarafından |
pageSize |
İsteğe bağlı. Döndürülecek maksimum sonuç sayısı. Hizmet, bu değerden daha az sonuç döndürebilir. Belirtilmemesi halinde en fazla 25 öğe döndürülür. Maksimum değer 100'dür. 100'den büyük bir değer kullanırsanız bu değer otomatik olarak 100 olarak değiştirilir. |
pageToken |
İsteğe bağlı. Önceki arama mesajları çağrısından alınan jeton. 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. |
orderBy |
İsteğe bağlı. Sonuç listesinin nasıl sıralandığı. Sıralama için desteklenen özellikler şunlardır:
Varsayılan sıralama |
view |
İsteğe bağlı. Ne tür arama sonuçları görünümünün döndürüleceğini belirtir. Varsayılan değer: |
Yanıt metni
İletileri arama için yanıt mesajı.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
| JSON gösterimi |
|---|
{
"results": [
{
object ( |
| Alanlar | |
|---|---|
results[] |
Sorguyla eşleşen arama sonuçlarının listesi. |
nextPageToken |
Sonraki sayfayı almak için kullanılabilecek bir jeton. Bu alan boşsa sonraki sayfa yoktur. |
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.messages.readonly
Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.
SearchMessagesView
Kısmi arama sonuçları için desteklenen görünüm türleri.
| Sıralamalar | |
|---|---|
SEARCH_MESSAGES_VIEW_UNSPECIFIED |
Varsayılan / ayarlanmamış değer. API, varsayılan olarak BASIC görünümüne ayarlanır. |
SEARCH_MESSAGES_VIEW_BASIC |
Sonuçlara yalnızca eşleşen mesajlar dahil edilir, ancak ek meta veri dahil edilmez. Bu, varsayılan değerdir. |
SEARCH_MESSAGES_VIEW_FULL |
Sonuçlardaki her şeyi (eşleşen iletiler ve ek meta veriler) içerir. |
SearchMessageResult
Bir ileti aramasından elde edilen tek bir sonuç öğesi.
| JSON gösterimi |
|---|
{ "message": { object ( |
| Alanlar | |
|---|---|
message |
Eşleşen ileti. |
spaceMuteSetting |
Mesajın yayınlandığı alanda, arayan kullanıcının sessize alma ayarı. Arayan uygulama, alanın kullanıcı için sessize alınıp alınmadığına bağlı olarak mesajın nasıl işleneceğine karar vermek için bu bilgileri kullanabilir. Yalnızca istek görünümü
|
read |
Eşleşen mesajın arayan kullanıcı tarafından okunup okunmadığını gösterir. Yalnızca istek görünümü
|