Ejemplo de evento de campaña Atributos de los eventos de campaña

Flujo de datos de eventos de campaña desde Amazon Pinpoint

Si utiliza Amazon Pinpoint para enviar campañas a través de un canal, Amazon Pinpoint puede transmitir datos de eventos sobre esas campañas. Tras configurar la transmisión de eventos, Amazon Pinpoint recupera los datos de los eventos de la aplicación para los mensajes de correo electrónico o SMS que usted envíe desde una campaña desde el destino que haya especificado durante la configuración para que pueda verlos. Para obtener información detallada sobre los datos que Amazon Pinpoint transmite para mensajes de correo electrónico y SMS, consulte Flujo de datos de eventos de correo electrónico desde Amazon Pinpoint y Flujo de datos de eventos de SMS desde Amazon Pinpoint. Para obtener información sobre cómo configurar transmisiones de eventos, consulte Configurar Amazon Pinpoint para transmitir datos de eventos de aplicación a través de Amazon Kinesis o Amazon Data Firehose .

Ejemplo de evento de campaña

El objeto JSON para un evento de campaña contiene los datos que se muestran en el siguiente ejemplo.


{
  "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 los eventos de campaña

En esta sección se definen los atributos que se incluyen en la secuencia de eventos de la campaña.

Atributo	Descripción
`event_type`	El tipo de evento. Los valores posibles son los siguientes: _campaign.send: Amazon Pinpoint ejecutó la campaña. _campaign.opened_notification: para las campañas de notificaciones de inserción, este tipo de evento indica que el destinatario tocó la notificación para abrirla. _campaign.received_foreground: para las campañas de notificaciones de inserción, este tipo de evento indica que el destinatario recibió el mensaje como una notificación en primer plano. _campaign.received_background: para las campañas de notificaciones de inserción, este tipo de evento indica que el destinatario recibió el mensaje como una notificación en primer plano. nota _campaign.opened_notification, _campaign.received_foreground y _campaign.received_background se devuelven solo si usa AWS Amplify. Para obtener más información sobre la integración de la aplicación con AWS Amplify. Consulte Conectar la aplicación frontend a Amazon Pinpoint mediante AWS Amplify.
`event_timestamp`	La hora a la que se notificó el evento, que se muestra en formato de tiempo Unix en milisegundos.
`arrival_timestamp`	La hora a la que Amazon Pinpoint recibió el evento, que se muestra en formato de tiempo Unix en milisegundos.
`event_version`	La versión del esquema JSON del evento. sugerencia Compruebe esta versión en la aplicación de procesamiento de eventos para saber cuándo actualizar la aplicación en respuesta a una actualización del esquema.
`application`	Información sobre el proyecto de Amazon Pinpoint asociado al evento. Consulte la tabla de la sección Application (Aplicación) para obtener más información.
`client`	Información sobre el punto de enlace al que está asociado el evento. Consulte la tabla de la sección Client (Cliente) para obtener más información.
`device`	Información sobre el dispositivo que notificó el evento. Para los mensajes de campaña y de transacciones, este objeto está vacío.
`session`	Información sobre la sesión que generó el evento. Para las campañas, este objeto está vacío.
`attributes`	Atributos asociados al evento. Para los eventos notificados por una de sus aplicaciones, este objeto puede incluir atributos personalizados definidos por la aplicación. Para los eventos que se crean al enviar una campaña, este objeto contiene atributos asociados a la campaña. Para los eventos que se generan al enviar mensajes de transacciones, este objeto contiene información relacionada con el propio mensaje. Consulte la tabla de la sección Attributes (Atributos) para obtener más información.
`client_context`	Contiene un objeto `custom`, que contiene una propiedad `endpoint`. La propiedad `endpoint` contiene el contenido del registro del punto de enlace al que se envió la campaña.
`awsAccountId`	El ID de la cuenta de AWS de que se utilizó para enviar el mensaje.

Aplicación

Incluye información sobre el proyecto de Amazon Pinpoint al que está asociado el evento.

Atributo	Descripción
`app_id`	El ID único del proyecto de Amazon Pinpoint que notificó el evento.
`sdk`	El SDK que se utilizó para notificar el evento.

Atributos

Incluye información sobre la campaña que produjo el evento.

Atributo	Descripción
`treatment_id`	Si el mensaje se envió mediante una campaña de prueba A/B, este valor representa el número de tratamiento del mensaje. Para las campañas estándar, este valor es `0`.
`campaign_activity_id`	El ID único que Amazon Pinpoint genera cuando se produce el evento.
`delivery_type`	El método de entrega de la campaña. No confunda este atributo con el campo `ChannelType` especificado en la propiedad `endpoint` de `client_context`. El campo `ChannelType` se basa normalmente en el punto de conexión al que se envía el mensaje. En el caso de los canales que admiten solo un tipo de punto de conexión, los campos `delivery_type` y `ChannelType` tienen el mismo valor. Por ejemplo, para el canal de correo electrónico, los campos `delivery_type` y `ChannelType` tienen el mismo valor de CORREO ELECTRÓNICO. Sin embargo, esta condición no siempre se cumple en los canales que admiten distintos tipos de puntos de conexión, como los canales personalizados. Puede usar un canal personalizado para distintos puntos de conexión, como EMAIL, SMS, CUSTOM, etc. En este caso, `delivery_type` identifica un evento de entrega personalizado, CUSTOM, y `ChannelType` especifica el tipo de punto de conexión al que se envió la campaña, como EMAIL, SMS, CUSTOM, etc. Para obtener más información sobre la creación de canales personalizados, consulte Crear un canal personalizado en Amazon Pinpoint mediante un webhook o una función de Lambda. Los valores posibles son los siguientes: CORREO ELECTRÓNICO SMS ADM APNS APNS_SANDBOX APNS_VOIP APNS_VOIP_SANDBOX VOZ GCM BAIDU INSERCIÓN PERSONALIZAR
`campaign_id`	El ID único de la campaña desde la que se envió el mensaje.
`campaign_send_status`	Indica el estado de la campaña para el punto de enlace de destino. Los valores posibles son: SUCCESS: la campaña se envió correctamente al punto de conexión. FAILURE: la campaña no se envió al punto de conexión. DAILY_CAP: la campaña no se envió al punto de conexión porque ya se ha enviado el número máximo de mensajes diarios al punto de conexión. EXPIRED: la campaña no se envió al punto de conexión porque su envío superaría la duración máxima o la velocidad de envío configuradas para la campaña. QUIET_TIME: la campaña no se envió al punto de conexión debido a las restricciones de tiempo de inactividad. HOLDOUT: la campaña no se envió al punto de conexión porque el punto de conexión era miembro del grupo de espera. DUPLICATE_ADDRESS: hay direcciones de punto de conexión duplicadas en el segmento. La campaña se envió una vez a la dirección del punto de conexión. QUIET_TIME: la campaña no se envió al punto de conexión debido a las restricciones de tiempo de inactividad. CAMPAIGN_CAP: la campaña no se envió al punto de conexión porque ya se ha enviado el número máximo de mensajes al punto de conexión de esta campaña. FAILURE_PERMANENT: se ha producido un error permanente al enviar al punto de conexión. TRANSIENT_FAILURE: se ha producido un error transitorio al enviar al punto de conexión. THROTTLED: el envío estaba limitado. UNKNOWN: error desconocido. HOOK_FAILURE: se ha producido un error en el enlace de la campaña. CUSTOM_DELIVERY_FAILURE: se ha producido un error al realizar entrega personalizada. RECOMMENDATION_FAILURE: no se ha podido realizar la recomendación. UNSUPPORTED_CHANNEL: el canal no es compatible.

Cliente

Incluye información sobre el punto de enlace al que se dirigía la campaña.

Atributo	Descripción
`client_id`	El ID del punto de enlace al que se envió la campaña.

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Flujo de datos de eventos de aplicación desde Amazon Pinpoint

Datos de eventos de recorrido de Amazon Pinpoint