Method: customers.quarantinedMessages.search

يبحث عن الرسائل المعزولة باستخدام طلبات بحث محدّدة.

طلب HTTP

POST https://mailadminquarantine.googleapis.com/v1/{parent=customers/*}/quarantinedMessages:search

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
parent

string

الحقل مطلوب. المورد الرئيسي الذي يملك هذه المجموعة من الرسائل التنسيق: customers/{customer_id}

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
الحقول
pageSize

integer

اختيارية: الحد الأقصى لعدد العناصر التي سيتم عرضها.
pageToken

string

اختيارية: قيمة nextPageToken التي تم عرضها من طلب بحث سابق
filter

string

اختيارية: يمكنك فلترة النتائج حسب الحالة أو الاتجاه أو وحدة العزل. يتضمّن الفلتر ثلاثة أجزاء اختيارية: status وdirection وquarantine، وهي مرتبطة دائمًا باستخدام عامل التشغيل المنطقي AND. يجب أن يتّبع تعبير الفلتر بنية AIP-160. مثال: "status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1"
query

string

اختيارية: طلب بحث خاص بـ Gmail بتنسيق طلب بحث Caribou

نص الاستجابة

رسالة الردّ على [quarantinedMessages.search][].

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
الحقول
quarantinedMessages[]

object (QuarantinedMessage)

قائمة الرسائل المعزولة التي تطابق طلب البحث
nextPageToken

string

رمز مميّز لاسترداد الصفحة التالية من النتائج
unreachable[]

string

الحسابات التي لم تتمكّن الخدمة من استرداد الرسائل المعزولة لها

نطاقات الأذونات

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/gmail.admin.quarantine
  • https://www.googleapis.com/auth/gmail.admin.quarantine.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.