Message engagement events

WhatsApp 既読イベント

このイベントは、WhatsApp メッセージがエンドユーザーによって既読になったときに発生します。

```json // WhatsApp 既読: users.messages.whatsapp.Read

{ “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received, “canvas_variation_id”: (optional, string) Canvas variation ID of the variation this event belongs to, “canvas_variation_name”: (optional, string) name of the Canvas variation this event belongs to, “company_id”: (optional, string) ID of the sending Company, “dispatch_id”: (optional, string) ID of the dispatch this message belongs to, “external_user_id”: (optional, string) External user ID of the user, “from_phone_number”: (optional, string) phone number used to send, “message_variation_id”: (optional, string) message variation ID of the variation this user received, “message_variation_name”: (optional, string) name of the message variation this user received, “subscription_group_id”: (optional, string) ID of the sending subscription group, “time”: (optional, int) 10-digit UTC time of the event in seconds since the epoch, “to_phone_number”: (optional, string) phone number of User receiving the message, “user_id”: (required, string) Braze ID of the user that performed this event } ```

WhatsApp 配信イベント

このイベントは、送信された WhatsApp メッセージがエンドユーザーデバイスに正常に着信したときに発生します。

```json // WhatsApp 配信: users.messages.whatsapp.Delivery

{ “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) ID of the Canvas step this event belongs to, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) Canvas variation ID of the variation this event belongs to, “canvas_variation_name”: (optional, string) name of the Canvas variation this event belongs to, “company_id”: (optional, string) ID of the sending Company, “dispatch_id”: (optional, string) ID of the dispatch this message belongs to, “external_user_id”: (optional, string) External user ID of the user, “from_phone_number”: (optional, string) phone number used to send, “message_variation_id”: (optional, string) message variation ID of the variation this user received, “message_variation_name”: (optional, string) name of the message variation this user received, “subscription_group_id”: (optional, string) ID of the sending subscription group, “time”: (optional, int) 10-digit UTC time of the event in seconds since the epoch, “to_phone_number”: (optional, string) phone number of User receiving the message, “user_id”: (required, string) Braze ID of the user that performed this event } ```

WhatsApp 失敗イベント

このイベントは、WhatsApp がユーザーにメッセージを配信できないときに発生します。ハードバウンスは、配信到達性の永続的なエラーを意味します。

```json // WhatsApp 配信失敗: users.messages.whatsapp.Failure

{ “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) ID of the Canvas step this event belongs to, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) Canvas variation ID of the variation this event belongs to, “canvas_variation_name”: (optional, string) name of the Canvas variation this event belongs to, “company_id”: (optional, string) ID of the sending Company, “dispatch_id”: (optional, string) ID of the dispatch this message belongs to, “external_user_id”: (optional, string) External user ID of the user, “from_phone_number”: (optional, string) phone number used to send, “message_variation_id”: (optional, string) message variation ID of the variation this user received, “message_variation_name”: (optional, string) name of the message variation this user received, “provider_error_code”: (optional, string) Error Code from WhatsApp, “provider_error_title”: (optional, string) Description of failure from WhatsApp, “subscription_group_id”: (optional, string) ID of the sending subscription group, “time”: (optional, int) 10-digit UTC time of the event in seconds since the epoch, “to_phone_number”: (optional, string) phone number of User receiving the message, “user_id”: (required, string) Braze ID of the user that performed this event } ```

WhatsApp 送信イベント

このイベントは、Braze と WhatsApp の間で送信リクエストが正常に通信されたときに発生します。ただし、これはメッセージがエンドユーザーによって受信されたことを意味しません。

```json // WhatsApp 送信: users.messages.whatsapp.Send

{ “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) ID of the Canvas step this event belongs to, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) Canvas variation ID of the variation this event belongs to, “canvas_variation_name”: (optional, string) name of the Canvas variation this event belongs to, “company_id”: (optional, string) ID of the sending Company, “dispatch_id”: (optional, string) ID of the dispatch this message belongs to, “external_user_id”: (optional, string) External user ID of the user, “from_phone_number”: (optional, string) phone number used to send, “message_extras”: (optional, string) Liquid tags related fields, “message_variation_id”: (optional, string) message variation ID of the variation this user received, “message_variation_name”: (optional, string) name of the message variation this user received, “subscription_group_id”: (optional, string) ID of the sending subscription group, “time”: (optional, int) 10-digit UTC time of the event in seconds since the epoch, “to_phone_number”: (optional, string) phone number of User receiving the message, “user_id”: (required, string) Braze ID of the user that performed this event } ```

