Method: domains.getComplianceStatus

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

HTTP-запрос

GET https://gmailpostmastertools.googleapis.com/v2beta/{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 Удовлетворяет ли отправитель инициированные пользователем запросы на отмену подписки.

ComplianceStatus

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

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 .

ЧестьОтписатьсяВердикт

Вердикт о соответствии, определяющий, соответствует ли отправитель требованию об отмене подписки.

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 Отправитель не выполняет запросы на отмену подписки и рассматривает возможность сокращения количества соответствующих кампаний.