Method: domains.getComplianceStatus

Получает статус соответствия для заданного домена. Возвращает PERMISSION_DENIED, если у вас нет разрешения на доступ к статусу соответствия для этого домена.

HTTP-запрос

GET https://gmailpostmastertools.googleapis.com/v2/{name=domains/*/complianceStatus}

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
name

string

Обязательно. Имя ресурса, содержащего информацию о соответствии домена требованиям, которую необходимо получить. Формат: domains/{domainId}/complianceStatus .

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

Статус соответствия домена требованиям.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
Поля
name

string

Идентификатор. Имя ресурса, отображающего статус соответствия домена требованиям. Формат: domains/{domainId}/complianceStatus .

complianceData

object ( DomainComplianceData )

Данные о соответствии требованиям для регистрируемой части домена в name . Например, если name — domains/example.com/complianceStatus , это поле содержит данные о соответствии требованиям для example.com .

subdomainComplianceData

object ( DomainComplianceData )

Данные о соответствии требованиям рассчитываются специально для поддомена в name . Это поле заполняется только в том случае, если домен в name является поддоменом, отличающимся от регистрируемого домена (например, sub.example.com ), и если данные о соответствии требованиям доступны для этого конкретного поддомена.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

Для получения более подробной информации см. руководство по авторизации .

DomainComplianceData

Данные о соответствии требованиям для данной области.

JSON-представление 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
Поля
domainId

string

Домен, к которому относятся эти данные.

rowData[]

object ( ComplianceRowData )

Данные для каждой строки таблицы. Каждое сообщение содержит все данные, относящиеся к отдельной строке.

oneClickUnsubscribeVerdict

object ( OneClickUnsubscribeVerdict )

Вердикт по вопросу соответствия требованиям о возможности отписки одним щелчком мыши.

honorUnsubscribeVerdict

object ( HonorUnsubscribeVerdict )

Отписаться в соответствии с решением суда о соблюдении требований.

ComplianceRowData

Данные для одной строки таблицы состояния соответствия.

JSON-представление 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
Поля
requirement

enum ( ComplianceRequirement )

Требование соответствия.

status

object ( ComplianceStatus )

Статус соответствия требованиям.

Требования соответствия

Требование соответствия.

Перечисления
COMPLIANCE_REQUIREMENT_UNSPECIFIED Не указано.
SPF Проверьте, правильно ли отправитель настроил SPF.
DKIM Проверьте, правильно ли отправитель настроил DKIM.
SPF_AND_DKIM Проверьте, правильно ли отправитель настроил SPF и DKIM.
DMARC_POLICY Указано, настроена ли у отправителя политика DMARC.
DMARC_ALIGNMENT Выравнивание заголовка From: по DKIM или SPF
MESSAGE_FORMATTING Проверяется, правильно ли отформатированы сообщения в соответствии с RFC 5322.
DNS_RECORDS Указывает, имеет ли домен прямые и обратные DNS-записи.
ENCRYPTION Сообщения зашифрованы по протоколу TLS.
USER_REPORTED_SPAM_RATE Проверяется, находится ли отправитель ниже порогового значения для уровня спама, о котором сообщают пользователи.
ONE_CLICK_UNSUBSCRIBE Достаточно ли отправитель поддерживает отписку в один клик. Обратите внимание, что требование, видимое пользователю, — это «отписка в один клик», но нам необходимо соблюдение нескольких правил «поддержки отписки».
HONOR_UNSUBSCRIBE Учитывает ли отправитель запросы на отписку, инициированные пользователем.

Статус соответствия

Статус выполнения отправителем требований по соблюдению правил.

JSON-представление 
{
  "status": enum (State)
}
Поля
status

enum ( State )

Только выходные данные. Статус соответствия.

Состояние

Типы статусов для конкретного требования к соблюдению условий отправителем.

Перечисления
STATE_UNSPECIFIED Не указано.
COMPLIANT Требование соответствия выполнено, и отправитель считается соответствующим требованиям.
NEEDS_WORK Требование соответствия не выполнено, и отправителю необходимо приложить усилия для его выполнения.

OneClickUnsubscribeVerdict

Решение суда о соответствии отправителя требованию об отписке от рассылки одним щелчком мыши.

JSON-представление 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Поля
status

object ( ComplianceStatus )

Статус соответствия.

reason

enum ( Reason )

Конкретная причина вынесения решения о соответствии. Если статус «соответствует», поле должно быть пустым.

Причина

Конкретная причина, по которой решение суда о возможности отписки одним щелчком мыши имеет статус «несоответствующий требованиям».

Перечисления
REASON_UNSPECIFIED Не указано.
NO_UNSUB_GENERAL Отправитель не поддерживает отписку от рассылки в один клик для большинства своих сообщений.
NO_UNSUB_SPAM_REPORTS Отправитель не поддерживает отписку одним щелчком мыши для большинства сообщений, которые вручную помечены как спам.
NO_UNSUB_PROMO_SPAM_REPORTS Отправитель не поддерживает отписку в один клик для большинства рекламных сообщений, которые вручную помечены как спам. Эта классификация сообщений является подмножеством тех, которые охватываются параметром NO_UNSUB_SPAM_REPORTS .

HonorUnsubscribeVerdict

Решение о соответствии отправителя требованиям по соблюдению правил отписки.

JSON-представление 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Поля
status

object ( ComplianceStatus )

Статус соответствия.

reason

enum ( Reason )

Конкретная причина вынесения решения о соответствии. Если статус «соответствует», поле должно быть пустым.

Причина

Конкретная причина, по которой отписка, подтверждающая решение суда, имеет статус «несоответствующая требованиям».

Перечисления
REASON_UNSPECIFIED Не указано.
NOT_HONORING Отправитель не принимает запросы на отписку.
NOT_HONORING_TOO_FEW_CAMPAIGNS Отправитель не учитывает запросы на отписку и рассматривает возможность увеличения количества релевантных рассылок.
NOT_HONORING_TOO_MANY_CAMPAIGNS Отправитель не учитывает запросы на отписку и рассматривает возможность сокращения количества релевантных рассылок.