メッセージのアーカイブ

メッセージのアーカイブ機能により、ユーザーに送信されたメッセージのコピーを、保存やコンプライアンス目的でAWS S3バケット、Azure Blob Storageコンテナ、またはGoogle Cloud Storageバケットに保存できる。

この記事では、メッセージのアーカイブ設定、JSONペイロード参照、およびよくある質問について説明する。

メッセージのアーカイブはアドオン機能として利用できます。メッセージのアーカイブを開始するには、Brazeのカスタマーサクセスマネージャーに連絡する。

仕組み

この機能をオンにすると、クラウドストレージバケットをBrazeに接続し、デフォルトのデータ送信先としてマークしている場合、Brazeは、選択したチャネル（メール、SMS/MMS、またはプッシュ）を通じてユーザーに送信された各メッセージについて、gzip圧縮されたJSONファイルをクラウドストレージバケットに書き込む。

このファイルには、[ファイル参照] で定義されたフィールドが含まれており、ユーザーに送信されるテンプレート化された最終的なメッセージが反映されます。キャンペーンで定義されたテンプレートの値 ({{${first_name}}} など) が、プロファイル情報に基づいてユーザーが受け取った最終的な値を示します。これにより、送信したメッセージのコピーを保持して、コンプライアンス、監査、またはカスタマーサポートの要件を満たすことができます。

複数のクラウドストレージプロバイダーの認証情報を設定した場合、メッセージのアーカイブ機能では、デフォルトのデータエクスポート先として明示的にマークされたプロバイダーにのみエクスポートされます。明示的なデフォルトが提供されておらず、AWS S3バケットが接続されている場合、メッセージアーカイブはそのバケットにアップロードされます。

JSON は、次のキー構造を使用してストレージバケットに保存されます。

sent_messages/{channel, one of: email, push, sms}/{MD5 digest of downcased: email address, push token, or E.164 phone number}/{campaign or Canvas step API ID}/{dispatch ID}.json.gz

ファイルの例を以下に示します。

sent_messages/email/819baa08d8d7e77e19d4666f5fc6050b/ee965cb2-8934-4b0a-acf1-91c899c2f915/651fd10b282850b39e1169c13975234b.json.gz

メッセージのアーカイブの設定

このセクションでは、ワークスペースのメッセージアーカイブの設定について説明する。先に進む前に、会社でメッセージアーカイブを購入し、有効にしていることを確認してください。

ステップ 1: クラウドストレージバケットの接続

まだクラウドストレージバケットを接続していない場合は、Braze に接続します。手順については、Amazon S3、Azure Blob Storage または Google Cloud Storage に関するパートナーのドキュメントを参照してください。

ステップ 2:メッセージをアーカイブするチャネルの選択

[メッセージのアーカイブ] の設定ページで、送信するメッセージのコピーをクラウドストレージバケットに保存するチャネルを制御します。

チャネルを選択するには次のステップに従います。

1. [設定] > [メッセージのアーカイブ] に移動します。
2. チャネルを選択します。
3. 変更の保存を選択します。

ファイル参照

以下は、メッセージが送信されるたびにクラウドストレージバケットに配信されるJSONペイロードへの参照である。メッセージのアーカイブのサンプル ファイルについては、コード例リポジトリを参照してください。

