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

Подробную информацию можно найти в руководстве по авторизации.