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

ไม่บังคับ กรองผลลัพธ์ตามสถานะ ทิศทาง หรือเขตกักบริเวณ ตัวกรองประกอบด้วย 3 ส่วนที่ไม่บังคับ ได้แก่ 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

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์