Use the search bar or the checkboxes below to find the events you need to use Currents effectively.
These schema consist of the Braze Events that are directly related to message sending.
Les schémas de stockage s’appliquent aux données d’événements sous forme de fichiers plats que nous envoyons aux partenaires de stockage de l’entrepôt de données (Google Cloud Storage, Amazon S3 et Microsoft Azure Blob Storage). Pour les schémas qui s’appliquent aux autres partenaires, reportez-vous à notre liste de partenaires disponibles et consultez leurs pages respectives.
Contactez votre gestionnaire de compte ou ouvrez un ticket d’assistance si vous avez besoin d’accéder à des droits d’événements supplémentaires. Si vous ne trouvez pas ce dont vous avez besoin dans cet article, consultez notre bibliothèque d’événements du comportement des clients ou nos exemples de données comportement ales Currents.
Explanation of message engagement event structure and platform values
Structure de l’événement
Cette répartition des événements montre quel type d’information est généralement inclus dans un événement d’engagement lié aux messages. Avec une solide compréhension de ses composants, vos développeurs et votre équipe de stratégie d’aide à la décision peuvent utiliser les données d’événement entrantes de Teams pour réaliser des rapports et des graphiques axés sur les données, et tirer parti d’autres indicateurs de données précieux.
Ventilation d’un événement d’engagement aux messages montrant un événement de désinscription par e-mail avec les propriétés énumérées regroupées par propriétés spécifiques à l’utilisateur, propriétés de suivi de la campagne ou du canvas, et propriétés spécifiques à l’événement.](/docs/fr/assets/img/message_engagement_event.png?1900fbac19728048e7415d77d92bfb29)
Les événements d’engagement aux messages se composent de propriétés propres à l’utilisateur, de propriétés de suivi de la campagne/du canevas et de propriétés propres à l’événement.
Schéma de l’ID de l’utilisateur
Notez les conventions d’appellation pour les ID d’utilisateurs.
| Schéma de Braze |
Schéma actuel |
Description |
braze_id |
"USER_ID" |
L’identifiant unique qui est automatiquement attribué par Braze. |
external_id |
"EXTERNAL_USER_ID" |
L’identifiant unique du profil d’un utilisateur qui est défini par le client. |
Certains événements renvoient une valeur platform qui précise la plate-forme de l’appareil de l’utilisateur.
Le tableau suivant détaille les valeurs de retour possibles :
| Appareil de l’utilisateur |
Valeur de la plate-forme |
| iOS |
ios |
| Android |
android |
| FireTV |
kindle |
| Kindle |
kindle |
| Web |
web |
| tvOS |
tvos |
| Roku |
roku |
important:
Currents abandonnera les événements dont la charge utile est excessivement importante (plus de 900 Ko).
note:
Certains champs peuvent prendre plus de temps pour afficher leur état le plus récent après la mise à jour d’une campagne ou d’un canvas. Ces champs sont les suivants :
- "campaign_name"
- "canvas_name"
- "canvas_step_name"
- "conversion_behavior"
- "canvas_variation_name"
- "experiment_split_name"
- "message_variation_name"
Si une cohérence totale est requise, nous vous recommandons d’attendre une heure après la dernière mise à jour de ces champs avant d’envoyer vos messages à vos utilisateurs.
Désinstaller des événements
Cet événement se produit lorsqu’un utilisateur désinstalle une application. Utilisez ces données pour savoir quand les utilisateurs désinstallent une appli. Bien qu’il s’agisse actuellement d’un événement d’engagement lié aux messages, il s’agira à l’avenir d’un événement lié au comportement de l’utilisateur.
important:
Cet événement n’est pas déclenché lorsque l’utilisateur désinstalle réellement l’application, car il est impossible de le suivre exactement. Braze envoie un push silencieux quotidien pour déterminer si l’application existe toujours sur l’appareil de votre utilisateur, et si nous obtenons une erreur lors de ce push silencieux, nous supposons que l’application a été désinstallée.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
| // Uninstall (users.behaviors.Uninstall)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
| // Uninstall (users.behaviors.Uninstall)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Application Uninstalls (users.behaviors.Uninstall)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| // Application Uninstalled (users.behaviors.Uninstall)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"device_id" : "(optional, string) ID of the device on which the event occurred"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
| // users.behaviors.Uninstall
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements de changement d’état de l’abonnement global
Cet événement se produit lorsque Braze reçoit une demande de mise à jour de l’état d’abonnement global de l’utilisateur, même si la demande ne modifie pas l’état d’abonnement actuel de l’utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Global Subscription State Change (users.behaviors.subscription.GlobalStateChange)
{
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"email_address" : "(optional, string) [PII] Email address of the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_status" : "(required, string) Subscription status: 'Subscribed', 'Unsubscribed' or 'Opted In'",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Global Subscription State Change (users.behaviors.subscription.GlobalStateChange)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(optional, string) [PII] Email address of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_status" : "(required, string) Subscription status: 'Subscribed', 'Unsubscribed' or 'Opted In'",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
| // Global Subscription State Changes (users.behaviors.subscription.GlobalStateChange)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_status" : "(required, string) Subscription status: 'Subscribed', 'Unsubscribed' or 'Opted In'"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(optional, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Global Subscription State Changed (users.behaviors.subscription.GlobalStateChange)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(optional, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_status" : "(required, string) Subscription status: 'Subscribed', 'Unsubscribed' or 'Opted In'"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // users.behaviors.subscription.GlobalStateChange
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"email_address" : "(optional, string) [PII] Email address of the user",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"send_id" : "(optional, string) Message send ID this message belongs to",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_status" : "(required, string) Subscription status: 'Subscribed', 'Unsubscribed' or 'Opted In'",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
state_change_source renvoie une chaîne de caractères contenant le nom complet de la source. Par exemple, l’importation du fichier CSV source renverra la chaîne de caractères CSV Import. Les sources disponibles sont énumérées ci-dessous :
| Source |
Description |
| SDK |
Les endpoints du SDK |
| Tableau de bord |
Lorsque l’état de l’abonnement d’un utilisateur est mis à jour à partir de la page Profil de l’utilisateur dans le tableau de bord |
| Page d’abonnement |
Lorsqu’un utilisateur se désinscrit par le biais d’un lien d’e-mail qui n’est pas le centre de préférences |
| API REST |
Points d’extrémité de l’API REST |
| Importation CSV |
Importation d’utilisateurs CSV |
| Centre de préférences |
Lorsqu’un utilisateur est mis à jour à partir du centre de préférences |
| Message entrant |
Lorsqu’un utilisateur est mis à jour par des messages entrants provenant d’utilisateurs finaux par le biais de canaux, tels que les SMS |
| Migration |
Lorsqu’un utilisateur est mis à jour par des migrations internes ou des scripts de maintenance. |
| Fusion d’utilisateurs |
Lorsqu’un utilisateur est mis à jour par le processus de fusion des utilisateurs |
| Étape de mise à jour de l’utilisateur de Canvas |
Lorsqu’un utilisateur est mis à jour par l’étape du canvas de mise à jour de l’utilisateur |
| Enregistrement du jeton de poussée |
Lorsqu’un utilisateur est mis à jour par le processus d’enregistrement des jetons |
| List-Unsubscribe |
Lorsqu’un utilisateur se désabonne via un mailto de Braze ou une liste en un clic, l’en-tête “unsubscribe” est affiché. |
| Autre |
Inclut toutes les autres sources, telles que les tâches de synchronisation des démos ou des fournisseurs, ou les rappels d’événements SMS et Whatsapp. |
Événements de changement d’état du groupe d’abonnement
Cet événement se produit lorsque l’état de l’abonnement d’un utilisateur dans un groupe d’abonnement change.
important:
Les groupes d’abonnement ne sont pour l’instant disponibles que pour les canaux e-mail, SMS et WhatsApp.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Subscription Group State Change (users.behaviors.subscriptiongroup.StateChange)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(optional, string) [PII] Email address of the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_group_id" : "(required, string) Subscription group API ID",
"subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Subscription Group State Change (users.behaviors.subscriptiongroup.StateChange)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(optional, string) [PII] Email address of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_group_id" : "(required, string) Subscription group API ID",
"subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
| // Subscription Group State Changes (users.behaviors.subscriptiongroup.StateChange)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_group_id" : "(required, string) Subscription group API ID",
"subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(optional, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| // Subscription Group State Changed (users.behaviors.subscriptiongroup.StateChange)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(optional, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_group_id" : "(required, string) Subscription group API ID",
"subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.behaviors.subscriptiongroup.StateChange
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"channel" : "(optional, string) Channel this event belongs to",
"channel_identifier" : "(optional, string) [PII] The user's identifier on the channel the event is for.",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(optional, string) [PII] Email address of the user",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"phone_number" : "(optional, string) [PII] Phone number of the user in e.164 format (for example +14155552671)",
"send_id" : "(optional, string) Message send ID this message belongs to",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"subscription_group_id" : "(required, string) Subscription group API ID",
"subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
state_change_source renvoie une chaîne de caractères contenant le nom complet de la source. Par exemple, l’importation du fichier CSV source renverra la chaîne de caractères CSV Import. Les sources disponibles sont énumérées ci-dessous :
| Source |
Description |
| SDK |
Les endpoints du SDK |
| Tableau de bord |
Lorsque l’état de l’abonnement d’un utilisateur est mis à jour à partir de la page Profil de l’utilisateur dans le tableau de bord |
| Page d’abonnement |
Lorsqu’un utilisateur se désinscrit par le biais d’un lien d’e-mail qui n’est pas le centre de préférences |
| API REST |
Points d’extrémité de l’API REST |
| Importation CSV |
Importation d’utilisateurs CSV |
| Centre de préférences |
Lorsqu’un utilisateur est mis à jour à partir du centre de préférences |
| Message entrant |
Lorsqu’un utilisateur est mis à jour par des messages entrants provenant d’utilisateurs finaux par le biais de canaux tels que les SMS |
| Migration |
Lorsqu’un utilisateur est mis à jour par des migrations internes ou des scripts de maintenance. |
| Fusion d’utilisateurs |
Lorsqu’un utilisateur est mis à jour par le processus de fusion des utilisateurs |
| Étape de mise à jour de l’utilisateur de Canvas |
Lorsqu’un utilisateur est mis à jour par l’étape du canvas de mise à jour de l’utilisateur |
Campagne Événements de conversion
Cet événement se produit lorsqu’un utilisateur effectue une action qui a été définie comme un événement de conversion dans une campagne.
note:
dispatch_id est obsolète et sera supprimée dans la prochaine version de Currents.
important:
Notez que l’événement de conversion est encodé dans le champ conversion_behavior, qui comprend le type d’événement de conversion, la fenêtre (délai) et des informations supplémentaires en fonction du type d’événement de conversion. Le champ conversion_behavior_index représente l’événement de conversion, par exemple 0 = A, 1 = B, 2 = C, 3 = D.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
| // Campaign Conversion (users.campaigns.Conversion)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| // Campaign Conversion (users.campaigns.Conversion)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Campaign Conversions (users.campaigns.Conversion)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Campaign Converted (users.campaigns.Conversion)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
| // users.campaigns.Conversion
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(required, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Groupe de contrôle de la campagne Événements liés à l’inscription
Cet événement se produit lorsqu’un utilisateur est inscrit à un ensemble de variantes de contrôle dans le cadre d’une campagne à variantes multiples. Cet événement est généré car il n’y aura pas d’événement d’envoi de canal pour cet utilisateur.
note:
dispatch_id est obsolète et sera supprimée dans la prochaine version de Currents.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
| // Campaign Control Group Enrollment (users.campaigns.EnrollInControl)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
| // Campaign Control Group Enrollment (users.campaigns.EnrollInControl)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Campaign Control Group Enrollments (users.campaigns.EnrollInControl)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // Campaign Control Group Entered (users.campaigns.EnrollInControl)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| // users.campaigns.EnrollInControl
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(required, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements de conversion de canvas
Cet événement se produit lorsqu’un utilisateur effectue une action qui a été définie comme un événement de conversion dans Canvas.
important:
Notez que l’événement de conversion est encodé dans le champ conversion_behavior, qui comprend le type d’événement de conversion, la fenêtre (délai) et des informations supplémentaires en fonction du type d’événement de conversion. Le champ conversion_behavior_index représente l’événement de conversion, par exemple 0 = A, 1 = B, 2 = C, 3 = D.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
| // Canvas Conversion (users.canvas.Conversion)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| // Canvas Conversion (users.canvas.Conversion)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Canvas Conversions (users.canvas.Conversion)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Canvas Converted (users.canvas.Conversion)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"device_id" : "(optional, string) ID of the device on which the event occurred"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| // users.canvas.Conversion
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"canvas_id" : "(required, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(required, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements d’entrée dans le canevas
Cet événement se produit lorsqu’un utilisateur entre dans le Canvas. Cet événement vous indique dans quelle variante l’utilisateur est entré.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
| // Canvas Entry (users.canvas.Entry)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
| // Canvas Entry (users.canvas.Entry)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group",
"$insert_id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // Canvas Entries (users.canvas.Entry)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // Canvas Entered (users.canvas.Entry)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
| // users.canvas.Entry
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(required, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(required, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Exit Match Audience events
Cet événement se produit lorsqu’un utilisateur a quitté un canvas en correspondant à une audience.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
| // Exit Match Audience (users.canvas.exit.MatchedAudience)
{
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| // Exit Match Audience (users.canvas.exit.MatchedAudience)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Exit Matched Audiences (users.canvas.exit.MatchedAudience)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| // Exit Matched Audience (users.canvas.exit.MatchedAudience)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| // users.canvas.exit.MatchedAudience
{
"app_group_api_id" : "(optional, string) [DEPRECATED]",
"app_group_id" : "(required, string) API ID of the app group this user belongs to",
"canvas_api_id" : "(optional, string) [DEPRECATED]",
"canvas_id" : "(required, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_api_id" : "(optional, string) [DEPRECATED]",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_api_id" : "(optional, string) [DEPRECATED]",
"canvas_variation_id" : "(required, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Cet événement se produit lorsqu’un utilisateur a quitté un canvas en effectuant un événement.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
| // Exit Perform Event (users.canvas.exit.PerformedEvent)
{
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| // Exit Perform Event (users.canvas.exit.PerformedEvent)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Exit Performed Events (users.canvas.exit.PerformedEvent)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| // Exit Performed Event (users.canvas.exit.PerformedEvent)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| // users.canvas.exit.PerformedEvent
{
"app_group_api_id" : "(optional, string) [DEPRECATED]",
"app_group_id" : "(required, string) API ID of the app group this user belongs to",
"canvas_api_id" : "(optional, string) [DEPRECATED]",
"canvas_id" : "(required, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_api_id" : "(optional, string) [DEPRECATED]",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_api_id" : "(optional, string) [DEPRECATED]",
"canvas_variation_id" : "(required, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Expérience Étape Événements de conversion
Cet événement se produit lorsqu’un utilisateur se convertit pour une étape de l’expérience Canvas.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| // Experiment Step Conversion (users.canvas.experimentstep.Conversion)
{
"event_properties" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
| // Experiment Step Conversion (users.canvas.experimentstep.Conversion)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"distinct_id" : "(required, string) [PII] External ID of the user",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to",
"$insert_id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // Experiment Step Conversions (users.canvas.experimentstep.Conversion)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Experiment Step Converted (users.canvas.experimentstep.Conversion)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
| // users.canvas.experimentstep.Conversion
{
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior",
"conversion_behavior_index" : "(optional, int) Index of the conversion behavior",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Expérimenter les événements d’entrée fractionnée
Cet événement se produit lorsqu’un utilisateur entre dans un chemin d’étape des chemins d’expérience Canvas.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
| // Experiment Split Entry (users.canvas.experimentstep.SplitEntry)
{
"event_properties" : {
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
| // Experiment Split Entry (users.canvas.experimentstep.SplitEntry)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"distinct_id" : "(required, string) [PII] External ID of the user",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group",
"$insert_id" : "(required, string) Globally unique ID for this event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Experiment Split Entries (users.canvas.experimentstep.SplitEntry)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // Experiment Split Entered (users.canvas.experimentstep.SplitEntry)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
| // users.canvas.experimentstep.SplitEntry
{
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in",
"experiment_split_name" : "(optional, string) Name of the experiment split",
"experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"in_control_group" : "(required, boolean) Whether the user was enrolled in the control group",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements de progression à l’étape du canvas
Cet événement se produit lorsqu’un utilisateur franchit une étape d’un canvas avec un certain résultat. Notez que cet événement ne se produit pas lors de l’entrée ou de la sortie d’une étape. Actuellement, seules les étapes d’éclatement (parcours d’audience, éclatement de décision, parcours d’action, expérience) et les résultats d’avancement génèrent des événements de progression d’étape.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
| // Canvas Step Progression (users.canvasstep.Progression)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step",
"is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas",
"next_step_id" : "(optional, string) API ID of the next step in the canvas",
"progression_type" : "(required, string) What type of step progression event this is"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // Canvas Step Progression (users.canvasstep.Progression)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step",
"$insert_id" : "(required, string) Globally unique ID for this event",
"is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas",
"next_step_id" : "(optional, string) API ID of the next step in the canvas",
"progression_type" : "(required, string) What type of step progression event this is",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
| // Canvas Step Progressions (users.canvasstep.Progression)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step",
"is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas",
"next_step_id" : "(optional, string) API ID of the next step in the canvas",
"progression_type" : "(required, string) What type of step progression event this is",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Canvas Step Progression (users.canvasstep.Progression)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step",
"is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas",
"next_step_id" : "(optional, string) API ID of the next step in the canvas",
"progression_type" : "(required, string) What type of step progression event this is"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
| // users.canvasstep.Progression
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"exit_reason" : "(optional, string) If this is an exit, the reason a user exited the canvas during the step",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"is_canvas_entry" : "(optional, boolean) Whether this is entry into a first step in a canvas",
"next_step_id" : "(optional, string) API ID of the next step in the canvas",
"progression_type" : "(required, string) What type of step progression event this is",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Bannière Événements d’abandon
Cet événement se produit lorsqu’un message de bannière initialement planifié a été interrompu pour une raison quelconque.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Banner Abort (users.messages.banner.Abort)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_model" : "(optional, string) Model of the device",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Banner Abort (users.messages.banner.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
| // Banner Aborts (users.messages.banner.Abort)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Banner Aborted (users.messages.banner.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // users.messages.banner.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"carrier" : "(optional, string) Carrier of the device",
"country" : "(optional, string) [PII] Country of the user",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"gender" : "(optional, string) [PII] Gender of the user, one of ['M', 'F', 'O', 'N', 'P']",
"id" : "(required, string) Globally unique ID for this event",
"language" : "(optional, string) [PII] Language of the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"resolution" : "(optional, string) Resolution of the device",
"sdk_version" : "(optional, string) Version of the Braze SDK in use during the event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Bannière Cliquez sur les événements
Cet événement se produit lorsqu’un utilisateur clique sur une bannière.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Banner Click (users.messages.banner.Click)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_model" : "(optional, string) Model of the device",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Banner Click (users.messages.banner.Click)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
| // Banner Clicks (users.messages.banner.Click)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Banner Clicked (users.messages.banner.Click)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // users.messages.banner.Click
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"carrier" : "(optional, string) Carrier of the device",
"country" : "(optional, string) [PII] Country of the user",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"gender" : "(optional, string) [PII] Gender of the user, one of ['M', 'F', 'O', 'N', 'P']",
"id" : "(required, string) Globally unique ID for this event",
"language" : "(optional, string) [PII] Language of the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"resolution" : "(optional, string) Resolution of the device",
"sdk_version" : "(optional, string) Version of the Braze SDK in use during the event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Evénements d’impression de la bannière
Cet événement se produit lorsqu’un utilisateur visualise une bannière.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Banner Impression (users.messages.banner.Impression)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_model" : "(optional, string) Model of the device",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Banner Impression (users.messages.banner.Impression)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
| // Banner Impressions (users.messages.banner.Impression)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Banner Viewed (users.messages.banner.Impression)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.messages.banner.Impression
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"banner_placement_id" : "(optional, string) Customer specified banner placement ID",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"carrier" : "(optional, string) Carrier of the device",
"country" : "(optional, string) [PII] Country of the user",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"gender" : "(optional, string) [PII] Gender of the user, one of ['M', 'F', 'O', 'N', 'P']",
"id" : "(required, string) Globally unique ID for this event",
"language" : "(optional, string) [PII] Language of the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"resolution" : "(optional, string) Resolution of the device",
"sdk_version" : "(optional, string) Version of the Braze SDK in use during the event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements d’abandon de la carte de contenu
Cet événement se produit si un message de carte de contenu a été interrompu en raison d’abandons de liquides, etc.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Content Card Abort (users.messages.contentcard.Abort)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Content Card Abort (users.messages.contentcard.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
| // Content Card Aborts (users.messages.contentcard.Abort)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Content Card Aborted (users.messages.contentcard.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // users.messages.contentcard.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Carte de contenu Événements de clics
Cet événement se produit lorsqu’un utilisateur clique sur une carte de contenu.
note:
dispatch_id est obsolète et sera supprimée dans la prochaine version de Currents.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Content Card Click (users.messages.contentcard.Click)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Content Card Click (users.messages.contentcard.Click)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
| // Content Card Clicks (users.messages.contentcard.Click)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| // Content Card Clicked (users.messages.contentcard.Click)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.messages.contentcard.Click
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"content_card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Pour
ad_id, ad_id_type, et ad_tracking_enabled, vous devez collecter explicitement l’IDFA pour iOS et l’ID publicitaire Google pour Android via les SDK natifs. En savoir plus sur cette configuration pour iOS et Android.
- Si vous utilisez Kafka pour ingérer les données de Currents, contactez votre gestionnaire de satisfaction client pour activer l’envoi de
ad_id.
Carte de contenu Fermer de contenu
Cet événement se produit lorsqu’un utilisateur ferme une carte de contenu.
note:
dispatch_id est obsolète et sera supprimée dans la prochaine version de Currents.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Content Card Dismiss (users.messages.contentcard.Dismiss)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Content Card Dismiss (users.messages.contentcard.Dismiss)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
| // Content Card Dismisses (users.messages.contentcard.Dismiss)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| // Content Card Dismissed (users.messages.contentcard.Dismiss)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.messages.contentcard.Dismiss
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"content_card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Pour
ad_id, ad_id_type, et ad_tracking_enabled, vous devez collecter explicitement l’IDFA pour iOS et l’ID publicitaire Google pour Android via les SDK natifs. En savoir plus sur cette configuration pour iOS et Android.
- Si vous utilisez Kafka pour ingérer les données de Currents, contactez votre gestionnaire de satisfaction client pour activer l’envoi de
ad_id.
Carte de contenu Événements d’impression
Cet événement se produit lorsqu’un utilisateur consulte une carte de contenu.
note:
dispatch_id est obsolète et sera supprimée dans la prochaine version de Currents.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Content Card Impression (users.messages.contentcard.Impression)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Content Card Impression (users.messages.contentcard.Impression)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
| // Content Card Impressions (users.messages.contentcard.Impression)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| // Content Card Viewed (users.messages.contentcard.Impression)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.messages.contentcard.Impression
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"content_card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Pour
ad_id, ad_id_type, et ad_tracking_enabled, vous devez collecter explicitement l’IDFA pour iOS et l’ID publicitaire Google pour Android via les SDK natifs. En savoir plus sur cette configuration pour iOS et Android.
- Si vous utilisez Kafka pour ingérer les données de Currents, contactez votre gestionnaire de satisfaction client pour activer l’envoi de
ad_id.
Carte de contenu Envoyer des événements
Cet événement se produit lorsqu’une carte de contenu est envoyée à un utilisateur.
note:
dispatch_id est obsolète et sera supprimée dans la prochaine version de Currents.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Content Card Send (users.messages.contentcard.Send)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Content Card Send (users.messages.contentcard.Send)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
| // Content Card Sends (users.messages.contentcard.Send)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Content Card Sent (users.messages.contentcard.Send)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
| // users.messages.contentcard.Send
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"content_card_id" : "(required, string) ID of the card that generated this event",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
message_extras vous permettent d’annoter vos événements d’envoi avec des données dynamiques issues du contenu connecté, des attributs personnalisés (tels que la langue ou le pays) et des propriétés d’entrée dans Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
E-mail Abandon d’événements
Cet événement se produit si un envoi de messages e-mail a été interrompu en raison d’une interruption pour cause de liquidité, etc.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Email Abort (users.messages.email.Abort)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Email Abort (users.messages.email.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
| // Email Aborts (users.messages.email.Abort)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Email Aborted (users.messages.email.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // users.messages.email.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements de rebond d’e-mail
Cet événement se produit lorsqu’un fournisseur de services Internet renvoie un échec d’envoi définitif. Un échec d’envoi définitif signifie un échec de livrabilité définitif.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Email Bounce (users.messages.email.Bounce)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this bounce event",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_drop" : "(optional, boolean) Indicates that this event counts as a drop event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Email Bounce (users.messages.email.Bounce)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this bounce event",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_drop" : "(optional, boolean) Indicates that this event counts as a drop event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
| // Email Bounces (users.messages.email.Bounce)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this bounce event",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_drop" : "(optional, boolean) Indicates that this event counts as a drop event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Email Bounced (users.messages.email.Bounce)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this bounce event",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_drop" : "(optional, boolean) Indicates that this event counts as a drop event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // users.messages.email.Bounce
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this bounce event",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_domain" : "(optional, string) Sending domain for the email",
"id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_drop" : "(optional, boolean) Indicates that this event counts as a drop event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"sending_ip" : "(optional, string) IP address from which the email send was made",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Le comportement de
dispatch_id diffère entre Canvas et les campagnes car Braze traite les étapes de Canvas (à l’exception des étapes d’entrée, qui peuvent être planifiées) comme des événements déclenchés, même lorsqu’elles sont planifiées. En savoir plus sur le comportement de l’ID de répartition.
E-mail Cliquez sur les événements
Cet événement se produit lorsqu’un utilisateur clique sur un e-mail. Plusieurs événements peuvent être générés pour la même campagne si un utilisateur clique plusieurs fois ou clique sur différents liens dans l’e-mail.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
| // Email Click (users.messages.email.Click)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_model" : "(optional, string) Model of the device",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"is_suspected_bot_click" : "(optional, boolean) Indicates that this is a suspected bot click. Will only populate when Bot Filtering setting is enabled",
"link_alias" : "(optional, string) Alias associated with this link ID",
"link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"suspected_bot_click_reason" : "(optional, array of string) Reason(s) why this is a suspected bot click. Will always populate even if Bot Filtering setting is disabled.",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
| // Email Click (users.messages.email.Click)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"$device" : "(optional, string) Model of the device",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"is_suspected_bot_click" : "(optional, boolean) Indicates that this is a suspected bot click. Will only populate when Bot Filtering setting is enabled",
"link_alias" : "(optional, string) Alias associated with this link ID",
"link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"suspected_bot_click_reason" : "(optional, array of string) Reason(s) why this is a suspected bot click. Will always populate even if Bot Filtering setting is disabled.",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
| // Email Clicks (users.messages.email.Click)
{
"device_info" : {
"device_model" : "(optional, string) Model of the device",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"is_suspected_bot_click" : "(optional, boolean) Indicates that this is a suspected bot click. Will only populate when Bot Filtering setting is enabled",
"link_alias" : "(optional, string) Alias associated with this link ID",
"link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
| // Email Link Clicked (users.messages.email.Click)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device"
},
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"is_suspected_bot_click" : "(optional, boolean) Indicates that this is a suspected bot click. Will only populate when Bot Filtering setting is enabled",
"link_alias" : "(optional, string) Alias associated with this link ID",
"link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze",
"link_url" : "(optional, string) URL that the user clicked on",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"suspected_bot_click_reason" : "(optional, array of string) Reason(s) why this is a suspected bot click. Will always populate even if Bot Filtering setting is disabled.",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| // users.messages.email.Click
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_model" : "(optional, string) Model of the device",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_domain" : "(optional, string) Sending domain for the email",
"id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"is_suspected_bot_click" : "(optional, boolean) Indicates that this is a suspected bot click. Will only populate when Bot Filtering setting is enabled",
"link_alias" : "(optional, string) Alias associated with this link ID",
"link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"suspected_bot_click_reason" : "(optional, array of string) Reason(s) why this is a suspected bot click. Will always populate even if Bot Filtering setting is disabled.",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Le comportement de
dispatch_id diffère entre Canvas et les campagnes car Braze traite les étapes de Canvas (à l’exception des étapes d’entrée, qui peuvent être planifiées) comme des événements déclenchés, même lorsqu’elles sont planifiées. En savoir plus sur le comportement de l’ID de répartition.
Événements de report d’e-mail
Cet événement se produit lorsqu’un fournisseur de services Internet ne délivre pas immédiatement l’e-mail à une adresse e-mail n’ayant pas fait l’objet d’un échec définitif et que Braze tente à nouveau d’envoyer l’e-mail pendant une période pouvant aller jusqu’à 72 heures. Les raisons habituelles d’un report sont les suivantes : limitation du volume d’e-mails basée sur la réputation par le fournisseur de la boîte de réception, problèmes de connectivité temporaires, boîte aux lettres du destinataire pleine ou erreurs de DNS.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Email Deferral (users.messages.email.Deferral)
{
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"attempt_count" : "(optional, int) Number of attempts made to send the message",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"deferral_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this deferral event",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"recipient_domain" : "(optional, string) Receipient's email domain",
"send_id" : "(optional, string) Message send ID this message belongs to",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Email Deferral (users.messages.email.Deferral)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"attempt_count" : "(optional, int) Number of attempts made to send the message",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"deferral_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this deferral event",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"recipient_domain" : "(optional, string) Receipient's email domain",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
| // Email Deferrals (users.messages.email.Deferral)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"attempt_count" : "(optional, int) Number of attempts made to send the message",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"deferral_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this deferral event",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"recipient_domain" : "(optional, string) Receipient's email domain",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Email Deferred (users.messages.email.Deferral)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"attempt_count" : "(optional, int) Number of attempts made to send the message",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"deferral_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this deferral event",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"recipient_domain" : "(optional, string) Receipient's email domain",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // users.messages.email.Deferral
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"attempt_count" : "(optional, int) Number of attempts made to send the message",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"deferral_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this deferral event",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_domain" : "(optional, string) Sending domain for the email",
"id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"recipient_domain" : "(optional, string) Receipient's email domain",
"send_id" : "(optional, string) Message send ID this message belongs to",
"sending_ip" : "(optional, string) IP address from which the email send was made",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Le comportement de
dispatch_id diffère entre Canvas et les campagnes car Braze traite les étapes de Canvas (à l’exception des étapes d’entrée, qui peuvent être planifiées) comme des événements déclenchés, même lorsqu’elles sont planifiées. En savoir plus sur le comportement de l’ID de répartition.
Événements de réception/distribution d’e-mails
Cet événement se produit lorsqu’un e-mail envoyé est parvenu jusqu’à la boîte de réception de l’utilisateur final.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Email Delivery (users.messages.email.Delivery)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Email Delivery (users.messages.email.Delivery)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
| // Email Deliveries (users.messages.email.Delivery)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Email Delivered (users.messages.email.Delivery)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // users.messages.email.Delivery
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_domain" : "(optional, string) Sending domain for the email",
"id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"sending_ip" : "(optional, string) IP address from which the email send was made",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Le comportement de
dispatch_id diffère entre Canvas et les campagnes car Braze traite les étapes de Canvas (à l’exception des étapes d’entrée, qui peuvent être planifiées) comme des événements déclenchés, même lorsqu’elles sont planifiées. En savoir plus sur le comportement de l’ID de répartition.
Événements marqués comme spam par e-mail
Cet événement se produit lorsque l’utilisateur final appuie sur le bouton “spam” de l’e-mail. Notez que cela ne conseille pas d’envoyer l’e-mail dans le dossier spam, car Braze n’en tient pas compte.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Email Mark As Spam (users.messages.email.MarkAsSpam)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Email Mark As Spam (users.messages.email.MarkAsSpam)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
| // Email Marks As Spam (users.messages.email.MarkAsSpam)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // Email Marked as Spam (users.messages.email.MarkAsSpam)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // users.messages.email.MarkAsSpam
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_domain" : "(optional, string) Sending domain for the email",
"id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Le comportement de
dispatch_id diffère entre Canvas et les campagnes car Braze traite les étapes de Canvas (à l’exception des étapes d’entrée, qui peuvent être planifiées) comme des événements déclenchés, même lorsqu’elles sont planifiées. En savoir plus sur le comportement de l’ID de répartition.
Evénements ouverts à l’e-mail
Cet événement se produit lorsqu’un utilisateur ouvre un e-mail. Plusieurs événements peuvent être générés pour la même campagne si un utilisateur ouvre l’e-mail plusieurs fois.
important:
Le fait que les champs device_model et mailbox_provider de l’événement d’ouverture d’un e-mail soient vides est un comportement connu. Vous pouvez les ignorer pour l’instant.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Email Open (users.messages.email.Open)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_model" : "(optional, string) Model of the device",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| // Email Open (users.messages.email.Open)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"$device" : "(optional, string) Model of the device",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
| // Email Opens (users.messages.email.Open)
{
"device_info" : {
"device_model" : "(optional, string) Model of the device",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
| // Email Opened (users.messages.email.Open)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device"
},
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // users.messages.email.Open
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)",
"device_model" : "(optional, string) Model of the device",
"device_os" : "(optional, string) Device operating system extracted from user_agent",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_domain" : "(optional, string) Sending domain for the email",
"id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"is_amp" : "(optional, boolean) Indicates that this is an AMP event",
"machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.",
"mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Le comportement de
dispatch_id diffère entre Canvas et les campagnes car Braze traite les étapes de Canvas (à l’exception des étapes d’entrée, qui peuvent être planifiées) comme des événements déclenchés, même lorsqu’elles sont planifiées. En savoir plus sur le comportement de l’ID de répartition.
Envoyer des événements par e-mail
Cet événement se produit lorsqu’une demande d’envoi d’e-mail a été communiquée avec succès entre Braze et Sendgrid. Cela ne signifie toutefois pas que l’e-mail a été reçu dans la boîte de réception de l’utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Email Send (users.messages.email.Send)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Email Send (users.messages.email.Send)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
| // Email Sends (users.messages.email.Send)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // Email Sent (users.messages.email.Send)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // users.messages.email.Send
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Le comportement de
dispatch_id diffère entre Canvas et les campagnes car Braze traite les étapes de Canvas (à l’exception des étapes d’entrée, qui peuvent être planifiées) comme des événements déclenchés, même lorsqu’elles sont planifiées. En savoir plus sur le comportement de l’ID de répartition.
message_extras vous permettent d’annoter vos événements d’envoi avec des données dynamiques issues du contenu connecté, des attributs personnalisés (tels que la langue, le pays) et des propriétés d’entrée dans le Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
Événements de l’échec provisoire d’envoi par e-mail
Cet événement se produit lorsqu’un fournisseur de services Internet renvoie un échec provisoire d’envoi. Un échec provisoire d’envoi signifie qu’un e-mail n’a pas pu être livré en raison d’un problème temporaire de livrabilité.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Email Soft Bounce (users.messages.email.SoftBounce)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this bounce event",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Email Soft Bounce (users.messages.email.SoftBounce)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this bounce event",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
| // Email Soft Bounces (users.messages.email.SoftBounce)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this bounce event",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // Email Soft Bounced (users.messages.email.SoftBounce)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) [PII] The SMTP reason code and user friendly message received for this bounce event",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"esp" : "(optional, string) ESP related to the event (SparkPost, SendGrid, or Amazon SES)",
"from_domain" : "(optional, string) Sending domain for the email",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
Détails de la propriété
- Le comportement de
dispatch_id diffère entre Canvas et les campagnes car Braze traite les étapes de Canvas (à l’exception des étapes d’entrée, qui peuvent être planifiées) comme des événements déclenchés, même lorsqu’elles sont planifiées. En savoir plus sur le comportement de l’ID de répartition.
Événements de désinscription par e-mail
Cet événement se produit lorsque l’utilisateur final a cliqué sur “se désabonner” de l’e-mail.
important:
L’événement Unsubscribe est en fait un événement de clic spécialisé qui est déclenché lorsque votre utilisateur clique sur le lien de désabonnement dans l’e-mail (soit un lien de désabonnement normal dans le corps ou le pied de page de l’e-mail, soit en utilisant l’en-tête list-unsubscribe), et non pas lorsque l’utilisateur change d’état pour se désabonner. Si le changement d’état de l’abonnement est envoyé par l’API ou par un lien de désabonnement personnalisé (non Braze), il ne déclenchera pas d’événement sur Braze Currents.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Email Unsubscribe (users.messages.email.Unsubscribe)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Email Unsubscribe (users.messages.email.Unsubscribe)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"email_address" : "(required, string) [PII] Email address of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
| // Email Unsubscribes (users.messages.email.Unsubscribe)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user",
"email" : "(required, string) [PII] Email address of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Unsubscribed (users.messages.email.Unsubscribe)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"email" : "(required, string) [PII] Email address of the user"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
| // users.messages.email.Unsubscribe
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"email_address" : "(required, string) [PII] Email address of the user",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Le comportement de
dispatch_id diffère entre Canvas et les campagnes car Braze traite les étapes de Canvas (à l’exception des étapes d’entrée, qui peuvent être planifiées) comme des événements déclenchés, même lorsqu’elles sont planifiées. En savoir plus sur le comportement de l’ID de répartition.
Fonctionnalité Drapeau Expérience Événements d’impression
Cet événement se produit chaque fois qu’un utilisateur a eu l’occasion d’interagir avec votre fonctionnalité ou qu’il aurait pu le faire si la fonctionnalité était désactivée (dans le cas d’un groupe de contrôle lors d’un test A/B).
Les impressions des drapeaux de fonctionnalité ne sont enregistrées qu’une seule fois par session.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Feature Flag Experiment Impression (users.messages.featureflag.Impression)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_model" : "(optional, string) Model of the device",
"feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Feature Flag Experiment Impression (users.messages.featureflag.Impression)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
| // Feature Flag Experiment Impressions (users.messages.featureflag.Impression)
{
"device_info" : {
"device_model" : "(optional, string) Model of the device",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"platform" : "(optional, string) Platform of the device"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Feature Flag Experiment Impressed (users.messages.featureflag.Impression)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // users.messages.featureflag.Impression
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"carrier" : "(optional, string) Carrier of the device",
"country" : "(optional, string) [PII] Country of the user",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier",
"gender" : "(optional, string) [PII] Gender of the user, one of ['M', 'F', 'O', 'N', 'P']",
"id" : "(required, string) Globally unique ID for this event",
"language" : "(optional, string) [PII] Language of the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"resolution" : "(optional, string) Resolution of the device",
"sdk_version" : "(optional, string) Version of the Braze SDK in use during the event",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements d’abandon de message in-app
Cet événement se produit lorsqu’un message in-app initialement planifié a été interrompu.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // In-App Message Abort (users.messages.inappmessage.Abort)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // In-App Message Abort (users.messages.inappmessage.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
| // In-App Message Aborts (users.messages.inappmessage.Abort)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
| // In-App Message Aborted (users.messages.inappmessage.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| // users.messages.inappmessage.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"carrier" : "(optional, string) Carrier of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"resolution" : "(optional, string) Resolution of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event",
"version" : "(required, string) Which version of in-app message, legacy or triggered"
}
|
Message in-app Événements de clics
Cet événement se produit lorsqu’un utilisateur clique sur un message in-app.
note:
dispatch_id est obsolète et sera supprimée dans la prochaine version de Currents.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // In-App Message Click (users.messages.inappmessage.Click)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // In-App Message Click (users.messages.inappmessage.Click)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
| // In-App Message Clicks (users.messages.inappmessage.Click)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
| // In-App Message Clicked (users.messages.inappmessage.Click)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // users.messages.inappmessage.Click
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Pour
ad_id, ad_id_type, et ad_tracking_enabled, vous devez collecter explicitement l’IDFA pour iOS et l’ID publicitaire Google pour Android via les SDK natifs. En savoir plus sur cette configuration pour iOS et Android.
- Si vous utilisez Kafka pour ingérer les données de Currents, contactez votre gestionnaire de satisfaction client pour activer l’envoi de
ad_id.
Message in-app Événements d’impression
Cet événement se produit lorsqu’un utilisateur consulte un message in-app.
note:
dispatch_id est obsolète et sera supprimée dans la prochaine version de Currents.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // In-App Message Impression (users.messages.inappmessage.Impression)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // In-App Message Impression (users.messages.inappmessage.Impression)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
| // In-App Message Impressions (users.messages.inappmessage.Impression)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
| // In-App Message Viewed (users.messages.inappmessage.Impression)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // users.messages.inappmessage.Impression
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"card_id" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Pour
ad_id, ad_id_type, et ad_tracking_enabled, vous devez collecter explicitement l’IDFA pour iOS et l’ID publicitaire Google pour Android via les SDK natifs. En savoir plus sur cette configuration pour iOS et Android.
- Si vous utilisez Kafka pour ingérer les données de Currents, contactez votre gestionnaire de satisfaction client pour activer l’envoi de
ad_id.
Abandon d’événements
Cet événement se produit lorsqu’un message LINE planifié ne peut être délivré, avant d’être envoyé à LINE.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Abort (users.messages.line.Abort)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Abort (users.messages.line.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
| // Aborts (users.messages.line.Abort)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Aborted (users.messages.line.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // users.messages.line.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Cliquez sur les événements
Cet événement se produit lorsqu’un utilisateur clique sur un lien dans un message LINE dont le domaine correspond au domaine de suivi des clics.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Click (users.messages.line.Click)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(required, string) Shortened url that was clicked",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"timezone" : "(optional, string) Time zone of the user",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Click (users.messages.line.Click)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(required, string) Shortened url that was clicked",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
| // Clicks (users.messages.line.Click)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(required, string) Shortened url that was clicked",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Clicked (users.messages.line.Click)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(required, string) Shortened url that was clicked",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // users.messages.line.Click
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(required, string) Shortened url that was clicked",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"url" : "(required, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
LINE Réception d’événements
<div class=’api_tags’ data-tags=’LINE, reçu à l’arrivée’ data-tags-lower=’line, reçu à l’arrivée’></div>
Cet événement se produit lorsqu’un message LINE est reçu d’un utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // LINE Inbound Receive (users.messages.line.InboundReceive)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"media_id" : "(optional, string) The LINE-generated ID which can be used to retrieve inbound media from LINE",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // LINE Inbound Receive (users.messages.line.InboundReceive)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"media_id" : "(optional, string) The LINE-generated ID which can be used to retrieve inbound media from LINE",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
| // LINE Inbound Receives (users.messages.line.InboundReceive)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"media_id" : "(optional, string) The LINE-generated ID which can be used to retrieve inbound media from LINE",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // LINE Inbound Received (users.messages.line.InboundReceive)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"media_id" : "(optional, string) The LINE-generated ID which can be used to retrieve inbound media from LINE",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // users.messages.line.InboundReceive
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"media_id" : "(optional, string) The LINE-generated ID which can be used to retrieve inbound media from LINE",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Envoyer des événements
Cet événement se produit lorsqu’un message LINE est envoyé à LINE.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Send (users.messages.line.Send)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"timezone" : "(optional, string) Time zone of the user"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Send (users.messages.line.Send)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
| // Sends (users.messages.line.Send)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Sent (users.messages.line.Send)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // users.messages.line.Send
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"line_channel_id" : "(required, string) The LINE Channel ID the message was sent to or received from",
"line_channel_name" : "(required, string) The LINE Channel Name the message was sent to or received from",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"native_line_id" : "(required, string) [PII] The user's Line ID from which the message was sent to or received from",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Activités en ligne/en production/instantanée Événements de résultats
Cet événement se produit lorsque Braze reçoit une réponse d’un fournisseur tiers (e.g. APN) après l’envoi de la ligne/en production/instantanée
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| // Live Activity Outcome (users.messages.liveactivity.Outcome)
{
"event_properties" : {
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"live_activity_event_outcome" : "(optional, string) Outcome of Live Activity event",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"update_token" : "(optional, string) Live Activity update token"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
| // Live Activity Outcome (users.messages.liveactivity.Outcome)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"live_activity_event_outcome" : "(optional, string) Outcome of Live Activity event",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"update_token" : "(optional, string) Live Activity update token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Live Activity Outcomes (users.messages.liveactivity.Outcome)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"live_activity_event_outcome" : "(optional, string) Outcome of Live Activity event",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"source_request_id" : "(required, string) Globally unique ID for this event",
"update_token" : "(optional, string) Live Activity update token"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
| // Live Activity Outcome (users.messages.liveactivity.Outcome)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"live_activity_event_outcome" : "(optional, string) Outcome of Live Activity event",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"update_token" : "(optional, string) Live Activity update token"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| // users.messages.liveactivity.Outcome
{
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"live_activity_event_outcome" : "(optional, string) Outcome of Live Activity event",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"time" : "(required, int) UNIX timestamp at which the event happened",
"update_token" : "(optional, string) Live Activity update token",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Activité en ligne/en production/instantanée Envoyer des événements
Cet événement se produit lorsque le backend Braze adresse une requête à son fournisseur concernant l’activité en ligne/instantanée.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
| // Live Activity Send (users.messages.liveactivity.Send)
{
"event_properties" : {
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"update_token" : "(optional, string) Live Activity update token"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| // Live Activity Send (users.messages.liveactivity.Send)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"update_token" : "(optional, string) Live Activity update token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Live Activity Sends (users.messages.liveactivity.Send)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"source_request_id" : "(required, string) Globally unique ID for this event",
"update_token" : "(optional, string) Live Activity update token"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| // Live Activity Sent (users.messages.liveactivity.Send)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"update_token" : "(optional, string) Live Activity update token"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
| // users.messages.liveactivity.Send
{
"activity_attributes_type" : "(optional, string) Live Activity attribute type",
"activity_id" : "(optional, string) Live Activity identifier",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"live_activity_event_type" : "(optional, string) Event type of Live Activity. One of ['start', 'update', 'end']",
"push_to_start_token" : "(optional, string) Live Activity push to start token",
"time" : "(required, int) UNIX timestamp at which the event happened",
"update_token" : "(optional, string) Live Activity update token",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements d’abandon de la notification push
Cet événement se produit si un message de notification push a été interrompu en raison d’abandons de liquides, etc.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Push Notification Abort (users.messages.pushnotification.Abort)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Push Notification Abort (users.messages.pushnotification.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
| // Push Notification Aborts (users.messages.pushnotification.Abort)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"platform" : "(optional, string) Platform of the device"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Push Notification Aborted (users.messages.pushnotification.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(required, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // users.messages.pushnotification.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(required, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements de rebond des notifications push
Cet événement se produit lorsqu’une erreur est reçue du service de notification push d’Apple ou de l’envoi messages de Fire Cloud. Cela signifie que le message push a été renvoyé et qu’il n’a donc pas été transmis à l’appareil de l’utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Push Notification Bounce (users.messages.pushnotification.Bounce)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Push Notification Bounce (users.messages.pushnotification.Bounce)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
| // Push Notification Bounces (users.messages.pushnotification.Bounce)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Push Notification Bounced (users.messages.pushnotification.Bounce)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // users.messages.pushnotification.Bounce
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Si vous utilisez Kafka pour ingérer des données Currents, contactez votre gestionnaire de satisfaction client ou votre gestionnaire de compte pour activer la bascule de fonctionnalité pour l’envoi de
ad_id.
Notification push iOS Événements d’ouverture au premier plan
Cet événement n’est pas pris en charge par notre SDK Swift et est désormais déprécié à l’aide de notre SDK Obj-C.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Push Notification iOS Foreground Open (users.messages.pushnotification.IosForeground)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Push Notification iOS Foreground Open (users.messages.pushnotification.IosForeground)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Ios Foreground Push Opened (users.messages.pushnotification.IosForeground)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // users.messages.pushnotification.IosForeground
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(required, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Pour
ad_id, ad_id_type, et ad_tracking_enabled, vous devez collecter explicitement l’IDFA pour iOS et l’ID publicitaire Google pour Android via les SDK natifs. En savoir plus sur cette configuration pour iOS et Android.
- Si vous utilisez Kafka pour ingérer les données de Currents, contactez votre gestionnaire de satisfaction client pour activer l’envoi de
ad_id.
Notification push Événements ouverts
Cet événement se produit lorsqu’un utilisateur clique directement sur la notification push pour ouvrir l’application. Actuellement, les événements “Push Open” font spécifiquement référence aux “ouvertures directes” plutôt qu’aux “ouvertures totales”. Cela n’inclut pas les statistiques affichées au niveau de la campagne des “ouvertures influencées”, car celles-ci ne sont pas attribuées au niveau de l’utilisateur.
note:
Dans de rares cas, un événement “push open” peut apparaître avant l’événement “push send” correspondant dans les données de Currents pour les raisons suivantes :
- Votre SDK a une horloge incorrecte.
- Temps de latence élevé pour l’écriture des lots. L’heure d’envoi enregistrée peut être en retard par rapport aux premières réceptions/distributions, de sorte que des ouvertures très rapides peuvent être enregistrées avant que l’horodatage d’envoi final du lot ne soit écrit. Les envois importants sont expédiés et enregistrés par lots.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Push Notification Open (users.messages.pushnotification.Open)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Push Notification Open (users.messages.pushnotification.Open)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"$device" : "(optional, string) Model of the device",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"$os" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
| // Push Notification Opens (users.messages.pushnotification.Open)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"device_model" : "(optional, string) Model of the device",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Push Notification Tapped (users.messages.pushnotification.Open)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
},
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // users.messages.pushnotification.Open
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"button_action_type" : "(optional, string) Action type of the push notification button, null if not from a button click. One of ['uri', 'deep_link', 'none', 'close']",
"button_string" : "(optional, string) Identifier (button_string) of the push notification button clicked. null if not from a button click",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Pour
ad_id, ad_id_type, et ad_tracking_enabled, vous devez collecter explicitement l’IDFA pour iOS et l’ID publicitaire Google pour Android via les SDK natifs. En savoir plus sur cette configuration pour iOS et Android.
- Si vous utilisez Kafka pour ingérer les données de Currents, contactez votre gestionnaire de satisfaction client pour activer l’envoi de
ad_id.
Notification push Envoi d’événements
Cet événement se produit lorsque Braze traite un message push pour un utilisateur, en le communiquant au service de notification push d’Apple ou à Fire Cloud Messaging. Cela ne signifie pas que le message a été transmis à l’appareil, mais simplement qu’un message a été envoyé.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Push Notification Send (users.messages.pushnotification.Send)
{
"adid" : "(optional, string) [PII] Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"idfa" : "(optional, string) [PII] Advertising identifier",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Push Notification Send (users.messages.pushnotification.Send)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(optional, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
| // Push Notification Sends (users.messages.pushnotification.Send)
{
"device_info" : {
"android_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_advertising_id" : "(optional, string) [PII] Advertising identifier",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"microsoft_advertising_id" : "(optional, string) [PII] Advertising identifier",
"platform" : "(optional, string) Platform of the device",
"roku_advertising_id" : "(optional, string) [PII] Advertising identifier"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Push Notification Sent (users.messages.pushnotification.Send)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(required, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.messages.pushnotification.Send
{
"ad_id" : "(optional, string) [PII] Advertising identifier",
"ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']",
"ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"app_id" : "(required, string) API ID of the app on which this event occurred",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"locale_key" : "(optional, string) [PII] The key corresponding to the translations (for example 'en-us') used to compose this message (null for default).",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"platform" : "(required, string) Platform of the device",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
- Pour
ad_id, ad_id_type, et ad_tracking_enabled, vous devez collecter explicitement l’IDFA pour iOS et l’ID publicitaire Google pour Android via les SDK natifs. En savoir plus sur cette configuration pour iOS et Android.
- Si vous utilisez Kafka pour ingérer les données de Currents, contactez votre gestionnaire de satisfaction client pour activer l’envoi de
ad_id.
message_extras vous permettent d’annoter vos événements d’envoi avec des données dynamiques issues du contenu connecté, des attributs personnalisés (tels que la langue, le pays) et des propriétés d’entrée dans le Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
Abandon d’événements
Cet événement est créé lorsqu’un envoi RCS est interrompu en raison d’une erreur détectée dans Braze, et que le message est abandonné.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
| // Abort (users.messages.rcs.Abort)
{
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) The type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // Abort (users.messages.rcs.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) The type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| // Aborts (users.messages.rcs.Abort)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) The type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Aborted (users.messages.rcs.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) The type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
| // users.messages.rcs.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) The type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Cliquez sur les événements
Un événement créé lorsque l’utilisateur interagit avec un message RCS en tapant ou en cliquant sur un élément de l’interface utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Click (users.messages.rcs.Click)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"element_label" : "(optional, string) Optional details about the clicked element, such as the text of a suggested reply or button. \nExample: Button or chip text (will be reply message body for reply chips and buttons)",
"element_type" : "(optional, string) Specifies if an interaction_type that is common across suggestions and buttons came from a suggestion or button. Examples: Suggestion, Button",
"interaction_type" : "(required, string) The type of interaction that generated the click. Example string values: Text URL, Reply, OpenURL",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(optional, string) The shortened URL that a user clicks on",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"suspected_bot_click_reason" : "(optional, array of string) Reasons why this event was classified as a bot",
"url" : "(optional, string) The full URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the click occurred",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Click (users.messages.rcs.Click)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"element_label" : "(optional, string) Optional details about the clicked element, such as the text of a suggested reply or button. \nExample: Button or chip text (will be reply message body for reply chips and buttons)",
"element_type" : "(optional, string) Specifies if an interaction_type that is common across suggestions and buttons came from a suggestion or button. Examples: Suggestion, Button",
"$insert_id" : "(required, string) Globally unique ID for this event",
"interaction_type" : "(required, string) The type of interaction that generated the click. Example string values: Text URL, Reply, OpenURL",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(optional, string) The shortened URL that a user clicks on",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"suspected_bot_click_reason" : "(optional, array of string) Reasons why this event was classified as a bot",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"url" : "(optional, string) The full URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the click occurred",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
| // Clicks (users.messages.rcs.Click)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"element_label" : "(optional, string) Optional details about the clicked element, such as the text of a suggested reply or button. \nExample: Button or chip text (will be reply message body for reply chips and buttons)",
"element_type" : "(optional, string) Specifies if an interaction_type that is common across suggestions and buttons came from a suggestion or button. Examples: Suggestion, Button",
"interaction_type" : "(required, string) The type of interaction that generated the click. Example string values: Text URL, Reply, OpenURL",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(optional, string) The shortened URL that a user clicks on",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"url" : "(optional, string) The full URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the click occurred"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] The user's phone number from which the message was received"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Clicked (users.messages.rcs.Click)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(required, string) [PII] The user's phone number from which the message was received"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"element_label" : "(optional, string) Optional details about the clicked element, such as the text of a suggested reply or button. \nExample: Button or chip text (will be reply message body for reply chips and buttons)",
"element_type" : "(optional, string) Specifies if an interaction_type that is common across suggestions and buttons came from a suggestion or button. Examples: Suggestion, Button",
"interaction_type" : "(required, string) The type of interaction that generated the click. Example string values: Text URL, Reply, OpenURL",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(optional, string) The shortened URL that a user clicks on",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"suspected_bot_click_reason" : "(optional, array of string) Reasons why this event was classified as a bot",
"user_agent" : "(optional, string) User agent on which the click occurred"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.messages.rcs.Click
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"element_label" : "(optional, string) Optional details about the clicked element, such as the text of a suggested reply or button. \nExample: Button or chip text (will be reply message body for reply chips and buttons)",
"element_type" : "(optional, string) Specifies if an interaction_type that is common across suggestions and buttons came from a suggestion or button. Examples: Suggestion, Button",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"interaction_type" : "(required, string) The type of interaction that generated the click. Example string values: Text URL, Reply, OpenURL",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"short_url" : "(optional, string) The shortened URL that a user clicks on",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"suspected_bot_click_reason" : "(optional, array of string) Reasons why this event was classified as a bot",
"time" : "(required, int) UNIX timestamp at which the event happened",
"url" : "(optional, string) The full URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the click occurred",
"user_id" : "(required, string) Braze user ID of the user who performed this event",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
}
|
Événements de réception/distribution
Cet événement est créé lorsqu’un message RCS est envoyé avec succès à l’appareil mobile d’un utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Delivery (users.messages.rcs.Delivery)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Delivery (users.messages.rcs.Delivery)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
| // Deliveries (users.messages.rcs.Delivery)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Delivered (users.messages.rcs.Delivery)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // users.messages.rcs.Delivery
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Réception d’événements
Cet événement est créé lorsque Braze reçoit un message RCS provenant de l’utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Inbound Receive (users.messages.rcs.InboundReceive)
{
"event_properties" : {
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_rcs_sender" : "(required, string) The inbound RCS sender that the message was sent to",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Inbound Receive (users.messages.rcs.InboundReceive)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_rcs_sender" : "(required, string) The inbound RCS sender that the message was sent to",
"token" : "(required, string) The Mixpanel API token",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
| // Inbound Receives (users.messages.rcs.InboundReceive)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_rcs_sender" : "(required, string) The inbound RCS sender that the message was sent to"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] The user's phone number from which the message was received"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // Inbound Received (users.messages.rcs.InboundReceive)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(required, string) [PII] The user's phone number from which the message was received"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_rcs_sender" : "(required, string) The inbound RCS sender that the message was sent to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // users.messages.rcs.InboundReceive
{
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(required, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_rcs_sender" : "(required, string) The inbound RCS sender that the message was sent to",
"user_id" : "(required, string) Braze user ID of the user who performed this event",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
}
|
Lire les événements
Cet événement est créé lorsqu’un utilisateur ouvre un message RCS sur son appareil, indiquant qu’il a vu ou lu le contenu du message.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
| // Read (users.messages.rcs.Read)
{
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| // Read (users.messages.rcs.Read)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // Reads (users.messages.rcs.Read)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Read (users.messages.rcs.Read)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
| // users.messages.rcs.Read
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements de rejet
Un événement qui est créé lorsqu’un message RCS ne parvient pas à être délivré à l’appareil mobile d’un utilisateur en raison d’une intervention de l’opérateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Rejection (users.messages.rcs.Rejection)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"is_sms_fallback" : "(optional, boolean) Indicates if SMS fallback was attempted for this rejected RCS message. It is linked/paired to the SMS Delivery event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) The error code from the provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Rejection (users.messages.rcs.Rejection)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"error" : "(optional, string) Error name",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"$insert_id" : "(required, string) Globally unique ID for this event",
"is_sms_fallback" : "(optional, boolean) Indicates if SMS fallback was attempted for this rejected RCS message. It is linked/paired to the SMS Delivery event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) The error code from the provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
| // Rejections (users.messages.rcs.Rejection)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"is_sms_fallback" : "(optional, boolean) Indicates if SMS fallback was attempted for this rejected RCS message. It is linked/paired to the SMS Delivery event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) The error code from the provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // Rejected (users.messages.rcs.Rejection)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"is_sms_fallback" : "(optional, boolean) Indicates if SMS fallback was attempted for this rejected RCS message. It is linked/paired to the SMS Delivery event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) The error code from the provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // users.messages.rcs.Rejection
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"id" : "(required, string) Globally unique ID for this event",
"is_sms_fallback" : "(optional, boolean) Indicates if SMS fallback was attempted for this rejected RCS message. It is linked/paired to the SMS Delivery event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) The error code from the provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Envoyer des événements
Cet événement est créé lorsqu’un message RCS est envoyé depuis Braze à nos partenaires de réception/distribution du dernier kilomètre.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // Send (users.messages.rcs.Send)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // Send (users.messages.rcs.Send)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
| // Sends (users.messages.rcs.Send)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Sent (users.messages.rcs.Send)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // users.messages.rcs.Send
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_rcs_sender" : "(optional, string) The RCS sender ID or agent name used to send the message",
"id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements d’annulation de SMS
Cet événement se produit si un message SMS a été interrompu en raison d’abandons de liquides, etc.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // SMS Abort (users.messages.sms.Abort)
{
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // SMS Abort (users.messages.sms.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
| // SMS Aborts (users.messages.sms.Abort)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // SMS Aborted (users.messages.sms.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| // users.messages.sms.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Envoi d’événements par le transporteur SMS
Cet événement se produit lorsqu’un SMS est envoyé à l’opérateur.
important:
CarrierSend n’est pris en charge que pour les utilisateurs de l’infrastructure existante.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // SMS Carrier Send (users.messages.sms.CarrierSend)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // SMS Carrier Send (users.messages.sms.CarrierSend)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
| // SMS Carrier Sends (users.messages.sms.CarrierSend)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // SMS Sent to Carrier (users.messages.sms.CarrierSend)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // users.messages.sms.CarrierSend
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements de réception/distribution de SMS
Cet événement se produit lorsqu’un SMS a été transmis avec succès au téléphone portable de l’utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // SMS Delivery (users.messages.sms.Delivery)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // SMS Delivery (users.messages.sms.Delivery)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"$insert_id" : "(required, string) Globally unique ID for this event",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
| // SMS Deliveries (users.messages.sms.Delivery)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // SMS Delivered (users.messages.sms.Delivery)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // users.messages.sms.Delivery
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"id" : "(required, string) Globally unique ID for this event",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements liés à l’échec de la réception/distribution des SMS
Cet événement se produit lorsqu’un SMS subit un échec de réception/distribution. Utilisez cet événement et les codes d’erreur fournis pour résoudre les problèmes de réception/distribution des SMS.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // SMS Delivery Failure (users.messages.sms.DeliveryFailure)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // SMS Delivery Failure (users.messages.sms.DeliveryFailure)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"error" : "(optional, string) Error name",
"$insert_id" : "(required, string) Globally unique ID for this event",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
| // SMS Delivery Failures (users.messages.sms.DeliveryFailure)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // SMS Delivery Failed (users.messages.sms.DeliveryFailure)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // users.messages.sms.DeliveryFailure
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements de réception de SMS
Cet événement se produit lorsqu’un de vos utilisateurs envoie un SMS à un numéro de téléphone figurant dans l’un de vos groupes d’abonnement SMS de Braze.
Lorsque Braze reçoit un SMS entrant, nous attribuons ce message entrant à tout utilisateur partageant ce numéro de téléphone. Par conséquent, vous pouvez recevoir plusieurs événements par message entrant si plusieurs utilisateurs de votre instance Braze partagent le même numéro de téléphone. Si vous souhaitez attribuer des ID d’utilisateurs spécifiques en fonction des messages précédemment envoyés à cet utilisateur, vous pouvez utiliser l’événement SMS délivré pour attribuer les événements reçus entrants à l’ID d’utilisateur qui a reçu le plus récemment un message en provenance de votre numéro Braze.
Si nous détectons que ce message entrant est une réponse à une campagne sortante ou à un composant Canvas envoyé depuis Braze, nous inclurons également les métadonnées de la campagne ou de Canvas avec l’événement. Braze définit une réponse comme un envoi de messages entrants dans les quatre heures suivant un message sortant. Toutefois, il existe un cache d’une minute pour les informations relatives à la campagne attribuée au dernier SMS sortant reçu.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // SMS Inbound Received (users.messages.sms.InboundReceive)
{
"event_properties" : {
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // SMS Inbound Received (users.messages.sms.InboundReceive)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"distinct_id" : "(required, string) [PII] External ID of the user",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"$insert_id" : "(required, string) Globally unique ID for this event",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
| // SMS Inbound Received (users.messages.sms.InboundReceive)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] The user's phone number from which the message was received"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // SMS Inbound Received (users.messages.sms.InboundReceive)
{
"anonymousId" : "(optional, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(required, string) [PII] The user's phone number from which the message was received"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| // users.messages.sms.InboundReceive
{
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(required, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(required, string) Typed response from the user",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) Braze user ID of the user who performed this event",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
}
|
Événements de rejet de SMS
Cet événement se produit lorsqu’un envoi de SMS est rejeté par l’opérateur, ce qui peut se produire pour plusieurs raisons. Utilisez cet événement et les codes d’erreur fournis pour résoudre les problèmes de réception/distribution des SMS.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // SMS Rejection (users.messages.sms.Rejection)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID\nIt can be linked to the RCS Rejection event via a send ID and dispatch ID. (Event property)",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // SMS Rejection (users.messages.sms.Rejection)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"error" : "(optional, string) Error name",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"$insert_id" : "(required, string) Globally unique ID for this event",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID\nIt can be linked to the RCS Rejection event via a send ID and dispatch ID. (Event property)",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
| // SMS Rejections (users.messages.sms.Rejection)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID\nIt can be linked to the RCS Rejection event via a send ID and dispatch ID. (Event property)",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // SMS Rejected (users.messages.sms.Rejection)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID\nIt can be linked to the RCS Rejection event via a send ID and dispatch ID. (Event property)",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // users.messages.sms.Rejection
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"error" : "(optional, string) Error name",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)",
"id" : "(required, string) Globally unique ID for this event",
"is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID\nIt can be linked to the RCS Rejection event via a send ID and dispatch ID. (Event property)",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(optional, string) Error code from the SMS provider",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Envoi d’événements par SMS
Cet événement se produit lorsqu’un utilisateur envoie un SMS.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // SMS Send (users.messages.sms.Send)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // SMS Send (users.messages.sms.Send)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
| // SMS Sends (users.messages.sms.Send)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // SMS Sent (users.messages.sms.Send)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // users.messages.sms.Send
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
message_extras vous permettent d’annoter vos événements d’envoi avec des données dynamiques issues du contenu connecté, des attributs personnalisés (tels que la langue, le pays) et des propriétés d’entrée dans le Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
SMS Short Link Click events
Cet événement se produit lorsqu’un utilisateur clique sur un lien court SMS.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // SMS Short Link Click (users.messages.sms.ShortLinkClick)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"suspected_bot_click_reason" : "(optional, array of string) Why this event was classified as a bot",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_phone_number" : "(optional, string) [PII] The user's phone number from which the message was received"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // SMS Short Link Click (users.messages.sms.ShortLinkClick)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"suspected_bot_click_reason" : "(optional, array of string) Why this event was classified as a bot",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_phone_number" : "(optional, string) [PII] The user's phone number from which the message was received"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
| // SMS Short Link Clicks (users.messages.sms.ShortLinkClick)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"source_request_id" : "(required, string) Globally unique ID for this event",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] The user's phone number from which the message was received"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // SMS Short Link Clicked (users.messages.sms.ShortLinkClick)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] The user's phone number from which the message was received"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"suspected_bot_click_reason" : "(optional, array of string) Why this event was classified as a bot",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // users.messages.sms.ShortLinkClick
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"is_suspected_bot_click" : "(optional, boolean) Whether this event was processed as a bot event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"suspected_bot_click_reason" : "(optional, array of string) Why this event was classified as a bot",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"url" : "(required, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_id" : "(required, string) Braze user ID of the user who performed this event",
"user_phone_number" : "(optional, string) [PII] The user's phone number from which the message was received"
}
|
Événements d’abandon de webhook
Cet événement se produit si un message webhook a été interrompu en raison d’abandons de liquides, etc.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Webhook Abort (users.messages.webhook.Abort)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // Webhook Abort (users.messages.webhook.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
| // Webhook Aborts (users.messages.webhook.Abort)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // Webhook Aborted (users.messages.webhook.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // users.messages.webhook.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements d’échec de webhook
Cet événement se produit si un message webhook a été envoyé mais a échoué avec une réponse d’erreur de la part de l’endpoint.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // Webhook Failure (users.messages.webhook.Failure)
{
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"content_length" : "(optional, int) Content length of the response",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"endpoint_url" : "(optional, string) The endpoint URL of the failed webhook",
"host" : "(optional, string) The host of the webhook URL that returned a failure response",
"http_status_code" : "(optional, int) HTTP status code of the response",
"is_terminal" : "(optional, boolean) Whether this event was the terminal attempt in a send",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"raw_response" : "(optional, string) Truncated raw response from endpoint",
"retry_count" : "(optional, int) Number of webhook sends attempted before giving up",
"send_id" : "(optional, string) Message send ID this message belongs to",
"url_path" : "(optional, string) The path of the webhook URL that returned a failure response",
"webhook_duration" : "(optional, int) Total duration of this request in milliseconds",
"webhook_failure_source" : "(optional, string) To tell whether an error was created by Braze or by the endpoint itself. The source field could be External Endpoint, Treat no status code to host unreachable"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // Webhook Failure (users.messages.webhook.Failure)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"content_length" : "(optional, int) Content length of the response",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"endpoint_url" : "(optional, string) The endpoint URL of the failed webhook",
"host" : "(optional, string) The host of the webhook URL that returned a failure response",
"http_status_code" : "(optional, int) HTTP status code of the response",
"$insert_id" : "(required, string) Globally unique ID for this event",
"is_terminal" : "(optional, boolean) Whether this event was the terminal attempt in a send",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"raw_response" : "(optional, string) Truncated raw response from endpoint",
"retry_count" : "(optional, int) Number of webhook sends attempted before giving up",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"url_path" : "(optional, string) The path of the webhook URL that returned a failure response",
"webhook_duration" : "(optional, int) Total duration of this request in milliseconds",
"webhook_failure_source" : "(optional, string) To tell whether an error was created by Braze or by the endpoint itself. The source field could be External Endpoint, Treat no status code to host unreachable"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
| // Webhook Failures (users.messages.webhook.Failure)
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"content_length" : "(optional, int) Content length of the response",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"endpoint_url" : "(optional, string) The endpoint URL of the failed webhook",
"host" : "(optional, string) The host of the webhook URL that returned a failure response",
"http_status_code" : "(optional, int) HTTP status code of the response",
"is_terminal" : "(optional, boolean) Whether this event was the terminal attempt in a send",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"raw_response" : "(optional, string) Truncated raw response from endpoint",
"retry_count" : "(optional, int) Number of webhook sends attempted before giving up",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"url_path" : "(optional, string) The path of the webhook URL that returned a failure response",
"webhook_duration" : "(optional, int) Total duration of this request in milliseconds",
"webhook_failure_source" : "(optional, string) To tell whether an error was created by Braze or by the endpoint itself. The source field could be External Endpoint, Treat no status code to host unreachable"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
| // Webhook Failed (users.messages.webhook.Failure)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"content_length" : "(optional, int) Content length of the response",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"endpoint_url" : "(optional, string) The endpoint URL of the failed webhook",
"host" : "(optional, string) The host of the webhook URL that returned a failure response",
"http_status_code" : "(optional, int) HTTP status code of the response",
"is_terminal" : "(optional, boolean) Whether this event was the terminal attempt in a send",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"raw_response" : "(optional, string) Truncated raw response from endpoint",
"retry_count" : "(optional, int) Number of webhook sends attempted before giving up",
"send_id" : "(optional, string) Message send ID this message belongs to",
"url_path" : "(optional, string) The path of the webhook URL that returned a failure response",
"webhook_duration" : "(optional, int) Total duration of this request in milliseconds",
"webhook_failure_source" : "(optional, string) To tell whether an error was created by Braze or by the endpoint itself. The source field could be External Endpoint, Treat no status code to host unreachable"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // users.messages.webhook.Failure
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"content_length" : "(optional, int) Content length of the response",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"endpoint_url" : "(optional, string) The endpoint URL of the failed webhook",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"host" : "(optional, string) The host of the webhook URL that returned a failure response",
"http_status_code" : "(optional, int) HTTP status code of the response",
"id" : "(required, string) Globally unique ID for this event",
"is_terminal" : "(optional, boolean) Whether this event was the terminal attempt in a send",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"raw_response" : "(optional, string) Truncated raw response from endpoint",
"retry_count" : "(optional, int) Number of webhook sends attempted before giving up",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"url_path" : "(optional, string) The path of the webhook URL that returned a failure response",
"user_id" : "(required, string) Braze user ID of the user who performed this event",
"webhook_duration" : "(optional, int) Total duration of this request in milliseconds",
"webhook_failure_source" : "(optional, string) To tell whether an error was created by Braze or by the endpoint itself. The source field could be External Endpoint, Treat no status code to host unreachable"
}
|
Événements d’envoi de webhooks
Cet événement se produit lorsqu’un webhook a été traité et envoyé au tiers spécifié dans ce webhook. Notez que cela ne signifie pas que la demande a été reçue ou non.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // Webhook Send (users.messages.webhook.Send)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Webhook Send (users.messages.webhook.Send)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
| // Webhook Sends (users.messages.webhook.Send)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : { },
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // Webhook Sent (users.messages.webhook.Send)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : { }
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| // users.messages.webhook.Send
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Détails de la propriété
message_extras vous permettent d’annoter vos événements d’envoi avec des données dynamiques issues du contenu connecté, des attributs personnalisés (tels que la langue ou le pays) et des propriétés d’entrée dans Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
WhatsApp Abort events
Cet événement se produit si un message WhatsApp a été interrompu en raison d’abandons de liquides, etc.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // WhatsApp Abort (users.messages.whatsapp.Abort)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, long) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| // WhatsApp Abort (users.messages.whatsapp.Abort)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, long) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
| // WhatsApp Aborts (users.messages.whatsapp.Abort)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // WhatsApp Aborted (users.messages.whatsapp.Abort)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // users.messages.whatsapp.Abort
{
"abort_log" : "(optional, string) [PII] Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, long) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
WhatsApp a suivi les événements de clics sur les liens
Cet événement se produit lorsqu’un utilisateur clique sur un lien ou un bouton dans un message WhatsApp où le domaine du lien correspond au domaine de suivi des clics.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // WhatsApp Tracked Link Click (users.messages.whatsapp.Click)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"timezone" : "(optional, string) Time zone of the user",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_phone_number" : "(optional, string) [PII] The user's phone number from which the message was received"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
| // WhatsApp Tracked Link Click (users.messages.whatsapp.Click)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"time" : "(required, int) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_phone_number" : "(optional, string) [PII] The user's phone number from which the message was received"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
| // WhatsApp Tracked Link Clicks (users.messages.whatsapp.Click)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"source_request_id" : "(required, string) Globally unique ID for this event",
"url" : "(optional, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] The user's phone number from which the message was received"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // WhatsApp Tracked Link Clicked (users.messages.whatsapp.Click)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] The user's phone number from which the message was received"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"user_agent" : "(optional, string) User agent on which the spam report occurred"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| // users.messages.whatsapp.Click
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"id" : "(required, string) Globally unique ID for this event",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"short_url" : "(required, string) Shortened url that was clicked",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"url" : "(required, string) URL that the user clicked on",
"user_agent" : "(optional, string) User agent on which the spam report occurred",
"user_id" : "(required, string) Braze user ID of the user who performed this event",
"user_phone_number" : "(optional, string) [PII] The user's phone number from which the message was received"
}
|
Événements de réception/distribution WhatsApp
Cet événement se produit lorsqu’un message WhatsApp envoyé est parvenu jusqu’à l’appareil de l’utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // WhatsApp Delivery (users.messages.whatsapp.Delivery)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, long) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // WhatsApp Delivery (users.messages.whatsapp.Delivery)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message",
"time" : "(required, long) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
| // WhatsApp Deliveries (users.messages.whatsapp.Delivery)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // WhatsApp Delivered (users.messages.whatsapp.Delivery)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.messages.whatsapp.Delivery
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"id" : "(required, string) Globally unique ID for this event",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message",
"time" : "(required, long) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements de défaillance de WhatsApp
Cet événement se produit lorsque WhatsApp ne peut pas envoyer le message à l’utilisateur. Un échec d’envoi définitif signifie un échec de livrabilité définitif.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // WhatsApp Failure (users.messages.whatsapp.Failure)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(required, string) Error code from WhatsApp",
"provider_error_title" : "(required, string) Description of error from WhatsApp",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, long) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| // WhatsApp Failure (users.messages.whatsapp.Failure)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(required, string) Error code from WhatsApp",
"provider_error_title" : "(required, string) Description of error from WhatsApp",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message",
"time" : "(required, long) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
| // WhatsApp Failures (users.messages.whatsapp.Failure)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(required, string) Error code from WhatsApp",
"provider_error_title" : "(required, string) Description of error from WhatsApp",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
| // WhatsApp Failed (users.messages.whatsapp.Failure)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(required, string) Error code from WhatsApp",
"provider_error_title" : "(required, string) Description of error from WhatsApp",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // users.messages.whatsapp.Failure
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"id" : "(required, string) Globally unique ID for this event",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"provider_error_code" : "(required, string) Error code from WhatsApp",
"provider_error_title" : "(required, string) Description of error from WhatsApp",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message",
"time" : "(required, long) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Événements WhatsApp reçus en réception
Cet événement se produit lorsqu’un de vos utilisateurs envoie un message WhatsApp à un numéro de téléphone figurant dans l’un de vos groupes d’abonnement WhatsApp de Braze.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
| // WhatsApp Inbound Received (users.messages.whatsapp.InboundReceive)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"catalog_id" : "(optional, string) Catalog ID of a product if a product is referenced in the inbound message. Otherwise, empty.",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the user is responding to a WhatsApp Flow.",
"flow_response_json" : "(optional, string) [PII] The form values the user responded with. Present if the user is responding to a WhatsApp Flow.",
"in_reply_to" : "(optional, string) The message_id of the message this message was replying to",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"quick_reply_text" : "(optional, string) Text of button pressed by the user",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"productId" : "(optional, string) Product SKU if a product is referenced in the inbound message. Otherwise, empty.",
"time" : "(required, long) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // WhatsApp Inbound Received (users.messages.whatsapp.InboundReceive)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"catalog_id" : "(optional, string) Catalog ID of a product if a product is referenced in the inbound message. Otherwise, empty.",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the user is responding to a WhatsApp Flow.",
"flow_response_json" : "(optional, string) [PII] The form values the user responded with. Present if the user is responding to a WhatsApp Flow.",
"in_reply_to" : "(optional, string) The message_id of the message this message was replying to",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"$insert_id" : "(required, string) Globally unique ID for this event",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"product_id" : "(optional, string) Product SKU if a product is referenced in the inbound message. Otherwise, empty.",
"quick_reply_text" : "(optional, string) Text of button pressed by the user",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, long) UNIX timestamp at which the event happened",
"token" : "(required, string) The Mixpanel API token",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
| // WhatsApp Inbound Received (users.messages.whatsapp.InboundReceive)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"catalog_id" : "(optional, string) Catalog ID of a product if a product is referenced in the inbound message. Otherwise, empty.",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the user is responding to a WhatsApp Flow.",
"flow_response_json" : "(optional, string) [PII] The form values the user responded with. Present if the user is responding to a WhatsApp Flow.",
"in_reply_to" : "(optional, string) The message_id of the message this message was replying to",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"message_body" : "(optional, string) Typed response from the user",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"product_id" : "(optional, string) Product SKU if a product is referenced in the inbound message. Otherwise, empty.",
"quick_reply_text" : "(optional, string) Text of button pressed by the user",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] The user's phone number from which the message was received"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
| // WhatsApp Inbound Received (users.messages.whatsapp.InboundReceive)
{
"anonymousId" : "(optional, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(required, string) [PII] The user's phone number from which the message was received"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"catalog_id" : "(optional, string) Catalog ID of a product if a product is referenced in the inbound message. Otherwise, empty.",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the user is responding to a WhatsApp Flow.",
"flow_response_json" : "(optional, string) [PII] The form values the user responded with. Present if the user is responding to a WhatsApp Flow.",
"in_reply_to" : "(optional, string) The message_id of the message this message was replying to",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"product_id" : "(optional, string) Product SKU if a product is referenced in the inbound message. Otherwise, empty.",
"quick_reply_text" : "(optional, string) Text of button pressed by the user",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| // users.messages.whatsapp.InboundReceive
{
"action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"catalog_id" : "(optional, string) Catalog ID of a product if a product is referenced in the inbound message. Otherwise, empty.",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the user is responding to a WhatsApp Flow.",
"flow_response_json" : "(optional, string) [PII] The form values the user responded with. Present if the user is responding to a WhatsApp Flow.",
"id" : "(required, string) Globally unique ID for this event",
"in_reply_to" : "(optional, string) The message_id of the message this message was replying to",
"inbound_phone_number" : "(required, string) The inbound number that the message was sent to",
"media_urls" : "(optional, array of string) Media URLs from the user",
"message_body" : "(optional, string) Typed response from the user",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"product_id" : "(optional, string) Product SKU if a product is referenced in the inbound message. Otherwise, empty.",
"quick_reply_text" : "(optional, string) Text of button pressed by the user",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, long) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id" : "(optional, string) Braze user ID of the user who performed this event",
"user_phone_number" : "(required, string) [PII] The user's phone number from which the message was received"
}
|
WhatsApp Lire les événements
Cet événement se produit lorsqu’un message WhatsApp est lu par l’utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
| // WhatsApp Read (users.messages.whatsapp.Read)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, long) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // WhatsApp Read (users.messages.whatsapp.Read)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message",
"time" : "(required, long) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
| // WhatsApp Reads (users.messages.whatsapp.Read)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
| // WhatsApp Read (users.messages.whatsapp.Read)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.messages.whatsapp.Read
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"id" : "(required, string) Globally unique ID for this event",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp manager. Present if sending a Template Message",
"time" : "(required, long) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Envoi d’événements par WhatsApp
Cet événement se produit lorsqu’une demande d’envoi a été communiquée avec succès entre Braze et WhatsApp. Cela ne signifie pas pour autant que le message a été reçu par l’utilisateur.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
| // WhatsApp Send (users.messages.whatsapp.Send)
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp Manager. Present if sending a Template Message",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"event_type" : "(required, string) The event type name, as it is exported to Amplitude",
"insert_id" : "(required, string) Globally unique ID for this event",
"library" : "Braze",
"time" : "(required, long) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
| // WhatsApp Send (users.messages.whatsapp.Send)
{
"event" : "(required, string) The event type name, as it is exported to Mixpanel",
"properties" : {
"$partner_id" : "braze",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"$insert_id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp Manager. Present if sending a Template Message",
"time" : "(required, long) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
| // WhatsApp Sends (users.messages.whatsapp.Send)
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"source_request_id" : "(required, string) Globally unique ID for this event",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp Manager. Present if sending a Template Message"
},
"custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')",
"event_name" : "(required, string) The event type name, as it is exported to mParticle",
"source_message_id" : "(required, string) Globally unique ID for this event",
"timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened"
},
"event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')"
}
],
"schema_version" : 2,
"user_attributes" : {
"$mobile" : "(required, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) [PII] External ID of the user"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| // WhatsApp Sent (users.messages.whatsapp.Send)
{
"anonymousId" : "(required, string) Braze user ID of the user who performed this event",
"context" : {
"device" : { },
"traits" : {
"phone" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)"
}
},
"event" : "(required, string) The event type name, as it is exported to Segment",
"messageId" : "(required, string) Globally unique ID for this event",
"properties" : {
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp Manager. Present if sending a Template Message"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(optional, string) [PII] External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| // users.messages.whatsapp.Send
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) [PII] External ID of the user",
"flow_id" : "(optional, string) The unique ID of the Flow in the WhatsApp Manager. Present if the message includes a CTA to respond to a WhatsApp Flow",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"id" : "(required, string) Globally unique ID for this event",
"message_extras" : "(optional, string) [PII] A JSON string of the tagged key-value pairs during liquid rendering",
"message_id" : "(optional, string) The unique ID generated by Meta for this message",
"message_variation_id" : "(optional, string) API ID of the message variation this user received",
"message_variation_name" : "(optional, string) Name of the message variation",
"send_id" : "(optional, string) Message send ID this message belongs to",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"template_name" : "(optional, string) [PII] Name of the template in the WhatsApp Manager. Present if sending a Template Message",
"time" : "(required, long) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) [PII] Phone number of the user receiving the message in e.164 format (for example +14155552671)",
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
|
Modifier cette page sur GitHub