Passer au contenu principal
Accédez aux données event stream en utilisant la syntaxe Liquid. Enveloppez le point de données souhaité dans {{ }} pour capturer ces données dans l’Event Stream. Voir Exemples.
Limitations des données d’événements de messageLes données des messages envoyés via nos Journeys ou API ne sont disponibles dans notre système que pendant 30 jours. Cela signifie que tous les événements de message (comme les clics, ouvertures, désabonnements, etc.) qui se produisent 30+ jours après l’envoi du message Journey ou API, ne seront pas disponibles dans l’event stream. Cela peut apparaître comme des données vides ou manquantes dans votre analyse.Pour contourner cette limitation, vous pouvez corréler le message_id de ces événements cliqués/ouverts/désabonnés avec l’événement d’envoi original qui a le même message_id. L’événement sent original devrait avoir les données de message pertinentes (titre, modèle, etc).

​
Propriétés event

L’objet event inclut les propriétés suivantes :

​
Kind

Type : String Le type de message (push, email, sms, iam) et l’événement (par ex. received, sent, clicked, failed, unsubscribed, displayed, pagedisplayed, opened, clicked, unsubscribed, reported_as_spam, hardbounced, failed, supressed). Utilisation : {{ event.kind }}
Message Event Kind (OneSignal)Nom de l’événement (dans le jeu de données)Description de l’événement
Push Sentmessage.push.sentNotification push envoyée avec succès aux services push (FCM, APNS, etc).
Push Receivedmessage.push.receivedNotification push reçue par le destinataire. Non disponible sur toutes les plateformes. Voir Livraison confirmée pour plus de détails.
Push Clickedmessage.push.clickedL’utilisateur a appuyé sur la notification push pour ouvrir l’application sur l’appareil.
Push Failedmessage.push.failedÉchec de l’envoi push. Voir les Rapports de messages push pour plus de détails.
Push Unsubscribedmessage.push.unsubscribedL’utilisateur s’est désabonné de l’abonnement push. Voir Quand les statuts d’abonnement push sont-ils mis à jour ?.
In-App Impressionmessage.iam.displayedMessage in-app affiché avec succès sur l’appareil.
In-App Clickedmessage.iam.clickedL’utilisateur a appuyé sur un élément du message in-app.
In-App Page Displayedmessage.iam.pagedisplayedLa page du message in-app a été affichée. Utile pour suivre les carrousels.
Email Sentmessage.email.sentE-mail envoyé avec succès.
Email Receivedmessage.email.receivedE-mail reçu par le destinataire.
Email Openedmessage.email.openedE-mail ouvert par le destinataire. Voir Rapports de messages e-mail pour plus de détails.
Email Link Clickedmessage.email.clickedL’utilisateur a appuyé sur un lien dans l’e-mail.
Email Unsubscribedmessage.email.unsubscribedL’utilisateur s’est désabonné de l’e-mail via le lien de désabonnement.
Email Reported As Spammessage.email.reported_as_spamL’utilisateur a signalé l’e-mail comme spam. Gmail nécessite Google Postmaster Tools pour suivre. Voir Délivrabilité des e-mails pour plus de détails.
Email Bouncedmessage.email.hardbouncedE-mail retourné à l’expéditeur en raison d’une erreur permanente. Voir Rapports de messages e-mail pour plus de détails.
Email Failedmessage.email.failedL’e-mail n’a pas pu être livré. Voir Rapports de messages e-mail pour plus de détails.
Email Suppressedmessage.email.supressedL’e-mail n’a pas pu être envoyé car l’adresse e-mail est sur la Liste de suppression.
SMS Sentmessage.sms.sentSMS envoyé au destinataire
SMS Failedmessage.sms.failedÉchec de l’envoi du SMS. Voir Rapports de messages SMS pour plus de détails.
SMS Deliveredmessage.sms.deliveredSMS livré avec succès
SMS Undeliveredmessage.sms.undeliveredLe SMS n’a pas pu être envoyé. Voir Rapports de messages SMS pour plus de détails.

​
Event ID

