Exemples d'événements Attributs d'événement d'e-mail

Événements d'e-mail

Avant de pouvoir visionner vos événements, vous devez configurer le streaming des événements, voirConfiguration de la diffusion en continu des événements. Lorsque vous configurez le streaming d'événements, vous spécifiez une destination pour l'enregistrement des données de votre événement, puis vous pouvez utiliser cette destination pour récupérer les données de vos événements afin de les consulter. Lorsque vous envoyez des e-mails, Amazon Pinpoint peut diffuser des données qui fournissent des informations supplémentaires sur les types d'événements pour ces messages :

Envois
Messages délivrés
Retours à l'expéditeur
Réclamations
Messages ouverts
Clics
Rejets
Désabonnement
Échec du rendu

Les types d'événements de la liste précédente sont expliqués en détail dans Attributs d'événement d'e-mail.

Selon les paramètres API et les paramètres que vous utilisez pour envoyer des e-mails, des types d'événements supplémentaires ou des données différentes peuvent s'afficher. Par exemple, si vous envoyez des messages à l'aide d'ensembles de configuration qui publient des données d'événements sur Amazon Kinesis, tels que ceux fournis par Amazon Simple Email Service SES (Amazon), les données peuvent également inclure des événements liés à des échecs de rendu des modèles. Pour plus d'informations sur ces données, consultez la section Surveillance à l'aide de la publication d'SESévénements Amazon dans le manuel Amazon Simple Email Service Developer Guide. Avant de pouvoir visionner vos événements, vous devez configurer le streaming des événements, voirConfiguration de la diffusion en continu des événements. Lorsque vous configurez le streaming d'événements, vous spécifiez une destination pour l'enregistrement des données de votre événement, puis vous pouvez utiliser cette destination pour récupérer les données de vos événements afin de les consulter.

Exemples d'événements

Envoi d'e-mails

L'JSONobjet d'un événement d'envoi d'e-mail contient les données présentées dans l'exemple suivant.


{
  "event_type": "_email.send",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618622025,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "9a311b17-6f8e-4093-be61-4d0bbexample"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "received"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "send": {}
      }
    }
  }
}

Livraison d'e-mail

L'JSONobjet d'un événement envoyé par e-mail contient les données présentées dans l'exemple suivant.


{
  "event_type": "_email.delivered",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618622690,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "e9a3000d-daa2-40dc-ac47-1cd34example"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "delivered"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "delivery": {
          "smtp_response": "250 ok:  Message 82080542 accepted",
          "reporting_mta": "a8-53.smtp-out.amazonses.com",
          "recipients": ["recipient@example.com"],
          "processing_time_millis": 1310
        }
      }
    }
  }
}

Clic sur e-mail

L'JSONobjet d'un événement de clic dans un e-mail contient les données présentées dans l'exemple suivant.


{
  "event_type": "_email.click",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618713751,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "49c1413e-a69c-46dc-b1c4-6470eexample"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "https://aws.amazon.com/pinpoint/"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }, {
            "name": "Message-ID",
            "value": "null"
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "click": {
          "ip_address": "72.21.198.67",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.2 Safari/605.1.15",
          "link": "https://aws.amazon.com/pinpoint/"
        }
      }
    }
  }
}

Ouvertures d'e-mails

L'JSONobjet d'un événement d'ouverture d'e-mail contient les données présentées dans l'exemple suivant.


{
  "event_type": "_email.open",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618712316,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "8dc1f651-b3ec-46fc-9b67-2a050example"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "opened"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }, {
            "name": "Message-ID",
            "value": "null"
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "open": {
          "ip_address": "72.21.198.67",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko)"
        }
      }
    }
  }
}

Attributs d'événement d'e-mail

Cette section définit les attributs qui sont inclus dans les données de flux d'événements générés par Amazon Pinpoint lorsque vous envoyez un e-mail.

Attribut	Description
`event_type`	Type d'événement. Les valeurs possibles sont : _email.send : Amazon Pinpoint a accepté le message et a tenté de le remettre au destinataire. _email.delivered : le message a été remis au destinataire. _email.rejected : Amazon Pinpoint a déterminé que le message contenait un programme malveillant et n'a pas tenté de l'envoyer. _email.hardbounce : un problème permanent a empêché Amazon Pinpoint de délivrer le message. Amazon Pinpoint ne tentera pas de remettre le message à nouveau. _email.softbounce : un problème temporaire a empêché Amazon Pinpoint de délivrer le message. Amazon Pinpoint tentera de remettre le message pendant un certain laps de temps. Si le message ne peut toujours pas être remis, aucune autre tentative ne sera effectuée. L'état final de l'e-mail sera alorsSOFTBOUNCE. _email.complaint : le destinataire a reçu le message, puis l'a signalé comme courrier indésirable pour son fournisseur de messagerie (par exemple, en utilisant la fonctionnalité « Signaler le courrier indésirable » de son client de messagerie). _email.open : le destinataire a reçu le message et l'a ouvert. _email.click : le destinataire a reçu le message et a cliqué sur un lien qu'il contient. _email.unsubscribe : le destinataire a reçu le message et a cliqué sur le lien de désabonnement qu'il contient. _email.rendering_failure : l'e-mail n'a pas été envoyé en raison d'un échec de rendu. Cela peut se produire lorsqu'il manque des données du modèle ou lorsqu'il n'y a pas concordance entre les paramètres du modèle et les données.
`event_timestamp`	Heure à laquelle le message a été envoyé, indiquée exprimée en millisecondes de temps Unix. Cette valeur est généralement la même pour tous les événements générés pour un message.
`arrival_timestamp`	Heure à laquelle l'événement a été reçu par Amazon Pinpoint, affichée sous la forme Heure Unix en millisecondes.
`event_version`	Version du JSON schéma d'événement. Astuce Vérifiez la version dans votre application de traitement des événements afin de savoir à quel moment mettre à jour l'application suite à une mise à jour du schéma.
`application`	Informations sur le projet Amazon Pinpoint associé à l'événement. Pour plus d'informations, consultez le tableau Application.
`client`	Informations sur le client d'application installé sur l'appareil qui a signalé l'événement. Pour plus d'informations, consultez le tableau Client.
`device`	Informations sur l'appareil qui a signalé l'événement. Pour plus d'informations, consultez le tableau Appareil. Pour les événements d'e-mail, cet objet est vide.
`session`	Pour les événements d'e-mail, cet objet est vide.
`attributes`	Attributs associés à l'événement. Pour plus d'informations, consultez le tableau Attributs. Pour les événements rapportés par l'une de vos applications, cet objet peut inclure des attributs personnalisés qui sont définis par l'application. Pour les événements qui sont créés lorsque vous envoyez un message à partir d'une campagne ou d'un parcours, cet objet contient les attributs associés à la campagne ou au parcours. Pour les événements qui sont générés lorsque vous envoyez des messages transactionnels, cet objet contient des informations liées au message lui-même.
`client_context`	Pour les événements de messagerie, cet objet contient un objet `custom`, qui contient un attribut `legacy_identifier`. La valeur de l'attribut `legacy_identifier` est l'ID du projet à partir de laquelle le message a été envoyé.
`facets`	Informations supplémentaires sur le message, telles que les en-têtes d'e-mail. Consultez le tableau Facettes pour plus d'informations.
`awsAccountId`	ID du AWS compte utilisé pour envoyer le message.

