Migra a la API de Postmaster Tools v2

En esta guía, se describen las diferencias entre las versiones 1 y 2 de la API de Herramientas para administradores de correo electrónico y cómo migrar tu aplicación de la versión 1 a la versión 2.

Descripción general

La versión 2 de la API de Postmaster Tools presenta varias funciones nuevas y consolida la funcionalidad existente para recuperar estadísticas de correo electrónico. Con la versión 2, ahora puedes hacer lo siguiente:

  • Recupera estadísticas en períodos en lugar de por día.
  • Consultar el estado de cumplimiento de Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM) y Autenticación de mensajes, informes y cumplimiento basados en el dominio (DMARC)
  • Recupera estadísticas para varios dominios con una sola llamada a la API.

Los cambios clave incluyen lo siguiente:

  • El recurso trafficStats se reemplazó por domainStats.
  • Los métodos domains.trafficStats.get y domains.trafficStats.list se reemplazaron por un solo método domains.domainStats.query.
  • Hay un nuevo método domains.getComplianceStatus disponible para recuperar el estado de cumplimiento de SPF, DKIM y DMARC para un dominio determinado.
  • Se encuentra disponible un nuevo método domainStats.batchQuery para recuperar estadísticas de varios dominios en una sola llamada.
  • El término "métricas" que se usaba en la versión 1 se cambió a "estadísticas".

Actualización a la versión 2

Para migrar de la versión 1 a la versión 2, debes actualizar tu biblioteca cliente a la versión más reciente y modificar tu código para usar los recursos y métodos de la versión 2.

  1. Actualiza tu biblioteca cliente de la API de Postmaster Tools a la versión 2 o posterior.
  2. Cambia todas las llamadas del recurso trafficStats al recurso domainStats.
  3. Reemplaza las llamadas a domains.trafficStats.get o domains.trafficStats.list por domains.domainStats.query, y proporciona los parámetros startDate y endDate para especificar el período de la consulta.

Recupera estadísticas de correos electrónicos

En la versión 1, las métricas de correo electrónico se recuperaban con domains.trafficStats.get para un solo día o domains.trafficStats.list para varios días. En la versión 2, las estadísticas de correo electrónico se recuperan con domains.domainStats.query.

El método domains.domainStats.query te permite recuperar estadísticas durante un período especificando startDate y 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 por un solo día

Para recuperar las estadísticas de un solo día en la versión 2, llama a domains.domainStats.query con los mismos startDate y 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 para un período

Para recuperar estadísticas de un período en la versión 2, llama a domains.domainStats.query con un startDate y un 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()

Nuevas funciones de la versión 2

Además de consolidar las estadísticas de tráfico de get y list en query, la versión 2 introduce las siguientes funciones.

Recupera el estado de cumplimiento

Puedes recuperar el estado de cumplimiento de Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM) y Autenticación de mensajes, informes y cumplimiento basados en el dominio (DMARC) para un dominio con domains.getComplianceStatus.

Consulta Cómo recuperar estadísticas de correo electrónico para ver un ejemplo de código.

Estadísticas de dominios de consultas por lotes

Puedes recuperar estadísticas de varios dominios con una sola llamada a través de domainStats.batchQuery.