Method: customers.quarantinedMessages.search

חיפוש הודעות בהסגר באמצעות שאילתות חיפוש ספציפיות.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של הנתיב

פרמטרים
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

מידע נוסף זמין במדריך ההרשאות.