Type : UUID Un identifiant unique généré par OneSignal pour chaque événement individuel au format UUID v4. Utilisez cet ID pour le suivi de livraison idempotent. Si vous recherchez l’identifiant de message ou de modèle spécifique, utilisez message.id ou message.template_id. Utilisation : {{ event.id }}

​
Timestamp

Type : Integer L’horodatage UNIX de l’événement. Utilisation : {{ event.timestamp }}

​
UTC datetime

Type : String Une heure lisible de l’événement en UTC (spécifiquement une chaîne ISO comme “2024-02-21T23:45:15.228Z”). Utilisation : {{ event.datetime }}

​
App ID

Type : UUID L’App ID OneSignal. Utilisation : {{ event.app_id }}

​
Subscription type

Type : String Le type d’abonnement (par ex. iOS, Android, Chrome, Email, SMS, etc). Utilisation : {{ event.subscription_device_type }}

​
Subscription ID

Type : UUID L’ID d’abonnement OneSignal. Utilisation : {{ event.subscription_id }}

​
OneSignal User ID

Type : UUID L’ID utilisateur créé par OneSignal. Utilisation : {{ event.onesignal_id }}

​
External User ID

Type : String Votre ID utilisateur défini comme alias ID externe OneSignal. Peut être vide s’il n’est pas défini dans OneSignal. Utilisation : {{ event.external_id }}

​
In-app message page name

Type : String Le nom de la page ou de la carte affichée pour certains événements de message in-app. Voir Event Streams de messages in-app pour plus de détails. Utilisation : {{ event.data.page_name }}

​
In-app message page ID

Type : String Un identifiant unique pour la page ou la carte affichée pour certains événements de message in-app. Voir Event Streams de messages in-app pour plus de détails. Utilisation : {{ event.data.page_id }}

​
In-app message target name

Type : String Le nom du bouton ou de l’élément de bloc d’image cliqué. Doit contenir une Action de clic in-app. Voir Event Streams de messages in-app pour plus de détails. Utilisation : {{ event.data.target_name }}

​
In-app message target ID

Type : String Un identifiant unique pour le bouton ou l’élément de bloc d’image cliqué. Doit contenir une Action de clic in-app. Voir Event Streams de messages in-app pour plus de détails. Utilisation : {{ event.data.target_id }}

​
Exemple d’entrée

{
  "event.kind": "{{ event.kind }}",
  "event.id": "{{ event.id }}",
  "event.timestamp": "{{ event.timestamp }}",
  "event.datetime": "{{ event.datetime }}",
  "event.app_id": "{{ event.app_id }}",
  "event.subscription_device_type": "{{ event.subscription_device_type }}",
  "event.subscription_id": "{{ event.subscription_id }}",
  "event.onesignal_id": "{{ event.onesignal_id }}",
  "event.external_id": "{{ event.external_id }}",
  "event.data.page_name": "{{ event.data.page_name}}",
  "event.data.page_id": "{{ event.data.page_id}}",
  "event.data.target_name": "{{ event.data.target_name}}",
  "event.data.target_id": "{{ event.data.target_id}}"
}

​
Propriétés de message

L’objet message est conçu pour vous tenir informé des messages envoyés à l’utilisateur final. Il inclut des propriétés comme id, template_id et content, qui contient le texte réel du message.

​
Message ID

Type : UUID L’ID de message généré par OneSignal. Utilisation : {{ message.id }}

​
Message Name

Type : String Le nom du message tel que défini dans le tableau de bord ou en utilisant la propriété name de l’API. Utilisation : {{ message.name }}

​
Message Title

Type : Object Le titre du message push ou l’objet de l’e-mail tel que défini dans le tableau de bord ou en utilisant les propriétés headings ou email_subject de l’API. Utilisation : {{ message.title }}

​
Message Contents

Type : Object Le contenu du message push ou SMS tel que défini dans le tableau de bord ou en utilisant la propriété contents de l’API (tronqué à 50 caractères). Le contenu de l’e-mail (email_body) n’est pas fourni. Utilisation : {{ message.contents }}

​
Template ID