WhatsApp メッセージ中止イベント

このイベントは、WhatsApp メッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。

```json // WhatsApp 中止: users.messages.whatsapp.Abort

{ “abort_log”: (optional, string) log message describing abort details (MAX: 128 CHARS), “abort_type”: (optional, string) type of abort, e.g.: “liquid_abort_message”, “quiet_hours”, etc., “action”: (optional, string) action taken in response to this message (for example, Subscribed, Unsubscribed, or None), “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) id of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) id of the Canvas step this event belongs to, “canvas_step_message_variation_id”: (optional, string) id of the Canvas step message variation this user received, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) Canvas variation ID of the variation this event belongs to, “canvas_variation_name”: (optional, string) name of the Canvas variation this event belongs to, “company_id”: (optional, string) id of the sending Company, “dispatch_id”: (optional, string) ID of the dispatch this message belongs to, “external_user_id”: (optional, string) External user ID of the user, “message_variation_id”: (optional, string) message variation ID of the variation this user received, “message_variation_name”: (optional, string) name of the message variation this user received, “send_id”: (optional, string) message send ID this message belongs to, “subscription_group_id”: (optional, string) ID of the sending subscription group, “time”: (optional, int) 10-digit UTC time of the event in seconds since the epoch, “user_id”: (required, string) Braze ID of the user that performed this event ```

WhatsApp インバウンド受信イベント

このイベントは、ユーザーの 1 人が Braze WhatsApp サブスクリプショングループのいずれかの電話番号に WhatsApp メッセージを送信したときに発生します。

```json // WhatsApp インバウンド受信: users.messages.whatsapp.InboundReceive

{ “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) ID of the Canvas step this event belongs to, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) Canvas variation ID of the variation this event belongs to, “canvas_variation_name”: (optional, string) name of the Canvas variation this event belongs to, “company_id”: (optional, string) ID of the sending Company, “dispatch_id”: (optional, string) ID of the dispatch this message belongs to, “external_user_id”: (optional, string) External user ID of the user, “inbound_phone_number”: (optional, string)the inbound number that the message was sent to, “medial_urls”: (optional, string[]) media urls from the user, “message_body”: (optional, string) typed response from the user, “message_variation_id”: (optional, string) message variation ID of the variation this user received, “message_variation_name”: (optional, string) name of the message variation this user received, “quick_reply_text”: (optional, string) test of button pressed by the user, “subscription_group_id”: (optional, string) ID of the sending subscription group, “time”: (optional, int) 10-digit UTC time of the event in seconds since the epoch, “user_phone_number”: (optional, string) the user’s phone number from which the message was received, “user_id”: (required, string) Braze ID of the user that performed this event } ```

コンテンツカードのメッセージ中止イベント

このイベントは、コンテンツカードのメッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。

```json // コンテンツカードの中止: users.messages.contentcard.Abort

{ “abort_log”: (optional, string) log message describing abort details (MAX: 128 CHARS), “abort_type”: (optional, string) type of abort, e.g.: “liquid_abort_message”, “quiet_hours”, etc., “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) ID of the Canvas step this event belongs to, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) Canvas variation ID of the variation this event belongs to, “canvas_variation_name”: (optional, string) name 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 user ID of the user, “id”: (required, string) globally unique ID of this event, “message_variation_id”: (optional, string) message variation ID of the variation this user received, “message_variation_name”: (optional, string) name of the message variation this user received, “send_id”: (optional, string) message send ID this message belongs to, “time”: (required, int) unix timestamp at which the event happened, “timezone”: (optional, string) timezone of the user, “user_id”: (required, string) Braze ID of the user that performed this event } ```

メールメッセージ中止イベント

このイベントは、メールメッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。

