Method: customers.quarantinedMessages.search

Wyszukuje wiadomości w kwarantannie za pomocą określonych zapytań.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Zasób nadrzędny, który jest właścicielem tej kolekcji wiadomości. Format: customers/{customer_id}

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
Pola
pageSize

integer

Opcjonalnie: Maksymalna liczba elementów do zwrócenia.
pageToken

string

Opcjonalnie: Wartość nextPageToken zwrócona z poprzedniego wywołania wyszukiwania.
filter

string

Opcjonalnie: Filtruj wyniki według stanu, kierunku lub kwarantanny. Filtr zawiera 3 opcjonalne części: status, direction i quarantine, które są zawsze połączone za pomocą operatora logicznego AND. Wyrażenie filtra musi być zgodne ze składnią AIP-160. Przykład: „status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1”
query

string

Opcjonalnie: Zapytanie wyszukiwania w Gmailu w formacie zapytania Caribou.

Treść odpowiedzi

Wiadomość z odpowiedzią na [quarantinedMessages.search][].

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Pola
quarantinedMessages[]

object (QuarantinedMessage)

Lista wiadomości poddanych kwarantannie, które pasują do zapytania.
nextPageToken

string

Token do pobierania następnej strony wyników.
unreachable[]

string

Konta, w przypadku których usłudze nie udało się pobrać wiadomości poddanych kwarantannie.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.