Message engagement events
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.
その他のイベントの種類にアクセスする必要がある場合は、アカウントマネージャーに問い合わせるか、サポートチケットを開いてください。必要な情報がこの記事に見つからない場合は、 顧客行動イベント ライブラリまたは Currents サンプルデータの例をご覧ください。
電文エンゲージメント事象の構成とプラットフォーム値の説明
イベントの構造
このイベントの内訳は、メッセージエンゲージメントイベントに一般的に含まれる情報のタイプを示します。開発者とビジネスインテリジェンス戦略チームは、情報の構成要素をしっかり理解したうえで、受信した Currents イベントデータを使用して、データドリブン型のレポートやグラフを作成したり、その他の貴重なデータ指標を活用したりすることができます。
別にグループ化されたリストされたプロパティーを持つメール 配信停止イベントを示すメッセージエンゲージメントイベントの内訳
メッセージエンゲージメントイベントは、ユーザー固有のプロパティ、キャンペーン / キャンバス追跡プロパティ、 およびイベント固有のプロパティで構成されます。
プラットフォームの値
特定のイベントは、ユーザーのデバイスのプラットフォームを示す platform 値を返します。
次の表に、返される可能性のある値の詳細を示します。
| ユーザーデバイス | プラットフォーム値 |
|---|---|
| iOS | ios |
| Android | android |
| FireTV | kindle |
| キンドル | kindle |
| Web | web |
| tvOS | tvos |
| Roku | roku |
important:
ストレージスキーマは、フラットファイルイベントデータにアプリしてデータウェアハウスパートナー(Google Cloud Storage、Amazon S3、およびMicrosoft Azure Blob Storage)に送信します。ここにリストされているいくつかの事象と送信先の組合せは、まだ一般的には利用できません。各パートナーでサポートされているイベントについては、利用可能なパートナーのリストを参照し、それぞれのページを確認してください。
さらに、Currents は 900 KB 超の過度に大きいペイロードを持つイベントをドロップすることに注意してください。
WhatsApp 既読イベント
このイベントは、WhatsApp メッセージがエンドユーザーによって既読になったときに発生します。
WhatsApp 配信イベント
このイベントは、送信された WhatsApp メッセージがエンドユーザーデバイスに正常に着信したときに発生します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
// WhatsApp Delivery: users.messages.whatsapp.Delivery
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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" : "(optional, string) ID of the card this in-app message comes from",
"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)"
},
"time" : "(required, long) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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
44
45
46
47
48
49
50
// 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')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
WhatsApp 失敗イベント
このイベントは、WhatsApp がユーザーにメッセージを配信できないときに発生します。ハードバウンスとは、永続的な配信の失敗です。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// WhatsApp Failure: users.messages.whatsapp.Failure
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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" : "(optional, string) ID of the card this in-app message comes from",
"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)"
},
"time" : "(required, long) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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
46
47
48
49
50
51
52
// 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')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
WhatsApp 送信イベント
このイベントは、Braze と WhatsApp の間で送信リクエストが正常に通信されたときに発生します。ただし、これはメッセージがエンドユーザーによって受信されたことを意味しません。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// WhatsApp Send: users.messages.whatsapp.Send
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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" : "(optional, string) ID of the card this in-app message comes from",
"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)"
},
"time" : "(required, long) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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
45
46
47
48
49
50
51
// 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')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
WhatsApp メッセージ中止イベント
このイベントは、WhatsApp メッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。
1
2
3
4
5
6
7
8
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 Abort: users.messages.whatsapp.Abort
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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) ID of the card this in-app message comes from",
"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)"
},
"time" : "(required, long) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_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
45
46
47
48
49
50
51
// 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')",
"event" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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"
}
WhatsApp インバウンド受信イベント
このイベントは、ユーザーの 1 人が Braze WhatsApp サブスクリプショングループのいずれかの電話番号に WhatsApp メッセージを送信したときに発生します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
// WhatsApp Inbound Received: users.messages.whatsapp.InboundReceive
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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",
"card_id" : "(optional, string) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, long) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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
46
47
48
49
50
51
52
// WhatsApp Inbound Received: users.messages.whatsapp.InboundReceive
{
"device_info" : {
"ios_idfv" : "(optional, string) ID of the device on which the event occurred"
},
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
コンテンツカードのメッセージ中止イベント
このイベントは、コンテンツカードのメッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。
1
2
3
4
5
6
7
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
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_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
43
44
45
46
47
48
49
// 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')",
"event" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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"
}
メールメッセージ中止イベント
このイベントは、メールメッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。
1
2
3
4
5
6
7
8
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
// Email Abort: users.messages.email.Abort
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_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
45
46
47
48
49
50
51
// 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')",
"event" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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"
}
プッシュ通知中止イベント
このイベントは、プッシュ通知メッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。
1
2
3
4
5
6
7
8
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 Abort: users.messages.pushnotification.Abort
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"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) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"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
45
46
47
48
49
50
51
// 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')",
"event" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"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"
}
SMS メッセージ中止イベント
このイベントは、SMS メッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。
1
2
3
4
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 Abort: users.messages.sms.Abort
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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) ID of the card this in-app message comes from",
"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" : {
"external_user_id" : "(required, string) External ID 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
// 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_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
39
40
41
42
43
44
45
// SMS Abort: users.messages.sms.Abort
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"event" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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"
}
Webhook メッセージ中止イベント
この事象は、リキッドアボートまたは静止時間に基づいてWebhookメッセージがアボートされた場合に発生します。
1
2
3
4
5
6
7
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
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_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
43
44
45
46
47
48
49
// 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')",
"event" : [
{
"data" : {
"custom_attributes" : {
"abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)",
"abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']",
"app_group_id" : "(optional, string) API ID of the app group this user belongs to",
"campaign_id" : "(optional, string) API ID of the campaign this event belongs to",
"campaign_name" : "(optional, string) Name of the campaign",
"canvas_id" : "(optional, string) API ID of the Canvas this event belongs to",
"canvas_name" : "(optional, string) Name of the Canvas",
"canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to",
"canvas_step_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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"
}
イベント実行によるキャンバス離脱イベント
このイベントは、ユーザーがイベントを実行してキャンバスを離脱したときに発生します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Exit Perform Event: users.canvas.exit.PerformedEvent
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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",
"card_id" : "(optional, string) ID of the card this in-app message comes from"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"external_user_id" : "(required, string) External ID 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
// 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
32
33
34
35
36
37
38
// Exit Perform Event: users.canvas.exit.PerformedEvent
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
オーディエンス照合によるキャンバス離脱イベント
このイベントは、ユーザーがオーディエンスを照合してキャンバスを離脱したときに発生します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Exit Match Audience: users.canvas.exit.MatchedAudience
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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",
"card_id" : "(optional, string) ID of the card this in-app message comes from"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"external_user_id" : "(required, string) External ID 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
// 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
32
33
34
35
36
37
38
// Exit Match Audience: users.canvas.exit.MatchedAudience
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
実験分割エントリイベント
このイベントは、ユーザーがキャンバスの実験ステップパスに入ったときに発生します。
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 Split Entry: users.canvas.experimentstep.SplitEntry
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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",
"card_id" : "(optional, string) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"external_user_id" : "(required, string) External ID 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
// 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
35
36
37
38
39
40
41
// Experiment Split Entry: users.canvas.experimentstep.SplitEntry
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
実験コンバージョンイベント
このイベントは、キャンバスの実験ステップでユーザーのコンバージョンが起きたときに発生します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// Experiment Step Conversion: users.canvas.experimentstep.Conversion
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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",
"card_id" : "(optional, string) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"external_user_id" : "(required, string) External ID 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
// 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
36
37
38
39
40
41
42
// Experiment Step Conversion: users.canvas.experimentstep.Conversion
{
"device_info" : { },
"environment" : "(required, string) The mParticle environment (either 'development' or 'production')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
プッシュ送信イベント
このイベントは、Braze がユーザー宛てのプッシュメッセージを処理し、Apple Push Notification Service または Fire Cloud Messaging に伝達したときに発生します。これは、プッシュがデバイスに配信されたという意味ではなく、単にメッセージが送信されたことを意味します。
1
2
3
4
5
6
7
8
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 Send: users.messages.pushnotification.Send
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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
// 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_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
49
50
51
52
53
54
55
// 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')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
プロパティの詳細
ad_id、ad_id_type、およびad_tracking_enabledについては、ネイティブ SDK を通じて、iOS IDFA と Android Google 広告 ID を明示的に収集する必要があります。iOS およびAndroid の設定について詳しく説明します。- Kafka を使用して Currents データを取り込んでいる場合は、カスタマーサクセスマネージャーに連絡して、
ad_idの送信を有効にしてください。 message_extrasを使用すると、Connected Content からのダイナミックなデータ、カスタム属性 (言語、国など)、およびキャンバスエントリのプロパティを使用して、送信イベントに注釈を付けることができます。詳細については、Message extras を参照してください。
プッシュオープンイベント
このイベントは、ユーザーがプッシュ通知を直接クリックしてアプリケーションを開いたときに発生します。現在、プッシュオープンイベントは、厳密に言うと「オープン数の合計」ではなく「直接オープン数」を指します。キャンペーンレベルの「誘発された開封数」に表示される統計情報は、ユーザーレベルで寄与していないため、これに含まれません。
1
2
3
4
5
6
7
8
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
// Push Notification Open: users.messages.pushnotification.Open
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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_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_name" : "(optional, string) Name of the Canvas step",
"canvas_variation_id" : "(optional, 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) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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
// 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_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
49
50
51
52
53
54
55
// 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')",
"event" : [
{
"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')"
}
],
"events" : [
{
"data" : {
"custom_attributes" : { }
}
}
],
"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"
}
プロパティの詳細
ad_id、ad_id_type、およびad_tracking_enabledについては、ネイティブ SDK を通じて、iOS IDFA と Android Google 広告 ID を明示的に収集する必要があります。iOS と Android 向けのこの設定については、リンク先を参照してください。- Kafka を使用して Currents データを取り込んでいる場合は、カスタマーサクセスマネージャーに連絡して、
ad_idの送信を有効にしてください。
iOS フォアグラウンドのプッシュ通知イベント
このイベントは Swift SDK ではサポートされておらず、 Obj-C SDK では非推奨になりました。
1
2
3
4
5
6
7
8
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 iOS Foreground Open: users.messages.pushnotification.IosForeground
{
"event_type" : "(required, string) The name of the event type",
"id" : "(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) ID of the card this in-app message comes from",
"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"
},
"time" : "(required, int) UNIX timestamp at which the event happened",
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"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
// 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
// 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_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"
}
プロパティの詳細
ad_id、ad_id_type、およびad_tracking_enabledについては、ネイティブ SDK を通じて、iOS IDFA と Android Google 広告 ID を明示的に収集する必要があります。iOS と Android 向けのこの設定については、リンク先を参照してください。- Kafka を使用して Currents データを取り込んでいる場合は、カスタマーサクセスマネージャーに連絡して、
ad_idの送信を有効にしてください。