```json // メール中止: users.messages.email.Abort

{ “abort_log”: (optional, string) log message describing abort details (MAX: 128 CHARS), “abort_type”: (optional, string) type of abort, e.g.: “liquid_abort_message”, “quiet_hours”, etc., “app_group_id”: (optional, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) ID of the Canvas step this event belongs to, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) Canvas variation ID of the variation this event belongs to, “canvas_variation_name”: (optional, string) name 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, “email_address”: (required, string) email address of the user, “external_user_id”: (optional, string) External user ID of the user, “id”: (required, string) globally unique ID of this event, “ip_pool”: (optional, string) IP Pool from which the email send was made “message_variation_id”: (optional, string) message variation ID of the variation this user received, “message_variation_name”: (optional, string) name of the message variation this user received, “send_id”: (optional, string) message send ID this message belongs to, “time”: (required, int) unix timestamp at which the event happened, “timezone”: (optional, string) timezone of the user, “user_id”: (required, string) Braze ID of the user that performed this event, } ```

プッシュ通知中止イベント

このイベントは、プッシュ通知メッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。

```json // プッシュ通知中止: users.messages.pushnotification.Abort

{ “abort_log”: (optional, string) log message describing abort details (MAX: 128 CHARS), “abort_type”: (optional, string) type of abort, e.g.: “liquid_abort_message”, “quiet_hours”, etc., “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “app_id”: (required, string) Braze ID of the app this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) ID of the step for this message if from a Canvas, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received “canvas_step_name”: (optional, string) API ID of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) ID of the Canvas variation this event belongs to, “canvas_variation_name”: (optional, string) name of the Canvas variation the user is in if from a Canvas, “device_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 user ID of the user, “id”: (required, string) unique ID of this event, “message_variation_id”: (optional, string) ID of the message variation this user received, “message_variation_name”: (optional, string) name of the Canvas variation the user is in if from a Canvas, “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) IANA time zone of the user at the time of the event, “user_id”: (required, string) Braze ID of the user that performed this event } ```

SMS メッセージ中止イベント

このイベントは、SMS メッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。

```json // SMS 中止: users.messages.sms.Abort

{ “abort_log”: (optional, string) log message describing abort details (MAX: 128 CHARS), “abort_type”: (optional, string) type of abort, e.g.: “liquid_abort_message”, “quiet_hours”, etc., “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) ID of the step for this message if from a Canvas, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received “canvas_step_name”: (optional, string) API ID of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) ID of the Canvas variation this event belongs to, “canvas_variation_name”: (optional, string) name of the Canvas variation the user is in if from a Canvas, “external_user_id”: (optional, string) External user ID of the user, “id”: (required, string) globally unique ID of this event, “message_variation_id”: (optional, string) ID of the message variation this user received, “message_variation_name”: (optional, string) name of the Canvas variation the user is in if from a Canvas, “subscription_group_id”: (optional, string) ID of the subscription group targeted for this SMS message, “time”: (required, int) unix timestamp at which the event happened, “user_id”: (required, string) Braze ID of the user that performed this event } ```

Webhook メッセージ中止イベント

このイベントは、Webhook メッセージが Liquid の中止、サイレント時間などに基づいて中止された場合に発生します。

```json // Webhook 中止: users.messages.webhook.Abort

{ “abort_log”: (optional, string) log message describing abort details (MAX: 128 CHARS), “abort_type”: (optional, string) type of abort, e.g.: “liquid_abort_message”, “quiet_hours”, etc., “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “campaign_id”: (optional, string) internal-use Braze ID of the campaign this event belongs to, “campaign_name”: (optional, string) name of the campaign, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_step_id”: (optional, string) ID of the step for this message if from a Canvas, “canvas_step_message_variation_id”: (optional, string) ID of the Canvas step message variation this user received “canvas_step_name”: (optional, string) API ID of the Canvas step this event belongs to, “canvas_variation_id”: (optional, string) ID of the Canvas variation this event belongs to, “canvas_variation_name”: (optional, string) name of the Canvas variation the user is in if from a Canvas, “device_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 user ID of the user, “id”: (required, string) globally unique ID of this event, “message_variation_id”: (optional, string) ID of the message variation this user received, “message_variation_name”: (optional, string) name of the message variation the user is in if from a Canvas, “send_id”: (optional, string) message send ID this message belongs to, “time”: (required, int) unix timestamp at which the event happened, “timezone”: (optional, string) IANA time zone of the user at the time of the event, “user_id”: (required, string) Braze ID of the user that performed this event } ```

イベント実行によるキャンバス離脱イベント

このイベントは、ユーザーがイベントを実行してキャンバスを離脱したときに発生します。