Type : UUID L’ID de modèle pour un message envoyé via Journeys ou la propriété template_id de l’API. Utilisation : {{ message.template_id }}

​
Launch URL

Type : String L’URL de lancement du message (lors de l’utilisation d’une seule URL qui est agnostique au web et à l’application). Voir URLs, Liens et Liens profonds pour plus de détails. Utilisation : {{ message.url }}

​
App-Specific URL

Type : String L’URL de lancement du message lors de l’utilisation d’une URL spécifique au web et à l’application. Voir URLs, Liens et Liens profonds pour plus de détails. Utilisation : {{ message.app_url }}

​
Web-Specific URL

Type : String L’URL de lancement du message lors de l’utilisation d’une URL spécifique au web et à l’application. Voir URLs, Liens et Liens profonds pour plus de détails. Utilisation : {{ message.web_url }}

​
Exemple d’objet message

{
  "message.id": "f3c9cd09-10d7-4f59-b9bc-66e16607f1d5",
  "message.name": "the-name-you-set",
  "message.title": "Claim 50% Off Today", // exemple d'objet e-mail
  "message.title": "{'en':'the message title/headings'}", // exemple de titre push
  "message.contents": "{'en':'the message content'}",
  "message.template_id": "the-template-uuid-if-set",
  "message.url": "the-message-url",
  "message.app_url": "the-message-app-url",
  "message.web_url": "the-message-web-url"
}

​
Propriétés utilisateur

​
OneSignal ID

Type : String L’ID OneSignal de l’utilisateur. Utilisation {{ user.onesignal_id }}

​
External ID

Type : String L’ID externe de l’utilisateur. Utilisation : {{ user.external_id }}

​
Tags

Type : Object Les balises de l’utilisateur. Utilisation :
  • Objet balises : {{ user.tags }}
  • Chaîne de balise spécifique : {{ user.tags.your_tag }}
  • Si vous essayez d’obtenir toutes les balises, référencez l’objet balises comme {{ user.tags}}.
  • Si vous essayez d’obtenir une balise spécifique, référencez la balise comme une chaîne comme : "{{ user.tags.your_tag | default: '' }}".

​
Language

Type : String La langue de l’utilisateur. Utilisation : {{ user.language }}

​
Propriétés d’abonnement

​
Subscription ID

Type : String L’ID de l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.id }}

​
App ID

Type : String L’ID de l’application. Utilisation : {{ user.subscription.app_id }}

​
Subscription Token

Type : String Le jeton pour l’abonnement auquel le message a été envoyé.
  • Si le type est E-mail, le jeton sera une adresse e-mail.
  • Si le type est SMS, le jeton sera un numéro de téléphone au format E.164.
  • Si le type est l’une des options Push, le jeton sera un jeton push.
Utilisation : {{ user.subscription.subscription_token }}

​
Session Count

Type : Number Le nombre de sessions pour l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.session_count }}

​
Language

Type : String La langue définie sur l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.language }}

​
Game Version

Type : String La version du jeu définie sur l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.game_version }}

​
Last Active

Type : Number L’heure de dernière activité définie sur l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.last_active }}

​
Play Time

Type : Number Le temps de jeu défini sur l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.play_time }}

​
Amount Spent

Type : Number Le montant dépensé sur l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.amount_spent }}

​
Created At

Type : Number L’heure de création de l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.created_at }}

​
Subscribed

Type : Boolean Indique si l’abonnement auquel le message a été envoyé est actuellement abonné. Utilisation : {{ user.subscription.subscribed }}

​
SDK

Type : String La version du SDK définie sur l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.sdk }}

​
Device Model

Type : String Le modèle d’appareil défini sur l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.device_model }}

​
Device OS

Type : String Le système d’exploitation de l’appareil défini sur l’abonnement auquel le message a été envoyé. Utilisation : {{ user.subscription.device_os }}

​
Tags

Type : Object Les balises de l’utilisateur. Vous pouvez accéder à l’objet entier ou à des balises spécifiques. Utilisation :
  • Toutes les balises : {{ user.tags }}
  • Balise spécifique : {{ user.tags.your_tag }}