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 de comportement client ou nos exemples de données Currents.
Explication de la structure de l’événement d’engagement lié aux messages et des valeurs de la plateforme
Structure d’événement
Cette ventilation des événements montre le type d’information généralement inclus dans un événement d’engagement de message. Avec une bonne compréhension de ses composants, vos développeurs et votre équipe BI peuvent utiliser les données d’événements Currents entrants pour créer des rapports et des graphiques axés sur les données, et tirer parti des précieux indicateurs de données fournis.
.
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 d’ID 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 attribué automatiquement par Braze. |
external_id |
"EXTERNAL_USER_ID" |
Identifiant unique du profil d’un utilisateur défini par le client. |
Certains événements renvoient une valeur platform qui spécifie la plate-forme de l’appareil de l’utilisateur.
Le tableau suivant détaille les valeurs retournées possibles :
| Appareil de l’utilisateur |
Valeur de la plateforme |
| 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 :
- "nom_de_la_campagne"
- "nom_de_la_toile"
- "nom_de_l'étape_de_la_toile"
- "conversion_behavior"
- "nom_de_la_variation_de_la_toile"
- "nom_de_l'expérience"
- "nom_du_message"
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.
Événements de lecture WhatsApp
Cet événement se produit lorsqu’un message WhatsApp est lu par 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
| // 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) External ID of the user",
"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_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) 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
| // WhatsApp Read: 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) External ID of the user",
"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_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) 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"
}
|
1
2
3
4
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
| // WhatsApp Read: 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",
"from_phone_number" : "(required, 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",
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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
| // 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",
"from_phone_number" : "(required, 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",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) 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) 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
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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" : "(required, 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",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(required, string) External ID of the user"
}
|
É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 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
| // 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) External ID of the user",
"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_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) 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
| // WhatsApp Delivery: 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) External ID of the user",
"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_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) 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"
}
|
1
2
3
4
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
| // WhatsApp Delivery: 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",
"from_phone_number" : "(required, 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",
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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
| // 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",
"from_phone_number" : "(required, 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",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) 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) 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
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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" : "(required, 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",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(required, string) External ID of the user"
}
|
Événements de défaillance WhatsApp
Cet événement se produit lorsque WhatsApp ne peut pas envoyer le message à l’utilisateur. Un échec d’envoi définitif est un échec permanent de la 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
| // 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) External ID of the user",
"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_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",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, long) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) 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
| // WhatsApp Failure: 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) External ID of the user",
"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_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",
"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) 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"
}
|
1
2
3
4
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 Failure: 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",
"from_phone_number" : "(required, 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",
"provider_error_code" : "(required, string) Error code from WhatsApp",
"provider_error_title" : "(required, string) Description of error from WhatsApp",
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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 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",
"from_phone_number" : "(required, 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",
"provider_error_code" : "(required, string) Error code from WhatsApp",
"provider_error_title" : "(required, string) Description of error from WhatsApp",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) 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) 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
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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" : "(required, 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",
"provider_error_code" : "(required, string) Error code from WhatsApp",
"provider_error_title" : "(required, string) Description of error from WhatsApp",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(required, string) External ID of the user"
}
|
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 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
| // 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) External ID of the user",
"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) 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",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"time" : "(required, long) UNIX timestamp at which the event happened",
"to_phone_number" : "(optional, string) 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
| // WhatsApp Send: 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) External ID of the user",
"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) 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",
"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) 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"
}
|
1
2
3
4
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 Send: 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",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"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",
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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 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",
"from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"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",
"subscription_group_id" : "(optional, string) Subscription group API ID",
"to_phone_number" : "(optional, string) 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) 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
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)",
"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",
"subscription_group_id" : "(optional, string) Subscription group API ID"
},
"timestamp" : "(required, long) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(required, string) External ID of the user"
}
|
Événements d’annulation de messages WhatsApp
Cet événement se produit si un envoi de messages WhatsApp a été interrompu en raison d’abandons de liquides, d’heures calmes, 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
| // 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) 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) 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) 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
| // WhatsApp Abort: users.messages.whatsapp.Abort
{
"abort_log" : "(optional, string) 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) 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) 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"
}
|
1
2
3
4
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 Abort: 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) 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"
},
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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 Abort: users.messages.whatsapp.Abort
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) 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) 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) 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 Abort: users.messages.whatsapp.Abort
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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) 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" : "(required, string) External ID of the user"
}
|
Événements entrants reçus par WhatsApp
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
| // 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",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) External ID of the user",
"$insert_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" : "(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",
"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) 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
| // WhatsApp Inbound Received: 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",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(optional, string) 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" : "(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",
"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) 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
| // 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",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"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",
"quick_reply_text" : "(optional, string) Text of button pressed by the user",
"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) The user's phone number from which the message was received"
},
"user_identities" : {
"customerid" : "(required, string) 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
| // 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",
"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",
"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) 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, long) UNIX timestamp at which the event happened",
"user_id" : "(optional, string) 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
| // WhatsApp Inbound Received: users.messages.whatsapp.InboundReceive
{
"context" : {
"traits" : {
"phone" : "(required, string) The user's phone number from which the message was received"
},
"device" : { }
},
"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",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"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",
"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" : "(required, string) External ID of the user"
}
|
Événements de message d’abandon de carte de contenu
Cet événement se produit si un message de carte de contenu a été interrompu en raison d’abandons de liquides, d’heures calmes, 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
| // 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) 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) 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
| // Content Card Abort: users.messages.contentcard.Abort
{
"abort_log" : "(optional, string) 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) 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"
}
|
1
2
3
4
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
| // Content Card Abort: 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) 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"
},
"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) 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
| // 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) 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) 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
| // Content Card Abort: users.messages.contentcard.Abort
{
"context" : {
"traits" : { },
"device" : { }
},
"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) 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" : "(required, string) External ID of the user"
}
|
Événements de message d’abandon d’e-mail
Cet événement se produit si un envoi de messages e-mail a été interrompu en raison d’une interruption pour cause de liquidité, d’heures calmes, 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
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) 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",
"email_address" : "(required, string) Email address of the user",
"distinct_id" : "(required, string) External ID 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
| // Email Abort: users.messages.email.Abort
{
"abort_log" : "(optional, string) 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) Email address of the user",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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 Abort: 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) 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"
},
"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" : {
"email" : "(required, string) Email address of the user",
"customerid" : "(required, string) 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 Abort: users.messages.email.Abort
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) 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) 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) 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
| // Email Abort: users.messages.email.Abort
{
"context" : {
"traits" : {
"email" : "(required, string) Email address of the user"
},
"device" : { }
},
"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) 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" : "(required, string) External ID of the user"
}
|
Événements d’abandon de notification push
Cet événement se produit si un message de notification push a été interrompu en raison d’abandons de liquides, d’heures calmes, 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
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) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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) 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
| // Push Notification Abort: users.messages.pushnotification.Abort
{
"abort_log" : "(optional, string) 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) 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"
}
|
1
2
3
4
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
| // Push Notification Abort: 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) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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"
},
"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) 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
| // 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) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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) 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 Abort: users.messages.pushnotification.Abort
{
"context" : {
"traits" : { },
"device" : {
"type" : "(required, string) Platform of the device"
}
},
"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) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort",
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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" : "(required, string) External ID of the user"
}
|
Événements d’abandon de message SMS
Cet événement se produit si un envoi de messages SMS a été interrompu en raison d’abandons de liquides, d’heures calmes, 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
| // 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) 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) 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
| // SMS Abort: users.messages.sms.Abort
{
"abort_log" : "(optional, string) 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) 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"
}
|
1
2
3
4
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
| // SMS Abort: users.messages.sms.Abort
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) 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"
},
"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) 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
| // SMS Abort: users.messages.sms.Abort
{
"event_properties" : {
"abort_log" : "(optional, string) 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) 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 Abort: users.messages.sms.Abort
{
"context" : {
"traits" : { },
"device" : { }
},
"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) 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" : "(required, string) External ID of the user"
}
|
Événements d’abandon de message Webhook
Cet événement se produit si un message webhook a été interrompu sur la base d’interruptions liquides ou d’heures calmes.
1
2
3
4
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) 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) 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
| // Webhook Abort: users.messages.webhook.Abort
{
"abort_log" : "(optional, string) 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) 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"
}
|
1
2
3
4
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 Abort: 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) 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"
},
"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) 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 Abort: users.messages.webhook.Abort
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"abort_log" : "(optional, string) 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) 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 Abort: users.messages.webhook.Abort
{
"context" : {
"traits" : { },
"device" : { }
},
"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) 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" : "(required, string) External ID of the user"
}
|
Événements de sortie du Canvas ayant effectué un événement
Cet événement ce produit lorsqu’un utilisateur quitte 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
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) 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
| // Exit Perform Event: 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) 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"
}
|
1
2
3
4
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
| // Exit Perform Event: 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"
},
"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) External ID of the user"
}
}
|
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) 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
| // Exit Perform Event: users.canvas.exit.PerformedEvent
{
"context" : {
"traits" : { },
"device" : { }
},
"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" : "(required, string) External ID of the user"
}
|
Événements de sortie du Canvas par correspondance à une audience
Cet événement ce produit lorsqu’un utilisateur quitte un Canvas en correspondant à une audience.
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) 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
| // Exit Match Audience: 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) 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"
}
|
1
2
3
4
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
| // Exit Match Audience: 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"
},
"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) External ID of the user"
}
}
|
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) 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
| // Exit Match Audience: users.canvas.exit.MatchedAudience
{
"context" : {
"traits" : { },
"device" : { }
},
"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" : "(required, string) External ID of the user"
}
|
Événements d’entrée fractionnée Experiment
Cet événement se produit quand un utilisateur entre dans une étape Canvas Experiment.
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",
"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",
"distinct_id" : "(required, string) External ID of the user",
"$insert_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",
"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
| // Experiment Split Entry: 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) 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"
}
|
1
2
3
4
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
| // Experiment Split Entry: 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"
},
"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) 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
| // 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) 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
| // Experiment Split Entry: users.canvas.experimentstep.SplitEntry
{
"context" : {
"traits" : { },
"device" : { }
},
"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" : "(required, string) External ID of the user"
}
|
Événements de conversion Experiment
Cet événement se produit lorsqu’un utilisateur effectue une conversion pour une étape Canvas Experiment.
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",
"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",
"distinct_id" : "(required, string) 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
| // Experiment Step Conversion: 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) 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"
}
|
1
2
3
4
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 Step Conversion: 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"
},
"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) 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
| // 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) 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
| // Experiment Step Conversion: users.canvas.experimentstep.Conversion
{
"context" : {
"traits" : { },
"device" : { }
},
"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" : "(required, string) External ID of the user"
}
|
Événements d’envoi de notification push
Cet événement survient lorsque Braze traite un message de notification push pour un utilisateur, en le communiquant au service de notification push d’Apple ou Fire Cloud Messaging. Cela ne signifie pas que la notification push a été livrée sur l’appareil, cela indique juste 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
| // 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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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) External ID of the user",
"$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",
"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
| // Push Notification Send: users.messages.pushnotification.Send
{
"ad_id" : "(optional, string) 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) External ID of the user",
"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",
"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"
}
|
1
2
3
4
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 Send: users.messages.pushnotification.Send
{
"device_info" : {
"ios_advertising_id" : "(optional, string) Advertising identifier",
"android_advertising_id" : "(optional, string) Advertising identifier",
"microsoft_advertising_id" : "(optional, string) Advertising identifier",
"roku_advertising_id" : "(optional, string) Advertising identifier",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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) 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"
},
"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) 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
{
"adid" : "(optional, string) Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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) 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) 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) 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 Send: users.messages.pushnotification.Send
{
"context" : {
"traits" : { },
"device" : {
"type" : "(required, string) Platform of the device"
}
},
"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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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) 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" : "(required, string) External ID of the user"
}
|
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 par le biais des 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 permet d’annoter vos événements d’envoi avec des données dynamiques à partir du Contenu connecté, des attributs personnalisés (tels que la langue, le pays) et des propriétés d’entrée Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
Événements d’ouvertures de notification push
Cet événement se produit lorsqu’un utilisateur clique directement sur la notification push pour ouvrir l’application. Actuellement, les événements d’ouverture de notification push se rapportent spécifiquement aux « Ouvertures directes » plutôt qu’au « total des ouvertures». Cela n’inclut pas les statistiques affichées au niveau des « ouvertures influencées » de la campagne, car elles ne sont pas attribuées au niveau 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
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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"$device" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) 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
| // Push Notification Open: users.messages.pushnotification.Open
{
"ad_id" : "(optional, string) 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) 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"
}
|
1
2
3
4
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 Open: users.messages.pushnotification.Open
{
"device_info" : {
"ios_advertising_id" : "(optional, string) Advertising identifier",
"android_advertising_id" : "(optional, string) Advertising identifier",
"microsoft_advertising_id" : "(optional, string) Advertising identifier",
"roku_advertising_id" : "(optional, string) Advertising identifier",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"platform" : "(optional, string) Platform of the device"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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"
},
"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) 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 Open: users.messages.pushnotification.Open
{
"adid" : "(optional, string) Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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) 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) 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 Open: users.messages.pushnotification.Open
{
"context" : {
"traits" : { },
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
}
},
"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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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" : "(required, string) External ID of the user"
}
|
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 par le biais des 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.
Notifications push dans les événements de foreground (premier plan) iOS
Cet événement n’est pas pris en charge par notre SDK Swift et est désormais obsolète avec 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
| // 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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"$device" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) 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
| // Push Notification iOS Foreground Open: users.messages.pushnotification.IosForeground
{
"ad_id" : "(optional, string) 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) 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"
}
|
1
2
3
4
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) Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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) 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) 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 iOS Foreground Open: users.messages.pushnotification.IosForeground
{
"context" : {
"traits" : { },
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
}
},
"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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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" : "(required, string) External ID of the user"
}
|
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 par le biais des 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.
Rebond (bounce) de notifications Push
Cet événement survient lorsqu’une erreur est reçue du service de notification Push d’Apple ou de Fire Cloud Messaging. Cela signifie que le message de notification push a « rebondi » et n’est donc pas arrivé sur 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
| // 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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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) 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
| // Push Notification Bounce: users.messages.pushnotification.Bounce
{
"ad_id" : "(optional, string) 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) 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"
}
|
1
2
3
4
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
| // Push Notification Bounce: users.messages.pushnotification.Bounce
{
"device_info" : {
"ios_advertising_id" : "(optional, string) Advertising identifier",
"android_advertising_id" : "(optional, string) Advertising identifier",
"microsoft_advertising_id" : "(optional, string) Advertising identifier",
"roku_advertising_id" : "(optional, string) Advertising identifier",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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"
},
"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) 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
| // Push Notification Bounce: users.messages.pushnotification.Bounce
{
"adid" : "(optional, string) Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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) 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) 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
| // Push Notification Bounce: users.messages.pushnotification.Bounce
{
"context" : {
"traits" : { },
"device" : {
"type" : "(optional, string) Platform of the device"
}
},
"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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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" : "(required, string) External ID of the user"
}
|
Détails de la propriété
- Si vous utilisez Kafka pour ingérer des données Currents, contactez votre gestionnaire de succès des clients ou votre gestionnaire de compte pour activer la bascule de fonctionnalité pour l’envoi de
ad_id.
Événements d’envoi d’e-mail
Cet événement se produit lorsqu’une demande d’envoi d’e-mail a été transmise avec succès entre Braze et SendGrid. Mais cela ne signifie pas que l’e-mail est arrivé dans 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 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",
"email_address" : "(required, string) Email address of the user",
"distinct_id" : "(required, string) External ID 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) 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
| // Email Send: 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) Email address of the user",
"external_user_id" : "(optional, string) 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) 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"
}
|
1
2
3
4
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 Send: 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 or Sendgrid)",
"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) 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"
},
"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" : {
"email" : "(required, string) Email address of the user",
"customerid" : "(required, string) 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 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) Email address of the user",
"ip_pool" : "(optional, string) IP pool from which the email send was made",
"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"
},
"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) 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
| // Email Send: users.messages.email.Send
{
"context" : {
"traits" : {
"email" : "(required, string) Email address of the user"
},
"device" : { }
},
"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 or Sendgrid)",
"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) 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" : "(required, string) 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 du 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 des ID de répartition.
message_extras vous permet d’annoter vos événements d’envoi avec des données dynamiques à partir du Contenu connecté, des attributs personnalisés (tels que la langue, le pays) et des propriétés d’entrée Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
Événements de livraison d’e-mail
Cet événement se produit lorsqu’un e-mail envoyé est arrivé dans la boîte de réception des utilisateurs finaux.
1
2
3
4
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",
"email_address" : "(required, string) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"distinct_id" : "(required, string) External ID of the user",
"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
| // Email Delivery: 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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 Delivery: 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 or Sendgrid)",
"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"
},
"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" : {
"email" : "(required, string) Email address of the user",
"customerid" : "(required, string) 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 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"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) 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
| // Email Delivery: users.messages.email.Delivery
{
"context" : {
"traits" : {
"email" : "(required, string) Email address of the user"
},
"device" : { }
},
"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 or Sendgrid)",
"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" : "(required, string) 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 du 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 des ID de répartition.
Événements d’ouverture d’e-mail
Cet événement se produit lorsqu’un utilisateur ouvre un e-mail. Plusieurs événements peuvent être générés pour une 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
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_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" : "(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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"distinct_id" : "(required, string) External ID of the user",
"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
| // Email Open: 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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
| // Email Open: users.messages.email.Open
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model 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",
"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 or Sendgrid)",
"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"
},
"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" : {
"email" : "(required, string) Email address of the user",
"customerid" : "(required, string) 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
| // 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"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) 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
43
| // Email Open: users.messages.email.Open
{
"context" : {
"traits" : {
"email" : "(required, string) Email address of the user"
},
"device" : {
"model" : "(optional, string) Model of the device"
}
},
"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 or Sendgrid)",
"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" : "(required, string) 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 du 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 des ID de répartition.
Événements de clic sur un e-mail
Cet événement se produit lorsqu’un utilisateur clique sur un e-mail. Plusieurs événements peuvent être générés pour une même campagne si un utilisateur clique plusieurs fois sur un lien ou clique sur plusieurs 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
| // 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_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" : "(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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"distinct_id" : "(required, string) External ID of the user",
"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",
"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",
"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
| // Email Click: 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"external_user_id" : "(optional, string) 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",
"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",
"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"
}
|
1
2
3
4
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
| // Email Click: users.messages.email.Click
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model 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",
"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 or Sendgrid)",
"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",
"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",
"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" : {
"email" : "(required, string) Email address of the user",
"customerid" : "(required, string) 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
| // 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"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",
"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",
"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) 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
43
44
45
46
| // Email Click: users.messages.email.Click
{
"context" : {
"traits" : {
"email" : "(required, string) Email address of the user"
},
"device" : {
"model" : "(optional, string) Model of the device"
}
},
"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 or Sendgrid)",
"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",
"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",
"url" : "(optional, string) URL that the user clicked on",
"link_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" : "(required, string) 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 du 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 des ID de répartition.
Événement de rebond d’e-mail
Cet événement survient lorsqu’un fournisseur de services Internet renvoie un échec d’envoi définitif. Un échec d’envoi définitif est un échec permanent de la 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
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) 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",
"email_address" : "(required, string) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"distinct_id" : "(required, string) External ID of the user",
"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
| // Email Bounce: users.messages.email.Bounce
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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 Bounce: 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) 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 or Sendgrid)",
"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"
},
"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" : {
"email" : "(required, string) Email address of the user",
"customerid" : "(required, string) 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 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) 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"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) 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
| // Email Bounce: users.messages.email.Bounce
{
"context" : {
"traits" : {
"email" : "(required, string) Email address of the user"
},
"device" : { }
},
"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) 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 or Sendgrid)",
"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" : "(required, string) 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 du 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 des ID de répartition.
Événement de « soft bounce » d’e-mail
Cet événement se produit lorsqu’un fournisseur de services Internet renvoie un soft bounce. Un soft bounce signifie qu’un e-mail n’a pas pu être livré en raison d’une défaillance temporaire de la 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
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) 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",
"email_address" : "(required, string) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"distinct_id" : "(required, string) External ID of the user",
"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
| // Email Soft Bounce: users.messages.email.SoftBounce
{
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"bounce_reason" : "(optional, string) 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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 Soft Bounce: 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) 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 or Sendgrid)",
"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"
},
"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" : {
"email" : "(required, string) Email address of the user",
"customerid" : "(required, string) 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 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) 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"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) 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
| // Email Soft Bounce: users.messages.email.SoftBounce
{
"context" : {
"traits" : {
"email" : "(required, string) Email address of the user"
},
"device" : { }
},
"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) 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 or Sendgrid)",
"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" : "(required, string) 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 du 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 des ID de répartition.
Événements de spam pour un e-mail
Cet événement se produit lorsque l’utilisateur final clique sur le bouton « spam » sur l’e-mail. Notez que cela ne représente pas le fait que l’e-mail soit allé dans le dossier Spam, car Braze ne suit pas ça.
1
2
3
4
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",
"email_address" : "(required, string) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"distinct_id" : "(required, string) External ID of the user",
"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
| // Email Mark As Spam: 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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 Mark 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 or Sendgrid)",
"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"
},
"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" : {
"email" : "(required, string) Email address of the user",
"customerid" : "(required, string) 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 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) Email address of the user",
"esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)",
"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) 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
| // Email Mark As Spam: users.messages.email.MarkAsSpam
{
"context" : {
"traits" : {
"email" : "(required, string) Email address of the user"
},
"device" : { }
},
"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 or Sendgrid)",
"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" : "(required, string) 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 du 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 des ID de répartition.
E-mail événements de désabonnement
Cet événement se produit lorsque l’utilisateur final a cliqué sur « Se désabonner » dans 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 personnalisé (non Braze) de désabonnement, 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
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",
"email_address" : "(required, string) Email address of the user",
"distinct_id" : "(required, string) External ID 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
| // Email Unsubscribe: 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) Email address of the user",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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 Unsubscribe: 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"
},
"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" : {
"email" : "(required, string) Email address of the user",
"customerid" : "(required, string) 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
| // 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) 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) 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 Unsubscribe: users.messages.email.Unsubscribe
{
"context" : {
"traits" : {
"email" : "(required, string) Email address of the user"
},
"device" : { }
},
"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" : "(required, string) 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 du 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 des ID de répartition.
Événements d’impression de messages in-app
Cet événement se produit lorsqu’un utilisateur visualise 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
| // 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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"$device" : "(optional, string) Model of the device",
"dispatch_id" : "null",
"distinct_id" : "(required, string) External ID of the user",
"$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",
"$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
| // In-App Message Impression: users.messages.inappmessage.Impression
{
"ad_id" : "(optional, string) 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",
"dispatch_id" : "null",
"external_user_id" : "(optional, string) External ID of the user",
"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",
"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"
}
|
1
2
3
4
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
| // In-App Message Impression: users.messages.inappmessage.Impression
{
"device_info" : {
"ios_advertising_id" : "(optional, string) Advertising identifier",
"android_advertising_id" : "(optional, string) Advertising identifier",
"microsoft_advertising_id" : "(optional, string) Advertising identifier",
"roku_advertising_id" : "(optional, string) Advertising identifier",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"platform" : "(optional, string) Platform of the device"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "null",
"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"
},
"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) 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
{
"adid" : "(optional, string) Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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" : "(optional, string) API ID of the card",
"device_model" : "(optional, string) Model of the device",
"dispatch_id" : "null",
"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",
"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) 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) 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 Impression: users.messages.inappmessage.Impression
{
"context" : {
"traits" : { },
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
}
},
"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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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" : "(optional, string) API ID of the card",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"dispatch_id" : "null",
"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",
"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" : "(required, string) External ID of the user"
}
|
note:
Le champ message_extras sera actif le 4 avril 2024.
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 par le biais des 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.
Événements de clics sur un message in-app
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
| // 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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"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" : "(optional, string) Model of the device",
"dispatch_id" : "null",
"distinct_id" : "(required, string) 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
| // In-App Message Click: users.messages.inappmessage.Click
{
"ad_id" : "(optional, string) 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",
"dispatch_id" : "null",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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
| // In-App Message Click: users.messages.inappmessage.Click
{
"device_info" : {
"ios_advertising_id" : "(optional, string) Advertising identifier",
"android_advertising_id" : "(optional, string) Advertising identifier",
"microsoft_advertising_id" : "(optional, string) Advertising identifier",
"roku_advertising_id" : "(optional, string) Advertising identifier",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"platform" : "(optional, string) Platform of the device"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"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" : "null",
"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"
},
"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) 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 Click: users.messages.inappmessage.Click
{
"adid" : "(optional, string) Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"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" : "null",
"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) 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) 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 Click: users.messages.inappmessage.Click
{
"context" : {
"traits" : { },
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
}
},
"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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"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" : "null",
"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" : "(required, string) External ID of the user"
}
|
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 par le biais des 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.
Événements d’envoi de webhook
Cet événement se produit lorsqu’un webhook a été traité et envoyé à la tierce partie spécifiée dans le webhook. Notez que cela n’indique pas si 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
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) External ID of the user",
"$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",
"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
| // Webhook Send: 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) External ID of the user",
"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",
"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"
}
|
1
2
3
4
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
| // Webhook Send: 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) 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"
},
"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) 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
| // 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) 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) 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
| // Webhook Send: users.messages.webhook.Send
{
"context" : {
"traits" : { },
"device" : { }
},
"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) 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" : "(required, string) External ID of the user"
}
|
Détails de la propriété
message_extras vous permet d’annoter vos événements d’envoi avec des données dynamiques à partir du Contenu connecté, des attributs personnalisés (tels que la langue, le pays) et des propriétés d’entrée Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
Événements d’envoi de carte de contenu
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
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) External ID of the user",
"$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",
"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
| // Content Card Send: 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",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) External ID of the user",
"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",
"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"
}
|
1
2
3
4
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
| // Content Card Send: 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) 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"
},
"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) 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
| // 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) 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) 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
| // Content Card Send: users.messages.contentcard.Send
{
"context" : {
"traits" : { },
"device" : { }
},
"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) 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" : "(required, string) External ID of the user"
}
|
Détails de la propriété
message_extras vous permet d’annoter vos événements d’envoi avec des données dynamiques à partir du Contenu connecté, des attributs personnalisés (tels que la langue, le pays) et des propriétés d’entrée Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
Événements d’impression de carte de contenu
Cet événement se produit lorsqu’un utilisateur visualise 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
| // 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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"$device" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) 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
| // Content Card Impression: users.messages.contentcard.Impression
{
"ad_id" : "(optional, string) 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",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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
| // Content Card Impression: users.messages.contentcard.Impression
{
"device_info" : {
"ios_advertising_id" : "(optional, string) Advertising identifier",
"android_advertising_id" : "(optional, string) Advertising identifier",
"microsoft_advertising_id" : "(optional, string) Advertising identifier",
"roku_advertising_id" : "(optional, string) Advertising identifier",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"platform" : "(optional, string) Platform of the device"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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"
},
"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) 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
| // Content Card Impression: users.messages.contentcard.Impression
{
"adid" : "(optional, string) Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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) 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) 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 Impression: users.messages.contentcard.Impression
{
"context" : {
"traits" : { },
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
}
},
"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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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" : "(required, string) External ID of the user"
}
|
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 par le biais des 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.
Événements de clic sur carte de contenu
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
| // 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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"$device" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) 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
| // Content Card Click: users.messages.contentcard.Click
{
"ad_id" : "(optional, string) 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",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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
| // Content Card Click: users.messages.contentcard.Click
{
"device_info" : {
"ios_advertising_id" : "(optional, string) Advertising identifier",
"android_advertising_id" : "(optional, string) Advertising identifier",
"microsoft_advertising_id" : "(optional, string) Advertising identifier",
"roku_advertising_id" : "(optional, string) Advertising identifier",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"platform" : "(optional, string) Platform of the device"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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"
},
"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) 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
| // Content Card Click: users.messages.contentcard.Click
{
"adid" : "(optional, string) Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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) 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) 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 Click: users.messages.contentcard.Click
{
"context" : {
"traits" : { },
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
}
},
"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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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" : "(required, string) External ID of the user"
}
|
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 par le biais des 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.
Événements de fermeture de carte de contenu
Cet événement se produit lorsqu’un utilisateur rejette 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
| // 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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"$device" : "(optional, string) Model of the device",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"distinct_id" : "(required, string) 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
| // Content Card Dismiss: users.messages.contentcard.Dismiss
{
"ad_id" : "(optional, string) 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",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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
| // Content Card Dismiss: users.messages.contentcard.Dismiss
{
"device_info" : {
"ios_advertising_id" : "(optional, string) Advertising identifier",
"android_advertising_id" : "(optional, string) Advertising identifier",
"microsoft_advertising_id" : "(optional, string) Advertising identifier",
"roku_advertising_id" : "(optional, string) Advertising identifier",
"limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device",
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"platform" : "(optional, string) Platform of the device"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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"
},
"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) 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
| // Content Card Dismiss: users.messages.contentcard.Dismiss
{
"adid" : "(optional, string) Advertising identifier",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"ad_id" : "(optional, string) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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) 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) 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 Dismiss: users.messages.contentcard.Dismiss
{
"context" : {
"traits" : { },
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
}
},
"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) 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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" : "(required, string) External ID of the user"
}
|
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 par le biais des 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.
Événements de clic SMS
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
| // 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) 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) 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
| // SMS Short Link Click: 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) 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) 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
| // SMS Short Link Click: 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",
"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",
"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) The user's phone number from which the message was received"
},
"user_identities" : {
"customerid" : "(required, string) 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
| // 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",
"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",
"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) 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) 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
| // SMS Short Link Click: users.messages.sms.ShortLinkClick
{
"context" : {
"traits" : {
"phone" : "(optional, string) The user's phone number from which the message was received"
},
"device" : { }
},
"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",
"url" : "(optional, string) URL that the user clicked on",
"link_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" : "(required, string) External ID of the user"
}
|
Événements d’envoi 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
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) External ID of the user",
"$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" : "(optional, string) 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
| // SMS Send: 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) External ID of the user",
"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",
"timezone" : "(optional, string) Time zone of the user",
"to_phone_number" : "(optional, string) 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"
}
|
1
2
3
4
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 Send: 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) 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"
},
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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 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) 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) 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) 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 Send: users.messages.sms.Send
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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) 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" : "(required, string) External ID of the user"
}
|
Détails de la propriété
message_extras vous permet d’annoter vos événements d’envoi avec des données dynamiques à partir du Contenu connecté, des attributs personnalisés (tels que la langue, le pays) et des propriétés d’entrée Canvas. Pour en savoir plus, reportez-vous aux suppléments de messages.
Événements d’envoi SMS à l’opérateur
important:
CarrierSend n’est pris en charge que pour les utilisateurs de l’infrastructure existante.
Cet événement survient lorsqu’un SMS est envoyé à 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
| // 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) 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) 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
| // SMS Carrier Send: 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) 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) 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"
}
|
1
2
3
4
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
| // SMS Carrier Send: 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",
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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
| // 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) 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) 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
| // SMS Carrier Send: users.messages.sms.CarrierSend
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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" : "(required, string) External ID of the user"
}
|
Événements de livraison 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
{
"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) 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) 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
| // SMS Delivery: 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) 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) 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"
}
|
1
2
3
4
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
| // SMS Delivery: 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)",
"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"
},
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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
| // 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)",
"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) 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) 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
| // SMS Delivery: users.messages.sms.Delivery
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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" : "(required, string) External ID of the user"
}
|
Événements de rejet SMS
Cet événement survient lorsqu’un envoi 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 liés à la livraison de 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
{
"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",
"error" : "(optional, string) Error name",
"distinct_id" : "(required, string) 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",
"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) 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
| // SMS Rejection: 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) 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",
"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) 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"
}
|
1
2
3
4
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 Rejection: 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)",
"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"
},
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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 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)",
"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) 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) 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 Rejection: users.messages.sms.Rejection
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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)",
"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" : "(required, string) External ID of the user"
}
|
Événements d’échec de livraison SMS
Cet événement survient lorsqu’un SMS rencontre un problème de livraison. Utilisez cet événement et les codes d’erreur fournis pour résoudre les problèmes liés à la livraison de 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
{
"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",
"error" : "(optional, string) Error name",
"distinct_id" : "(required, string) 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",
"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) 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
| // SMS Delivery Failure: 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) 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",
"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) 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"
}
|
1
2
3
4
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 Delivery Failure: 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",
"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"
},
"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) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"user_identities" : {
"customerid" : "(required, string) 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 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",
"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) 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) 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 Delivery Failure: users.messages.sms.DeliveryFailure
{
"context" : {
"traits" : {
"phone" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"
},
"device" : { }
},
"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",
"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" : "(required, string) External ID of the user"
}
|
Événements de réception de SMS entrant
Cet événement se produit lorsque l’un de vos utilisateurs envoie un SMS à un numéro de téléphone dans l’un de vos groupes d’abonnement SMS Braze.
Notez que lorsque Braze reçoit un SMS entrant, nous attribuons ce message entrant à tout utilisateur qui partage 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 devez attribuer des ID Utilisateurs spécifiques sur la base des messages précédents envoyés à cet utilisateur, vous pouvez utiliser l’événement SMS Livré pour attribuer des événements entrants reçus à l’ID utilisateur qui a reçu le plus récemment un message de votre numéro Braze.
Si nous détectons que ce message entrant est une réponse à une campagne sortante ou à une étape Canvas envoyée par Braze, nous inclurons également les métadonnées Canvas ou Campagne avec l’événement. Braze définit une réponse comme un message entrant dans les quatre heures suivant un message sortant. Cependant, il y a un cache d’une minute pour les informations d’attribution de campagne sur le 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
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) External ID of the user",
"$insert_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" : "(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) 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
| // SMS Inbound Received: 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) 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) BSON ID of subscription group",
"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) 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
| // 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",
"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) The user's phone number from which the message was received"
},
"user_identities" : {
"customerid" : "(required, string) 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
| // 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) 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) 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
| // SMS Inbound Received: users.messages.sms.InboundReceive
{
"context" : {
"traits" : {
"phone" : "(required, string) The user's phone number from which the message was received"
},
"device" : { }
},
"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" : "(required, string) External ID of the user"
}
|
Événements d’impression des indicateurs de fonctionnalité
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 indicateurs 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
{
"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",
"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_id" : "(optional, string) ID of the device on which the event occurred",
"$device" : "(optional, string) Model of the device",
"distinct_id" : "(required, string) 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
| // Feature Flag Experiment Impression: 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) 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) External ID of the user",
"feature_flag_id_name" : "(optional, string) The Feature Flag Rollout identifier",
"gender" : "(optional, string) Gender of the user, one of ['M', 'F', 'O', 'N', 'P']",
"id" : "(required, string) Globally unique ID for this event",
"language" : "(optional, string) 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"
}
|
1
2
3
4
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
| // Feature Flag Experiment Impression: users.messages.featureflag.Impression
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred",
"device_model" : "(optional, string) Model of the device",
"platform" : "(optional, string) Platform of the device"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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"
},
"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) 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
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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_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) 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 Impression: users.messages.featureflag.Impression
{
"context" : {
"traits" : { },
"device" : {
"model" : "(optional, string) Model of the device",
"type" : "(optional, string) Platform of the device"
}
},
"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",
"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_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",
"platform" : "(optional, string) Platform of the device"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(required, string) External ID of the user"
}
|
Événements de conversion de campagne
Cet événement se produit lorsqu’un utilisateur effectue une action définie comme événement de conversion dans une campagne.
important:
Notez que l’événement de conversion est encodé dans le champconversion_behavior, qui inclut le type d’événement de conversion, la fenêtre (période) 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.
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
| // Campaign Conversion: users.campaigns.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",
"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",
"distinct_id" : "(required, string) 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
| // Campaign Conversion: 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",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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
| // Campaign Conversion: 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"
},
"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) 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
| // Campaign Conversion: users.campaigns.Conversion
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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) 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
| // Campaign Conversion: users.campaigns.Conversion
{
"context" : {
"traits" : { },
"device" : { }
},
"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",
"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"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(required, string) External ID of the user"
}
|
Événements de conversion Canvas
Cet événement se produit lorsqu’un utilisateur effectue une action définie comme un événement de conversion dans Canvas.
important:
Notez que l’événement de conversion est encodé dans le champconversion_behavior, qui inclut le type d’événement de conversion, la fenêtre (période) 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
23
| // Canvas Conversion: users.canvas.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",
"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",
"distinct_id" : "(required, string) 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
| // Canvas Conversion: 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) 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"
}
|
1
2
3
4
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 Conversion: 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"
},
"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) 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
| // Canvas Conversion: users.canvas.Conversion
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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"
},
"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) 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
| // Canvas Conversion: users.canvas.Conversion
{
"context" : {
"traits" : { },
"device" : { }
},
"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",
"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"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(required, string) External ID of the user"
}
|
Événements d’entrée Canvas
Cet événement se produit lorsqu’un utilisateur entre dans le Canvas. Cet événement vous dit 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
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) External ID of the user",
"$insert_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",
"token" : "(required, string) The Mixpanel API token"
}
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
| // Canvas Entry: 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) 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"
}
|
1
2
3
4
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
| // Canvas Entry: 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"
},
"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) 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
| // 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) 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
| // Canvas Entry: users.canvas.Entry
{
"context" : {
"traits" : { },
"device" : { }
},
"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" : "(required, string) External ID of the user"
}
|
Événements de progression des étapes 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
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_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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",
"distinct_id" : "(required, string) External ID of the user",
"$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
| // Canvas Step Progression: 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) 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"
}
|
1
2
3
4
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
| // Canvas Step Progression: 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_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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"
},
"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) 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
| // 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_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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) 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
| // Canvas Step Progression: users.canvasstep.Progression
{
"context" : {
"traits" : { },
"device" : { }
},
"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_entry_id" : "(required, string) Unique identifier for this instance of a user in a canvas",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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" : "(required, string) External ID of the user"
}
|
Événements d’inscription à un groupe de contrôle de campagne
Cet événement se produit lorsqu’un utilisateur est inscrit dans une variante de contrôle définie sur une campagne à plusieurs variantes. Cet événement est généré car il n’y aura pas d’événement d’envoi sur 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
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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"distinct_id" : "(required, string) 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
| // Campaign Control Group Enrollment: 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",
"dispatch_id" : "(optional, string) ID of the dispatch this message belongs to",
"external_user_id" : "(optional, string) 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"
}
|
1
2
3
4
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
| // Campaign Control Group Enrollment: 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"
},
"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) 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
| // Campaign Control Group Enrollment: users.campaigns.EnrollInControl
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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) 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
| // Campaign Control Group Enrollment: users.campaigns.EnrollInControl
{
"context" : {
"traits" : { },
"device" : { }
},
"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",
"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"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(required, string) External ID of the user"
}
|
Événements d’abonnement
Cet événement se produit lorsque le statut d’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
| // 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"email_address" : "(optional, string) Email address of the user",
"distinct_id" : "(required, string) 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",
"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
| // Subscription Group State Change: 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",
"email_address" : "(optional, string) Email address of the user",
"external_user_id" : "(optional, string) 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) 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"
}
|
1
2
3
4
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
| // Subscription Group State Change: 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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'"
},
"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" : {
"email" : "(optional, string) Email address of the user",
"customerid" : "(required, string) 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
| // Subscription Group State Change: users.behaviors.subscriptiongroup.StateChange
{
"device_id" : "(optional, string) ID of the device on which the event occurred",
"event_properties" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"email_address" : "(optional, string) 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) 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
| // Subscription Group State Change: users.behaviors.subscriptiongroup.StateChange
{
"context" : {
"traits" : {
"email" : "(optional, string) Email address of the user"
},
"device" : { }
},
"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",
"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",
"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" : "(required, string) External ID of the user"
}
|
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 |
Endpoints 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 du canvas |
Lorsqu’un utilisateur est mis à jour par l’étape du canvas de mise à jour de l’utilisateur |
Événements de changement d’état 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
| // 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_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"email_address" : "(optional, string) Email address of the user",
"distinct_id" : "(required, string) 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",
"state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.",
"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
| // Global Subscription State Change: 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",
"email_address" : "(optional, string) Email address of the user",
"external_user_id" : "(optional, string) 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' 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"
}
|
1
2
3
4
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
| // Global Subscription State Change: users.behaviors.subscription.GlobalStateChange
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"events" : [
{
"data" : {
"custom_attributes" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"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' 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" : {
"email" : "(optional, string) Email address of the user",
"customerid" : "(required, string) 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
| // Global Subscription State Change: users.behaviors.subscription.GlobalStateChange
{
"event_properties" : {
"app_id" : "(optional, string) API ID of the app on which this event occurred",
"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",
"email_address" : "(optional, string) 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' 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) 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
| // Global Subscription State Change: users.behaviors.subscription.GlobalStateChange
{
"context" : {
"traits" : {
"email" : "(optional, string) Email address of the user"
},
"device" : { }
},
"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",
"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",
"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' or 'Unsubscribed'"
},
"timestamp" : "(required, int) UNIX timestamp at which the event happened",
"type" : "track",
"userId" : "(required, string) External ID of the user"
}
|
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 |
Endpoints 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 du canvas |
Lorsqu’un utilisateur est mis à jour par l’étape de mise à jour de l’utilisateur Canvas |
Événements de désinstallation
Cet événement se produit lorsqu’un utilisateur désinstalle une application. Utilisez ces données pour suivre les utilisateurs qui désinstallent une application. C’est actuellement un événement d’engagement via message, mais cela sera changé en événement de comportement utilisateur dans le futur.
important:
Cet événement n’est pas déclenché au moment précis où l’utilisateur désinstalle réellement l’application, car cette action est impossible à suivre exactement. Braze envoie une notification push silencieuse quotidienne pour déterminer si l’application existe toujours sur l’appareil de votre utilisateur, et si nous obtenons une erreur sur cette notification push silencieuse, on suppose alors que l’application a été désinstallée.
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_id" : "(optional, string) API ID of the app on which this event occurred",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred",
"distinct_id" : "(required, string) 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
| // Uninstall: 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) 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"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| // Uninstall: 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_id" : "(optional, string) API ID of the app on which this event occurred",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"device_id" : "(optional, string) ID of the device on which the event occurred"
},
"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) External ID of the user"
}
}
|
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_id" : "(optional, string) API ID of the app on which this event occurred",
"app_group_id" : "(optional, string) API ID of the app group this user 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) External ID of the user"
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
| // Uninstall: users.behaviors.Uninstall
{
"context" : {
"traits" : { },
"device" : { }
},
"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",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"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" : "(required, string) External ID of the user"
}
|
Modifier cette page sur GitHub