```json // キャンバス離脱実行イベント: users.canvas.exit.PerformedEvent

{ “id”: (required, string) globally unique ID of this event, “user_id”: (required, string) Braze user ID of the user, “external_user_id”: (optional, string) External user ID of the user, “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “app_group_api_id”: (optional, string) API ID of the workspace this user belongs to, “time”: (required, int) unix timestamp at which the event happened, “canvas_id”: (required, string) ID of the Canvas if from a Canvas, “canvas_variation_id”: (required, string) ID of the Canvas variation the user is in if from a Canvas, “canvas_step_id”: (optional, string) ID of the step for this message if from a Canvas, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “canvas_api_id”: (optional, string) Braze ID of the experiment step this event belongs to, “canvas_variation_api_id”: (optional, string) API ID of the Canvas variation this event belongs to, “canvas_step_api_id”: (optional, string) API ID of the Canvas step this event belongs to } ```

オーディエンス照合によるキャンバス離脱イベント

このイベントは、ユーザーがオーディエンスを照合してキャンバスを離脱したときに発生します。

```json // キャンバス離脱のオーディエンス照合: users.canvas.exit.MatchedAudience

{ “id”: (required, string) globally unique ID of this event, “user_id”: (required, string) Braze user ID of the user, “external_user_id”: (optional, string) External user ID of the user, “app_group_id”: (required, string) Braze ID of the workspace this user belongs to, “app_group_api_id”: (optional, string) API ID of the workspace this user belongs to, “time”: (required, int) unix timestamp at which the event happened, “canvas_id”: (required, string) ID of the Canvas if from a Canvas, “canvas_variation_id”: (required, string) ID of the Canvas variation the user is in if from a Canvas, “canvas_step_id”: (optional, string) ID of the step for this message if from a Canvas, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “canvas_api_id”: (optional, string) Braze ID of the experiment step this event belongs to, “canvas_variation_api_id”: (optional, string) API ID of the Canvas variation this event belongs to, “canvas_step_api_id”: (optional, string) API ID of the Canvas step this event belongs to } ```

実験分割エントリイベント

このイベントは、ユーザーがキャンバスの実験ステップパスに入ったときに発生します。

```json // 実験ステップの分岐パス侵入: users.canvas.experimentstep.SplitEntry

{ “id”: (required, string) globally unique ID of this event, “user_id”: (required, string) Braze user ID of the user, “external_user_id”: (optional, string) External user ID of the user, “time”: (required, int) unix timestamp at which the event happened, “canvas_id”: (optional, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_variation_id”: (optional, string) ID of the Canvas variation the user is in if from a Canvas, “canvas_variation_name”: (optional, string) name of the Canvas variation the user is in if from a Canvas, “experiment_step_id”: (required, string) Braze ID of the experiment step this event belongs to, “canvas_step_id”: (optional, string) ID of the step for this message if from a Canvas, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “experiment_split_id”: (optional, string) Braze ID of the experiment split the user enrolled in, “experiment_split_name”: (optional, string) name of the experiment split the user enrolled in, “in_control_group”: (required, boolean) whether the user was enrolled in the control group } ```

実験コンバージョンイベント

このイベントは、キャンバスの実験ステップでユーザーのコンバージョンが起きたときに発生します。

```json // 実験ステップでのコンバージョン: users.canvas.experimentstep.Conversion

{ “id”: (required, string) globally unique ID of this event, “user_id”: (required, string) Braze user ID of the user, “external_user_id”: (optional, string) External user ID of the user, “app_id”: (optional, string) Braze ID of the app this user belongs to, “time”: (required, int) unix timestamp at which the event happened, “canvas_id”: (required, string) ID of the Canvas if from a Canvas, “canvas_name”: (optional, string) name of the Canvas, “canvas_variation_id”: (optional, string) ID of the Canvas variation the user is in if from a Canvas, “canvas_variation_name”: (optional, string) name of the Canvas variation the user is in if from a Canvas, “canvas_step_id”: (optional, string) ID of the step for this message if from a Canvas, “canvas_step_name”: (optional, string) name of the Canvas step this event belongs to, “experiment_step_id”: (optional, string) Braze ID of the experiment step this event belongs to, “experiment_split_id”: (required, string) Braze ID of the experiment split variation this user received, “experiment_split_name”: (optional, string) name of the experiment split the user enrolled in, “conversion_behavior_index”: (optional, int) index of the conversion behavior, “conversion_behavior”: (optional, string) conversion behavior } ```

プッシュ送信イベント

