Method: customers.quarantinedMessages.search

खास सर्च क्वेरी का इस्तेमाल करके, क्वॉरंटीन किए गए मैसेज खोजता है.

एचटीटीपी अनुरोध

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

यह यूआरएल, 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

ज़रूरी नहीं. Caribou क्वेरी फ़ॉर्मैट में, Gmail के लिए खास तौर पर बनाई गई सर्च क्वेरी.

जवाब का मुख्य भाग

[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

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.