Application

Inclut les informations sur le projet Amazon Pinpoint auquel l'événement est associé.

Attribut	Description
`app_id`	ID unique du projet Amazon Pinpoint qui a signalé l'événement.
`sdk`	Le SDK qui a été utilisé pour signaler l'événement. Si vous envoyez un e-mail transactionnel en appelant directement Amazon API Pinpoint ou en utilisant la console Amazon Pinpoint, cet objet est vide.

Attributs

Inclut des informations sur la campagne ou le parcours qui a généré l'événement.

Campagne

Inclut des informations sur la campagne qui a généré l'événement.

Attribut	Description
`feedback`	Pour les `_email.click` événements, la valeur URL de cet attribut est le lien sur lequel le destinataire a cliqué dans le message pour générer l'événement. Pour les autres événements, cette valeur représente le type d'événement, tel que `received`, `opened` ou `clicked`.
`treatment_id`	Si le message a été envoyé à l'aide d'une campagne de test A/B, cette valeur représente le numéro de traitement du message. Pour les campagnes standard et les e-mails transactionnels, cette valeur est `0`.
`campaign_activity_id`	ID unique généré par Amazon Pinpoint lorsque l'événement se produit.
`campaign_id`	ID unique de la campagne qui a envoyé le message.

Parcours

Inclut des informations sur le parcours qui a généré l'événement.

Attribut	Description
`journey_run_id`	ID unique de l'exécution du parcours qui a envoyé le message. Amazon Pinpoint génère et attribue automatiquement cet identifiant à chaque nouvelle étape d'un parcours.
`feedback`	Pour les `_email.click` événements, la valeur URL de cet attribut est le lien sur lequel le destinataire a cliqué dans le message pour générer l'événement. Pour les autres événements, cette valeur représente le type d'événement, tel que `received`, `delivered` ou `opened`.
`journey_id`	ID unique du parcours qui a envoyé le message.
`journey_activity_id`	ID unique de l'activité de parcours qui a envoyé le message.

Client

L'identifiant unique du client ciblé par la campagne ou le parcours.

Attribut	Description
`client_id`	ID du client. La valeur est l'identifiant du point de terminaison pour les campagnes et les parcours, et pour l'envoi transactionnel, il s'agit d'unUUID.

Inclut des informations sur le message et le type d'événement.

Attribut	Description
`email_channel`	Contient un objet `mail_event`, qui contient deux objets : `mail` et un objet correspondant au type d'événement.

Mail

Inclut des informations sur le contenu de l'e-mail, ainsi que des métadonnées liées au message.

Attribut	Description
`message_id`	ID unique du message. Amazon Pinpoint génère automatiquement cet ID lorsqu'il accepte le message.
`message_send_timestamp`	Date et heure d'envoi du message, dans le format spécifié en RFC822.
`from_address`	Adresse e-mail à partir de laquelle le message a été envoyé.
`destination`	Tableau contenant les adresses e-mail auxquelles le message a été envoyé.
`headers_truncated`	Valeur booléenne qui indique si les en-têtes d'e-mail ont été tronqués.
`headers`	Objet qui contient plusieurs paires nom-valeur correspondant aux en-têtes du message. Cet objet contient généralement des informations sur les en-têtes suivants : `From` : adresse e-mail de l'expéditeur. `To` : adresse e-mail du destinataire. `Subject` : ligne Objet de l'e-mail. Astuce L'en-tête du sujet n'est pas inclus pour les événements Campaign _email.send. `MIME-Version`— Indique que le message est au MIME format. Si cet en-tête est présent, la valeur est toujours `1.0`. `Content-Type`— Le type de MIME média du contenu du message.
`common_headers`	Contient des informations sur plusieurs en-têtes communs pour les messages électroniques. Les informations peuvent inclure la date à laquelle le message a été envoyé, ainsi que les lignes de destination, d'expéditeur et d'objet du message.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Événements de parcours

SMSévénements