このイベントは、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
// Push Notification Send: users.messages.pushnotification.Send
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "external_user_id": (optional, string) External ID of the user,
  "app_id": (required, string) ID for the app on which the user action occurred,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,  
  "platform": (required, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'),
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) name of the message variation the user is in if from a Canvas,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name of the Canvas step this event belongs to,  
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user.,
  "device_id": (optional, string) ID of the device that we made a delivery attempt to,
  "ad_id": (optional, string) advertising identifier,
  "ad_id_type": (optional, string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id',
  "ad_tracking_enabled": (optional, boolean) whether advertising tracking is enabled for the device,
  "message_extras": (optional, string) key-value pairs sent with this event
}

プロパティの詳細

• ad_id、ad_id_type、および ad_tracking_enabled については、ネイティブ SDK を通じて、iOS IDFA と Android Google 広告 ID を明示的に収集する必要があります。iOSad_id と Androidad_id_type 向けのこの設定については、リンク先を参照してください。
• 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
// Push Notification Open: users.messages.pushnotification.Open
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "external_user_id": (optional, string) External ID of the user,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,
  "app_id": (required, string) ID for the app on which the user action occurred,
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) the name of the message variation if from a campaign,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name 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,
  "platform": (optional, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'),
  "os_version": (optional, string) os version of device used for the action,
  "device_model": (optional, string) hardware model of the device,
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user.,
  "device_id": (optional, string) ID of the device that we made a delivery attempt to,
  "button_action_type": (optional, string) Action type of the push notification,
  button. One of [URI, DEEP_LINK, NONE, CLOSE]. null if not
  from a button click,
  "button_string": (optional, string) identifier (button_string) of the push notification button clicked. null if not from a button click,
  "ad_id": (optional, string) advertising identifier,
  "ad_id_type": (optional, string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id',
  "ad_tracking_enabled": (optional, boolean) whether advertising tracking is enabled for the device
}

プロパティの詳細

• ad_id、ad_id_type、および ad_tracking_enabled については、ネイティブ SDK を通じて、iOS IDFA と Android Google 広告 ID を明示的に収集する必要があります。iOSad_id と Androidad_id_type 向けのこの設定については、リンク先を参照してください。
• 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
// Push Notification iOS Foreground: users.messages.pushnotification.IosForeground
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "external_user_id": (optional, string) External ID of the user,
  "app_id": (required, string) ID for the app on which the user action occurred,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,
  "platform": (required, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'),
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) the name of the message variation if from a campaign,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user.,
  "device_id": (optional, string) ID of the device that we made a delivery attempt to,
  "ad_id": (optional, string) advertising identifier,
  "ad_id_type": (optional, string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id',
  "ad_tracking_enabled": (optional, boolean) whether advertising tracking is enabled for the device
}

プロパティの詳細

• ad_id、ad_id_type、および ad_tracking_enabled については、ネイティブ SDK を通じて、iOS IDFA と Android Google 広告 ID を明示的に収集する必要があります。iOSad_id と Androidad_id_type 向けのこの設定については、リンク先を参照してください。
• Kafka を使用して Currents データを取り込んでいる場合は、カスタマーサクセスマネージャーに連絡して、ad_id の送信を有効にしてください。

プッシュ通知のバウンス

このイベントは、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
// Push Notification Bounce: users.messages.pushnotification.Bounce
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "external_user_id": (optional, string) External ID of the user,
  "app_id": (required, string) ID for the app on which the bounce occurred,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,
  "platform": (optional, string) platform of the device (one of 'ios', 'android', 'web', 'kindle', 'tvos', OR 'roku'),
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) the name of the message variation if from a campaign,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user.,
  "device_id": (optional, string) ID of the device that we made a delivery attempt to,
  "ad_id": (optional, string) advertising identifier,
  "ad_id_type": (optional, string) One of 'ios_idfa', 'google_ad_id', OR 'roku_ad_id',
  "ad_tracking_enabled": (optional, boolean) whether advertising tracking is enabled for the device
}

プロパティの詳細

• Kafka を使用して Currents データを取り込む場合は、ad_id 送信用のフィーチャーフリッパーを有効にするように、カスタマーサクセスマネージャーまたはアカウントマネージャーに依頼してください。

メール送信イベント

