Flux de données sur les événements liés à la campagne depuis Amazon Pinpoint - Amazon Pinpoint
Exemple d'événement de campagneAttributs d'événement de campagne

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Flux de données sur les événements liés à la campagne depuis Amazon Pinpoint

Si vous utilisez Amazon Pinpoint pour envoyer des campagnes via un canal, Amazon Pinpoint peut diffuser les données d'événements relatives à ces campagnes. Une fois que vous avez configuré le streaming d'événements, Amazon Pinpoint récupère les données relatives aux événements de votre application pour les e-mails ou les SMS messages que vous envoyez depuis une campagne depuis la destination que vous avez spécifiée lors de la configuration pour que vous puissiez les consulter. Pour obtenir des informations détaillées sur les données diffusées par Amazon Pinpoint pour les e-mails et les SMS messages, consultez Flux de données d'événements par e-mail provenant d'Amazon Pinpoint et. Flux de données d'événements par SMS depuis Amazon Pinpoint Pour plus d'informations sur la configuration de la diffusion d'événements, consultez Configurer Amazon Pinpoint pour diffuser les données d'événements des applications via Amazon Kinesis ou Amazon Data Firehose .

Exemple d'événement de campagne

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

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

Attributs d'événement de campagne

Cette section définit les attributs qui sont inclus dans le flux d'événements de la campagne.

Attribut Description
event_type

Type d'événement. Les valeurs possibles sont :

  • _campaign.send : Amazon Pinpoint a exécuté la campagne.

  • _campaign.opened_notification : pour les campagnes de notification push, ce type d'événement indique que le destinataire a utilisé la notification pour l'ouvrir.

  • _campaign.received_foreground : pour les campagnes de notification push, ce type d'événement indique que le destinataire a reçu le message en tant que notification au premier plan.

  • _campaign.received_background : pour les campagnes de notification push, ce type d'événement indique que le destinataire a reçu le message en tant que notification en arrière plan.

    Note

    _campaign.opened_notification, _campaign.received_foreground et _campaign.received_background sont uniquement renvoyés si vous utilisez AWS Amplify. Pour plus d'informations sur l'intégration de votre application à AWS Amplify. Consultez Connectez votre application frontale à Amazon AWS Pinpoint à l'aide d'Amplify.
event_timestamp

Heure à laquelle l'événement a été signalé, affichée sous la forme Heure Unix en millisecondes.
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 point de terminaison auquel l'événement est associé. Pour plus d'informations, consultez le tableau Client.
device

Informations sur l'appareil qui a signalé l'événement. Pour les messages de campagne et transactionnels, cet objet est vide.
session

Informations sur la session qui a généré l'événement. Pour les campagnes, cet objet est vide.
attributes

Attributs associés à l'événement. 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 une campagne, cet objet contient les attributs associés à la campagne. 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.

Pour plus d'informations, consultez le tableau Attributs.
client_context Contient un objet custom, qui contient une propriété endpoint. La propriété endpoint propriété contient le contenu de l'enregistrement de point de terminaison pour le point de terminaison auquel la campagne a été envoyée.
awsAccountId

L'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.

Attributs

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

Attribut Description
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, cette valeur est 0.
campaign_activity_id ID unique généré par Amazon Pinpoint lorsque l'événement se produit.
delivery_type

Mode de livraison de la campagne. Ne confondez pas cet attribut avec le champ ChannelType spécifié sous la propriété endpoint de client_context. Le champ ChannelType est généralement basé sur le point de terminaison auquel le message est envoyé.

Pour les canaux qui ne prennent en charge qu'un seul type de point de terminaison, les champs delivery_type et ChannelType ont la même valeur. Par exemple, pour le canal e-mail, les ChannelType champs delivery_type et ont la même valeur queEMAIL.

Toutefois, cette condition n'est pas toujours vraie pour les canaux qui prennent en charge différents types de points de terminaison, tels que les canaux personnalisés. Vous pouvez utiliser un canal personnalisé pour différents points de terminaisonEMAIL, tels que SMSCUSTOM,,, etc. Dans ce cas, le delivery_type identifie un événement de livraison personnalisé et ChannelType spécifie le type de point de terminaison auquel la campagne a été envoyée EMAILSMS, tel queCUSTOM,,, etc. CUSTOM Pour en savoir plus sur la création de canaux personnalisés, consultez la section Créez une chaîne personnalisée dans Amazon Pinpoint à l'aide d'un webhook ou d'une fonction Lambda.

Les valeurs possibles sont :

  • EMAIL

  • SMS

  • ADM

  • APNS

  • APNS_SANDBOX

  • APNS_VOIP

  • APNS_VOIP_SANDBOX

  • VOICE

  • GCM

  • BAIDU

  • PUSH

  • CUSTOM
campaign_id

ID unique de la campagne à partir de laquelle le message a été envoyé.
campaign_send_status Indique le statut de la campagne pour le point de terminaison cible. Les valeurs possibles incluent :

  • SUCCESS— La campagne a été envoyée avec succès au terminal.

  • FAILURE— La campagne n'a pas été envoyée au terminal.

  • DAILY_ CAP — La campagne n'a pas été envoyée au terminal car le nombre maximum de messages quotidiens a déjà été envoyé au terminal.

  • EXPIRED— La campagne n'a pas été envoyée au terminal car son envoi dépasserait la durée maximale ou le taux d'envoi définis pour la campagne.

  • QUIET_ TIME — La campagne n'a pas été envoyée au terminal en raison de restrictions temporelles.

  • HOLDOUT— La campagne n'a pas été envoyée au terminal parce que celui-ci était membre du groupe récalcitrant.

  • DUPLICATE_ ADDRESS — Il existe des adresses de point de terminaison dupliquées dans le segment. La campagne a été envoyée une fois à l'adresse du point de terminaison.

  • QUIET_ TIME — La campagne n'a pas été envoyée au terminal en raison de restrictions temporelles.

  • CAMPAIGN_ CAP — La campagne n'a pas été envoyée au point de terminaison car le nombre maximum de messages a déjà été envoyé au point de terminaison à partir de cette campagne.

  • FAILURE_ PERMANENT — Une défaillance permanente s'est produite lors de l'envoi vers le terminal.

  • TRANSIENT_ FAILURE — Une défaillance transitoire s'est produite lors de l'envoi vers le terminal.

  • THROTTLED— L'envoi a été limité.

  • UNKNOWN— Défaillance inconnue.

  • HOOK_ FAILURE — Le hook de campagne a échoué.

  • CUSTOM_ DELIVERY _ FAILURE — La livraison personnalisée a échoué.

  • RECOMMENDATION_ FAILURE — Le recommandateur a échoué.

  • UNSUPPORTED_ CHANNEL — La chaîne n'est pas prise en charge.

Client

Inclut des informations sur le point de terminaison qui a été ciblé par la campagne.

Attribut Description
client_id ID du point de terminaison auquel la campagne a été envoyée.