Exemplos de evento de e-mail Atributos de eventos de e-mail

Fluxo de dados de evento de e-mail do Amazon Pinpoint

Se o Amazon Pinpoint for usado para enviar e-mails, o Amazon Pinpoint pode transmitir dados de eventos sobre esses e-mails. Depois de configurar a transmissão de eventos, o Amazon Pinpoint recupera os dados do evento do destino que você especificou durante a configuração, para que você possa visualizá-los. Para obter informações sobre como configurar uma transmissão de evento, consulte Configure o Amazon Pinpoint para transmitir dados de eventos do aplicativo por meio do Amazon Kinesis ou do Amazon Data Firehose . O Amazon Pinpoint transmite dados sobre os seguintes tipos de eventos para mensagens de e-mail:

Envios
Entregas
Devoluções
Reclamações
Aberturas
Cliques
Rejeições
Cancelamento de assinaturas
Falhas de processamento

Esses tipos de eventos são explicados detalhadamente em Atributos de eventos de e-mail.

Dependendo da API e das configurações usadas para enviar mensagens por e-mail, será possível ver tipos de eventos adicionais ou dados diferentes. Por exemplo, se você enviar mensagens usando conjuntos de configurações que publicam dados de eventos no Amazon Kinesis, como os fornecidos pelo Amazon Simple Email Service (Amazon SES), os dados também podem incluir eventos para falhas de renderização de modelo. Para obter informações sobre esses dados, consulte Monitorar usando a publicação de eventos do Amazon SES no Guia do desenvolvedor do Amazon Simple Email. Antes de poder ver seus eventos, você precisa configurar a transmissão de eventos, consulte Configure o Amazon Pinpoint para transmitir dados de eventos do aplicativo por meio do Amazon Kinesis ou do Amazon Data Firehose . Ao configurar a transmissão de eventos, você especifica um destino para os dados do evento serem salvos e, em seguida, pode usar o destino para recuperar os dados do evento para visualização.

Exemplos de evento de e-mail

Envio de e-mail

O objeto JSON de um evento de envio de e-mail contém os dados mostrados no exemplo a seguir.


{
  "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": {}
      }
    }
  }
}

E-mail entregue

O objeto JSON de um evento de e-mail entregue contém os dados mostrados no exemplo a seguir.


{
  "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
        }
      }
    }
  }
}

Clique em e-mail

O objeto JSON de um evento de clique em e-mail contém os dados mostrados no exemplo a seguir.


{
  "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/"
        }
      }
    }
  }
}

E-mail aberto

O objeto JSON de um evento de e-mail aberto contém os dados mostrados no exemplo a seguir.


{
  "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)"
        }
      }
    }
  }
}

Atributos de eventos de e-mail

Esta seção define os atributos incluídos no exemplo anterior de dados de fluxo do evento que o Amazon Pinpoint gera ao enviar mensagens de e-mails.

Atributo	Descrição
`event_type`	O tipo de evento. Os valores possíveis são: _email.send: o Amazon Pinpoint aceitou a mensagem e tentou entregá-la ao destinatário. _email.delivered: a mensagem foi entregue ao destinatário. _email.rejected: o Amazon Pinpoint determinou que a mensagem continha malware e não tentou enviá-la. _email.hardbounce: um problema permanente impediu que o Amazon Pinpoint entregasse a mensagem. O Amazon Pinpoint não tentará entregar a mensagem novamente. _email.softbounce: um problema temporário impediu que o Amazon Pinpoint entregasse a mensagem. O Amazon Pinpoint tentará entregar a mensagem novamente por determinado período. Se a mensagem ainda não puder ser entregue, não haverá mais tentativas. O estado final do e-mail será então SOFTBOUNCE. _email.complaint: o destinatário recebeu a mensagem e reportou a mensagem para o provedor de e-mail como spam (por exemplo, usando o atributo “Denunciar spam” do cliente de e-mail). _email.open: o destinatário recebeu a mensagem e a abriu. _email.click: o destinatário recebeu a mensagem e clicou em um link nela. _email.unsubscribe: o destinatário recebeu a mensagem e clicou em um link de cancelamento de inscrição contido nela. _email.rendering_failure: o e-mail não foi enviado devido a uma falha na renderização. Isso pode ocorrer quando estão faltando dados no modelo ou quando há uma incompatibilidade entre os parâmetros e os dados do modelo.
`event_timestamp`	A hora em que a mensagem foi enviada, mostrada como tempo Unix em milissegundos. Esse valor geralmente é o mesmo para todos os eventos gerados para uma mensagem.
`arrival_timestamp`	A hora em que o evento foi recebido pelo Amazon Pinpoint, mostrada como horário do Unix em milissegundos.
`event_version`	A versão do esquema do evento JSON. dica Marque esta versão no seu aplicativo de processamento de eventos para que você saiba quando atualizar o aplicativo em resposta a uma atualização de esquema.
`application`	Informações sobre o projeto do Amazon Pinpoint associado ao evento. Consulte a tabela Aplicativo para obter mais informações.
`client`	Informações sobre o cliente de aplicativo instalado no dispositivo que relatou o evento. Para obter mais informações, consulte a tabela Cliente.
`device`	Informações sobre o dispositivo que relatou o evento. Para obter mais informações, consulte a tabela Dispositivo. Para eventos de e-mail, esse objeto está vazio.
`session`	Para eventos de e-mail, esse objeto está vazio.
`attributes`	Atributos associados ao evento. Para obter mais informações, consulte a tabela Atributos. Para eventos relatados por um de seus aplicativos, esse objeto pode incluir atributos personalizados que são definidos pelo aplicativo. Para eventos criados quando você envia uma mensagem de uma campanha ou jornada, esse objeto contém atributos associados à campanha ou jornada. Para eventos gerados ao enviar mensagens transacionais, esse objeto contém informações relacionadas à mensagem em si.
`client_context`	Para eventos de email, esse objeto contém um objeto de `custom` que contém um atributo `legacy_identifier`. O valor do atributo `legacy_identifier` é o ID do projeto do qual a mensagem foi enviada.
`facets`	Informações adicionais sobre a mensagem, como os cabeçalhos de e-mail. Consulte a tabela Facetas para obter mais informações.
`awsAccountId`	O ID da conta da AWS usada para enviar a mensagem.

