Fluxo de dados de eventos da campanha do Amazon Pinpoint - Amazon Pinpoint
Exemplo de evento de campanhaAtributos de eventos de campanha

Fluxo de dados de eventos da campanha do Amazon Pinpoint

Se o Amazon Pinpoint for usado para enviar campanhas através de um canal, o Amazon Pinpoint pode transmitir dados de eventos sobre essas campanhas. Depois de configurar a transmissão de eventos, o Amazon Pinpoint recupera os dados de evento do seu aplicativo para mensagens de e-mail ou SMS que você envia de uma campanha do destino que você especificou durante a configuração, para que você possa visualizá-los. Para obter informações detalhadas sobre os dados transmitidos pelo Amazon Pinpoint para mensagens de e-mail e SMS, consulte Fluxo de dados de evento de e-mail do Amazon Pinpoint e Fluxo de dados de evento de SMS do Amazon Pinpoint. 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 .

Exemplo de evento de campanha

O objeto JSON para um evento de campanha contém os dados mostrados no exemplo a seguir.

{
  "event_type": "_campaign.send",
  "event_timestamp": 1562109497426,
  "arrival_timestamp": 1562109497494,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "d8dcf7c5-e81a-48ae-8313-f540cexample"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "treatment_id": "0",
    "campaign_activity_id": "5473285727f04865bc673e527example",
    "delivery_type": "GCM",
    "campaign_id": "4f8d6097c2e8400fa3081d875example",
    "campaign_send_status": "SUCCESS"
  },
  "client_context": {
    "custom": {
      "endpoint": "{\"ChannelType\":\"GCM\",\"EndpointStatus\":\"ACTIVE\",
          ↳\"OptOut\":\"NONE\",\"RequestId\":\"ec229696-9d1e-11e9-8bf1-85d0aexample\",
          ↳\"EffectiveDate\":\"2019-07-02T23:12:54.836Z\",\"User\":{}}"
    }
  },
  "awsAccountId": "123456789012"
}

Atributos de eventos de campanha

Esta seção define os atributos incluídos nos eventos de streaming da campanha.

Atributo Descrição
event_type

O tipo de evento. Os valores possíveis são:

  • _campaign.send: o Amazon Pinpoint executou a campanha.

  • _campaign.opened_notification: para campanhas de notificação por push, esse tipo de evento indica que o destinatário tocou na notificação para abri-la.

  • _campaign.received_foreground: para campanhas de notificação por push, esse tipo de evento indica que o destinatário recebeu a mensagem como uma notificação em primeiro plano.

  • _campaign.received_background: para campanhas de notificação por push, esse tipo de evento indica que o destinatário recebeu a mensagem como uma notificação em segundo plano.

    nota

    _campaign.opened_notification, _campaign.received_foreground e _campaign.received_background são retornados somente se você usar o AWS Amplify. Para obter mais informações sobre como integrar seu aplicativo com o AWS Amplify. Consulte Conectar o aplicativo de frontend ao Amazon Pinpoint usando o AWS Amplify.
event_timestamp

A hora em que o evento foi relatado, mostrada como horário do Unix em milissegundos.
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. Para obter mais informações, consulte a tabela Aplicativo.
client

Informações sobre o endpoint ao qual o evento está associado. Para obter mais informações, consulte a tabela Cliente.
device

Informações sobre o dispositivo que relatou o evento. Para campanhas e mensagens transacionais, esse objeto está vazio.
session

Informações sobre a sessão que gerou o evento. Para campanhas, esse objeto está vazio.
attributes

Atributos associados ao evento. Para eventos relatados por um de seus aplicativos, esse objeto pode incluir atributos personalizados que são definidos pelo aplicativo. Para eventos criados ao enviar uma campanha, esse objeto contém atributos associados à campanha. Para eventos gerados ao enviar mensagens transacionais, esse objeto contém informações relacionadas à mensagem em si.

Para obter mais informações, consulte a tabela Atributos.
client_context Contém um objeto custom, que contém uma propriedade endpoint. A propriedade endpoint tem o conteúdo do registro de endpoint para o endpoint ao qual a campanha foi enviada.
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.

Atributos

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

Atributo Descrição
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, esse valor é 0.
campaign_activity_id O ID exclusivo que o Amazon Pinpoint gera quando o evento ocorre.
delivery_type

O método de entrega da campanha. Não confunda esse atributo com o campo ChannelType especificado na propriedade endpoint do client_context. O campo ChannelType geralmente se baseia no endpoint para o qual a mensagem está sendo enviada.

Para canais que oferecem suporte a apenas um tipo de endpoint, os campos delivery_type e ChannelType têm o mesmo valor. Por exemplo, para o canal de e-mail, os campos delivery_type e ChannelType têm o mesmo valor de EMAIL.

No entanto, essa condição nem sempre é verdadeira para canais que oferecem suporte a diferentes tipos de endpoints, como canais personalizados. Você pode usar um canal personalizado para diferentes endpoints, como EMAIL, SMS, CUSTOM e assim por diante. Nesse caso, delivery_type identifica um evento de entrega personalizado, CUSTOM, e ChannelType especifica o tipo de endpoint para o qual a campanha foi enviada, como EMAIL, SMS, CUSTOM e assim por diante. Para obter mais informações sobre a criação de canais personalizados, consulte Criar um canal personalizado no Amazon Pinpoint usando um webhook ou uma função do Lambda.

Os valores possíveis são:

  • EMAIL

  • SMS

  • ADM

  • APNS

  • APNS_SANDBOX

  • APNS_VOIP

  • APNS_VOIP_SANDBOX

  • VOICE

  • GCM

  • BAIDU

  • PUSH

  • CUSTOM
campaign_id

O ID exclusivo da campanha da qual a mensagem foi enviada.
campaign_send_status Indica o status da campanha para o endpoint de destino. Os possíveis valores incluem:

  • SUCCESS: a campanha foi enviada com êxito para o endpoint.

  • FAILURE: a campanha não foi enviada para o endpoint.

  • DAILY_CAP: a campanha não foi enviada ao endpoint porque o endpoint já recebeu o número máximo de mensagens diárias.

  • EXPIRED: a campanha não foi enviada ao endpoint porque esse envio excederia as configurações da taxa de envio ou da duração máxima da campanha.

  • QUIET_TIME: a campanha não foi enviada ao endpoint devido às restrições de período de silêncio.

  • HOLDOUT: a campanha não foi enviada ao endpoint porque o endpoint era membro do grupo de holdout.

  • DUPLICATE_ADDRESS: há endereços de endpoint duplicados no segmento. A campanha foi enviada uma vez para o endereço do endpoint.

  • QUIET_TIME: a campanha não foi enviada ao endpoint devido às restrições de período de silêncio.

  • CAMPAIGN_CAP: a campanha não foi enviada ao endpoint porque o endpoint já recebeu o número máximo de mensagens desta campanha.

  • FAILURE_PERMANENT: ocorreu uma falha permanente ao enviar para o endpoint.

  • TRANSIENT_FAILURE: ocorreu uma falha transitória ao enviar para o endpoint.

  • THROTTLED: o envio foi limitado.

  • UNKNOWN: falha desconhecida.

  • HOOK_FAILURE: falha no hook da campanha.

  • CUSTOM_DELIVERY_FAILURE: falha na entrega personalizada.

  • RECOMMENDATION_FAILURE: falha na recomendação.

  • UNSUPPORTED_CHANNEL: o canal não é compatível.

Cliente

Inclui informações sobre o endpoint que foi direcionado pela campanha.

Atributo Descrição
client_id O ID do endpoint para o qual a campanha foi enviada.