このイベントは、Braze と SendGrid の間でメール送信リクエストが正常に通信されたときに発生します。ただし、これは、メールがエンドユーザーの受信トレイに受信されたことを意味しません。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Email Send: users.messages.email.Send
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user,
  "external_user_id": (optional, string) External ID of the user,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) the name of the message variation if from a campaign,
  "email_address": (required, string) email address for this event,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),
  "ip_pool": (optional, string) IP pool used for message sending, 
  "message_extras": (optional, string) key-value pairs sent with this event
}

プロパティの詳細

• dispatch_id の動作は、キャンバスとキャンペーンで異なります。これは、Braze がキャンバスのステップ (スケジュール可能なエントリステップを除く) を、スケジュール済みの場合でもトリガーされたイベントとして扱うためです。詳細については、「ディスパッチ 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
// Email Delivery: users.messages.email.Delivery
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user.,
  "external_user_id": (optional, string) External ID of the user,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) the name of the message variation if from a campaign,
  "email_address": (required, string) email address for this event,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name of the Canvas step this event belongs to,  
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),
  "sending_ip": (optional, string) the IP address from which the message was sent (Email Delivery, Bounce, and SoftBounce events only. Will only be shown on events if the message was actually attempted for delivery. For certain other bounces, the information could be lost if the recipient server has already accepted the mail and only later after the connection is closed decided it could not deliver the mail),
  "ip_pool": (optional, string) IP pool used for message sending,
  "esp": (optional, string) ESP related to the event (SparkPost or SendGrid),
  "from_domain": (optional, string) sending domain for the email
}

プロパティの詳細

• dispatch_id の動作は、キャンバスとキャンペーンで異なります。これは、Braze がキャンバスのステップ (スケジュール可能なエントリステップを除く) を、スケジュール済みの場合でもトリガーされたイベントとして扱うためです。詳細については、「ディスパッチ ID の動作」を参照してください。

メール開封イベント

このイベントは、ユーザーがメールを開封したときに発生します。ユーザーが複数回メールを開封すると、同じキャンペーンについて複数のイベントが生成される場合があります。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// Email Open: users.messages.email.Open
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user,
  "external_user_id": (optional, string) External ID of the user,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) the name of the message variation if from a campaign,
  "email_address": (required, string) email address for this event,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),  
  "user_agent": (optional, string) description of the user's system and browser for the event,
  "ip_pool": (optional, string) IP pool used for message sending,
  "machine_open": (optional, string) Indicator of whether the email was opened by an automated process, such as Apple or Google mail pre-fetching. Currently "true" or null, but additional granularity (for example, "Apple" or "Google" to indicate which process made the fetch) may be added in the future.,
  "esp": (optional, string) ESP related to the event (SparkPost or SendGrid),
  "from_domain": (optional, string) sending domain for the email,
  "is_amp": (optional, boolean) indicates that this is an AMP event,
  "device_class": (optional, string) type of device used, such as 'mobile', 'desktop', 'tablet', 'other',
  "device_os": (optional, string) the operating system used, such as 'os x', 'android', 'iOS',
  "browser": (optional, string) browser used, such as 'chrome', 'edge', 'safari',
  "device_model": (optional, string) model of device used, such as 'iPhone',
  "mailbox_provider": (optional, string) the mailbox provider
}

プロパティの詳細

• dispatch_id の動作は、キャンバスとキャンペーンで異なります。これは、Braze がキャンバスのステップ (スケジュール可能なエントリステップを除く) を、スケジュール済みの場合でもトリガーされたイベントとして扱うためです。詳細については、「ディスパッチ ID の動作」を参照してください。

メールクリックイベント

このイベントは、ユーザーがメールをクリックしたときに発生します。ユーザーがメールを複数回クリックしたり、メール内の異なるリンクをクリックしたりすると、同じキャンペーンについて複数のイベントが生成される場合があります。