Aplicativo

Inclui informações sobre o projeto do Amazon Pinpoint ao qual o evento está associado.

Atributo	Descrição
`app_id`	O ID exclusivo do projeto do Amazon Pinpoint que relatou o evento.
`sdk`	O SDK usado para relatar o evento. Se você enviar uma mensagem de e-mail transacional chamando a API do Amazon Pinpoint diretamente ou usando o console do Amazon Pinpoint, esse objeto estará vazio.

Atributos

Inclui informações sobre a campanha ou jornada que produziu o evento.

Campanha

Inclui informações sobre a campanha que produziu o evento.

Atributo	Descrição
`feedback`	Para eventos `_email.click`, o valor desse atributo é o URL do link em que o destinatário clicou para gerar o evento. Para outros eventos, o valor representa o tipo de evento (como, por exemplo, `received`, `opened` ou `clicked`).
`treatment_id`	Se a mensagem foi enviada usando uma campanha de teste A/B, esse valor representa o número de tratamento da mensagem. Para campanhas padrão e mensagens de e-mail transacionais, esse valor é `0`.
`campaign_activity_id`	O ID exclusivo que o Amazon Pinpoint gera quando o evento ocorre.
`campaign_id`	O ID exclusivo da campanha do que enviou a mensagem.

Jornada

Inclui informações sobre a jornada que produziu o evento.

Atributo	Descrição
`journey_run_id`	O ID exclusivo da execução da jornada que enviou a mensagem. O Amazon Pinpoint gera e atribui esse ID automaticamente a cada nova execução de uma jornada.
`feedback`	Para eventos `_email.click`, o valor desse atributo é o URL do link em que o destinatário clicou para gerar o evento. Para outros eventos, o valor representa o tipo de evento (como, por exemplo, `received`, `delivered` ou `opened`).
`journey_id`	O ID exclusivo da jornada que enviou a mensagem.
`journey_activity_id`	O ID exclusivo da atividade de jornada que enviou a mensagem.

Cliente

O identificador exclusivo do cliente que foi alvo da campanha ou da jornada.

Atributo	Descrição
`client_id`	O ID do cliente. O valor é o ID do endpoint para campanhas e jornadas e para envio transacional é um UUID.

Inclui informações sobre a mensagem e o tipo de evento.

Atributo	Descrição
`email_channel`	Contém um objeto `mail_event`, que contém dois objetos: `mail` e um objeto que corresponde ao tipo de evento.

Mail

Inclui informações sobre o conteúdo da mensagem de e-mail, bem como metadados sobre a mensagem.

Atributo	Descrição
`message_id`	O ID exclusivo da mensagem. O Amazon Pinpoint gera automaticamente esse ID quando aceita a mensagem.
`message_send_timestamp`	A data e a hora em que a mensagem foi enviada, no formato especificado em RFC 822.
`from_address`	O endereço de e-mail do qual a mensagem foi enviada.
`destination`	Uma matriz que contém os endereços de e-mail para os quais a mensagem foi enviada.
`headers_truncated`	Um valor booliano que indica se os cabeçalhos de e-mail foram truncados.
`headers`	Um objeto que contém vários pares de nome-valor que correspondem aos cabeçalhos na mensagem. Esse objeto normalmente contém informações sobre os seguintes cabeçalhos: `From`: o endereço de e-mail do remetente. `To`: o endereço de e-mail do destinatário. `Subject`: a linha de assunto do e-mail. dica O cabeçalho do assunto não está incluído nos eventos de campanha _email.send. `MIME-Version`: indica que a mensagem está formato MIME. Se esse cabeçalho estiver presente, o valor será sempre `1.0`. `Content-Type`: o tipo de mídia MIME do conteúdo da mensagem.
`common_headers`	Contém informações sobre vários cabeçalhos comuns de mensagens de e-mail. As informações podem incluir a data em que a mensagem foi enviada e as linhas de para, de e assunto da mensagem.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Dados de evento da jornada do Amazon Pinpoint

Fluxo de dados de evento de SMS do Amazon Pinpoint