• email
• sms/mms
• push

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "version": 1, //numerical version of the JSON structure
  "to": ToAddress, ("customer@example.com")
  "subject": SubjectLine ("20% off coupon inside!"),
  "from_name": DisplayName ("Braze"),
  "from_address": FromAddress ("no-reply@braze.com"),
  "html_body": HtmlBody,
  "plaintext_body": PlainTextBody,
  "amp_body": AMPEmailBody,
  "extras": Hash of key-value pairs from Email Extras configured in the email editor,
  "headers": HashOfHeaders,
  "sent_at": UnixTimestamp,
  "dispatch_id": DispatchIdFromBraze,
  "campaign_id": CampaignApiId, // may not be available
  "canvas_id": CanvasApiId, // may not be available
  "canvas_step_id": CanvasStepApiId, // may not be available
  "canvas_variation_id" : CanvasVariationApiId, // may not be available
  "message_variation_id": MessageVariationApiId, // may not be available,
  "attachments": Array of JSON Objects containing 'bytes' and 'file_name', // may not be available
  "user_id": String,
  "campaign_name": String, // will only be available if the message is from a campaign
  "canvas_name": String, // will only be available if the message is from Canvas
  "canvas_step_name": String, // will only be available if the message is from a Canvas
  "external_id": String
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "version": 1 //numerical version of the JSON structure
  "to": PhoneNumber, ("+15555555555"),
  "body": Body ("Hi there!"),
  "subscription_group": SubscriptionGroupExternalId,
  "provider": StringOfProviderName,
  "media_urls": ArrayOfString, // indicates a message is MMS
  "sent_at": UnixTimestamp,
  "dispatch_id": DispatchIdFromBraze,
  "campaign_id": CampaignApiId, // may not be available
  "canvas_id": CanvasApiId, // may not be available
  "canvas_step_id": CanvasStepApiId, // may not be available
  "canvas_variation_id" : CanvasVariationApiId, // may not be available
  "message_variation_id": MessagVariationApiId, // may not be available
  "user_id": String,
  "campaign_name": String, // will only be available if the message is from a campaign
  "canvas_name": String, // will only be available if the message is from Canvas
  "canvas_step_name": String, // will only be available if the message is from a Canvas
  "external_id": String
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "version": 1, //numerical version of the JSON structure
  "to": PushToken,
  "payload": JsonOfEntirePushPayload,
  "platform": one of "android_push" | "ios_push" | "kindle_push" | "web_push",
  "app_id": ApiKeyOfApp,
  "sent_at": UnixTimestamp,
  "dispatch_id": DispatchIdFromBraze,
  "campaign_id": CampaignApiId, // may not be available
  "canvas_id": CanvasApiApiId, // may not be available
  "canvas_step_id": CanvasStepApiId, // may not be available
  "canvas_variation_id" : CanvasVariationApiId, // may not be available
  "message_variation_id": MessagVariationApiId, // may not be available
  "user_id": String,
  "campaign_name": String, // will only be available if the message is from a campaign
  "canvas_name": String, // will only be available if the message is from a Canvas
  "canvas_step_name": String, // will only be available if the message is from a Canvas
  "external_id": String
}

よくある質問

ペイロードに含まれていないテンプレートは何ですか?

メッセージがBrazeを離れた後に行われた修正は、クラウドストレージバケットに保存されたファイルには反映されない。これには、クリック追跡のためのリンクのラッピングやトラッキングピクセルの挿入など、メール配信パートナーが行う修正も含まれる。

キャンペーンパスの「unassociated」の値の下にあるメッセージは何ですか?

メッセージがキャンペーンまたはキャンバス以外で送信される場合、ファイル名のキャンペーン ID は「unassociated」になります。ダッシュボードからテストメッセージを送信した場合、BrazeがSMS/MMS自動レスポンスを送信した場合、またはAPI経由で送信したメッセージにキャンペーンIDが指定されていない場合に発生する。

この送信に関する詳細情報を見つけるにはどうすればよいですか?

テンプレート化されたメッセージをCurrentsデータと照合して、配信時刻やユーザーが開封・クリックしたuser_idかといった詳細情報を確認するには、またはexternal_idをdispatch_id組み合わせて使用できる。

再試行はどのように処理されますか?

クラウドストレージバケットに到達できない場合、Braze では バックオフジッターを使用して最大 3 回再試行されます。AWS S3 のレート制限の再試行は Braze によって自動的に処理されます。

認証情報が無効の場合、どうなりますか?

クラウドストレージの認証情報がいずれかの時点で無効になった場合、その後 Braze はクラウドストレージバケットにメッセージを保存できなくなり、それらのメッセージは失われます。Amazon Web Services、Google Cloud Services、または Azure（Microsoft Cloud Services）の通知設定を構成することを推奨する。これにより、認証情報の問題が発生した場合にアラートを受け取れるようになる。

アーカイブファイルのsent_at タイムスタンプが Currents の送信タイムスタンプと若干異なるのはなぜか？

レンダリングされたコピーは、ユーザーにメッセージを送る直前にアップロードされる。クラウドストレージのアップロード時刻により、レンダリングされたコピーの sent_at タイムスタンプと実際の送信時刻との間には、数秒の遅延が発生する可能性があります。

現在のバケットを引き続き Currents データ用に使用して、メッセージアーカイブ専用に新しいバケットを作成できますか？

できません。このような特定のバケットの作成に関心がある場合には、製品フィードバックをお送りください。

Currents データエクスポートの仕組みと同様に、アーカイブされたデータは既存のバケット内の専用フォルダーに書き込まれるのですか?

データはバケットのsent_messages セクションに書き込まれます。詳しくは「仕組み」を参照のこと。

メッセージアーカイブを使って、ファイルを異なるワークスペースにグループ分けできるか？

いいえ。メッセージングのアーカイブ機能は、ワークスペースに基づくファイルのグループ化をサポートしていない。代わりに、キャンペーンやキャンバスステップのAPI IDがどのワークスペースに属するかを特定し、その情報に基づいてそれらをグループ化できる。