1
2
3
4
5
6
7
8
9
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 Click: users.messages.email.Click
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Only included when campaign_id is present. Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user.,
  "external_user_id": (optional, string) External ID of the user,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) the name of the message variation if from a campaign,
  "email_address": (required, string) email address for this event,
  "url": (optional, string) the URL that was clicked,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),
  "user_agent": (optional, string) description of the user's system and browser for the event,
  "ip_pool": (optional, string) IP pool used for message sending,
  "link_id": (optional, string) unique value generated by Braze for the URL - null unless link aliasing is enabled,
  "link_alias": (optional, string) alias name set when the message was sent - null unless link aliasing is enabled,
  "esp": (optional, string) ESP related to the event (SparkPost or SendGrid),
  "from_domain": (optional, string) sending domain for the email,
  "is_amp": (optional, boolean) indicates that this is an AMP event,
  "device_class": (optional, string) type of device used, such as 'mobile', 'desktop', 'tablet', 'other',
  "device_os": (optional, string) the operating system used, such as 'os x', 'android', 'iOS',
  "browser": (optional, string) browser used, such as 'chrome', 'edge', 'safari',
  "device_model": (optional, string) model of device used, such as 'iPhone',
  "mailbox_provider": (optional, string) the mailbox provider
}

プロパティの詳細

• dispatch_id の動作は、キャンバスとキャンペーンで異なります。これは、Braze がキャンバスのステップ (スケジュール可能なエントリステップを除く) を、スケジュール済みの場合でもトリガーされたイベントとして扱うためです。詳細については、「ディスパッチ ID の動作」を参照してください。

メールバウンスイベント

このイベントは、インターネットサービスプロバイダーがハードバウンスを返したときに発生します。ハードバウンスは、配信到達性の永続的なエラーを意味します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Email Bounce: users.messages.email.Bounce
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user.,
  "external_user_id": (optional, string) External ID of the user,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) the name of the message variation if from a campaign,
  "email_address": (required, string) email address for this event,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),
  "sending_ip": (optional, string) the IP address from which the message was sent (Email Delivery, Bounce, and SoftBounce events only. Will only be shown on events if the message was actually attempted for delivery. For certain other bounces, the information could be lost if the recipient server has already accepted the mail and only later after the connection is closed decided it could not deliver the mail),
  "ip_pool": (optional, string) IP pool used for message sending (for certain bounce cases, IP pool will not be provided) ,
  "bounce_reason": (optional, string) reason for bounce provided by server,
  "esp": (optional, string) ESP related to the event (SparkPost or SendGrid),
  "from_domain": (optional, string) sending domain for the email,
  "is_drop": (optional, boolean) indicates that this event counts as a drop event
}

プロパティの詳細

• dispatch_id の動作は、キャンバスとキャンペーンで異なります。これは、Braze がキャンバスのステップ (スケジュール可能なエントリステップを除く) を、スケジュール済みの場合でもトリガーされたイベントとして扱うためです。詳細については、「ディスパッチ ID の動作」を参照してください。

メールソフトバウンスイベント

このイベントは、インターネットサービスプロバイダーがソフトバウンスを返したときに発生します。ソフトバウンスは、一時的な配信到達性のエラーによりメールを配信できなかったことを意味します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// Email Soft Bounce: users.messages.email.SoftBounce
{
  "id": (required, string) unique ID of this event,
  "user_id": (required, string) Braze user ID of the user,
  "dispatch_id": (optional, string) ID of the message dispatch (unique ID for each 'transmission' sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user.,
  "external_user_id": (optional, string) External ID of the user,
  "time": (required, int) 10-digit UTC time of the event in seconds since the epoch,
  "timezone": (optional, string) IANA time zone of the user at the time of the event,
  "campaign_id": (optional, string) ID of the campaign if from a campaign,
  "campaign_name": (optional, string) name of the campaign,
  "message_variation_id": (optional, string) ID of the message variation if from a campaign,
  "message_variation_name": (optional, string) the name of the message variation if from a campaign,
  "email_address": (required, string) email address for this event,
  "canvas_id": (optional, string) ID of the Canvas if from a Canvas,
  "canvas_name": (optional, string) name of the Canvas,
  "canvas_variation_id": (optional, string) ID of the Canvas variation the user is in if from a Canvas,
  "canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
  "canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
  "canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
  "send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types),
  "sending_ip": (optional, string) the IP address from which the message was sent (Email Delivery, Bounce, and SoftBounce events only. Will only be shown on events if the message was actually attempted for delivery. For certain other bounces, the information could be lost if the recipient server has already accepted the mail and only later after the connection is closed decided it could not deliver the mail),
  "ip_pool": (optional, string) IP pool used for message sending(for certain bounce cases, IP pool will not be provided),
  "bounce_reason": (optional, string) reason for bounce provided by server,
  "esp": (optional, string) ESP related to the event (SparkPost or SendGrid),
  "from_domain": (optional, string) sending domain for the email
}