Переход на API Postmaster Tools версии 2

В этом руководстве описаны различия между версиями 1 и 2 API Postmaster Tools, а также способы миграции вашего приложения версии 1 на версию 2.

Обзор

Вторая версия API Postmaster Tools представляет ряд новых функций и объединяет существующий функционал для получения статистики электронной почты. С версией 2 вы теперь можете:

  • Получайте статистические данные за определенные временные диапазоны, а не по дням.
  • Проверка соответствия запроса требованиям Sender Policy Framework (SPF), Domainkeys Identified Mail (DKIM) и Domain-based Message Authentication, Reporting and Conformance (DMARC).
  • Получайте статистику по нескольким доменам с помощью одного вызова API.

Ключевые изменения включают в себя:

  • Ресурс trafficStats заменен на domainStats .
  • Методы domains.trafficStats.get и domains.trafficStats.list были заменены одним методом domains.domainStats.query .
  • Введен новый метод domains.getComplianceStatus , позволяющий получить информацию о соответствии требованиям SPF, DKIM и DMARC для заданного домена.
  • Введен новый метод domainStats.batchQuery , позволяющий получать статистику для нескольких доменов за один вызов.
  • Термин «метрики», использовавшийся в версии 1, был переименован в «статистика».

Обновление до версии 2

Для перехода с версии 1 на версию 2 необходимо обновить клиентскую библиотеку до последней версии и изменить код для использования ресурсов и методов версии 2.

  1. Обновите библиотеку API для инструментов администратора почты до версии 2 или выше.
  2. Измените все вызовы с ресурса trafficStats на ресурс domainStats .
  3. Замените все вызовы domains.trafficStats.get или domains.trafficStats.list на domains.domainStats.query , указав параметры startDate и endDate для определения диапазона дат для запроса.

Получить статистику по электронной почте

В версии 1 метрики электронной почты получались с помощью domains.trafficStats.get за один день или domains.trafficStats.list за несколько дней. В версии 2 статистика электронной почты получается с помощью domains.domainStats.query .

Метод domains.domainStats.query позволяет получать статистику за определенный диапазон дат, указывая startDate и endDate .

v1: domains.trafficStats.get

Java 

String query = String.format("domains/%s/trafficStats/%s", domainName, date);
TrafficStats trafficStats = service.domains().trafficStats().get(query).execute();

Python 

query = 'domains/%s/trafficStats/%s' %(domain_name,date)
traffic_stats = service.domains().trafficStats().get(name=query).execute();

v2: domains.domainStats.query за один день

Чтобы получить статистику за один день в версии 2, вызовите метод domains.domainStats.query с теми же startDate и endDate .

Java 

Date date = new Date().setYear(2024).setMonth(1).setDay(1);
QueryDomainStatsResponse statsResponse = service.domains().domainStats()
        .query("domains/" + domainName)
        .setStartDate(date)
        .setEndDate(date)
        .execute();

Python 

date = {'year': 2024, 'month': 1, 'day': 1}
stats = service.domains().domainStats().query(
    parent='domains/' + domain_name,
    startDate=date,
    endDate=date).execute()

v1: domains.trafficStats.list

Java 

ListTrafficStatsResponse listTrafficStatsResponse = service.domains().trafficStats().list("domains/" + domainName)
        .execute();

Python 

query = 'domains/' + domain_name
list_traffic_stats_response = service.domains().trafficStats().list(parent=query).execute();

v2: domains.domainStats.query для диапазона дат

Чтобы получить статистику за определенный диапазон дат в версии 2, вызовите метод domains.domainStats.query , указав startDate и endDate .

Java 

Date startDate = new Date().setYear(2024).setMonth(1).setDay(1);
Date endDate = new Date().setYear(2024).setMonth(1).setDay(7);
QueryDomainStatsResponse statsResponse = service.domains().domainStats()
        .query("domains/" + domainName)
        .setStartDate(startDate)
        .setEndDate(endDate)
        .execute();

Python 

stats = service.domains().domainStats().query(
    parent='domains/' + domain_name,
    startDate={'year': 2024, 'month': 1, 'day': 1},
    endDate={'year': 2024, 'month': 1, 'day': 7}).execute()

Новые функции версии 2

В дополнение к объединению результатов get и list статистики трафика в query , в версии 2 представлены следующие функции.

Получить информацию о соответствии требованиям

Получить статус соответствия требованиям Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM) и Domain-based Message Authentication, Reporting, and Conformance (DMARC) для домена можно с помощью domains.getComplianceStatus .

Пример кода см. в разделе « Получение статистики электронной почты» .

Статистика домена пакетного запроса

С помощью domainStats.batchQuery можно получить статистику для нескольких доменов одним вызовом.