Skip to content

REST APIを使用したメールメッセージの送信

Braze REST APIを使用して、バックエンドからリアルタイムでトランザクションメールを送信できます。このアプローチにより、プログラムでメールを送信するサービスを構築しながら、Brazeダッシュボードで他のCampaignsやCanvasesと一緒に配信分析を追跡できます。

これは、コンテンツがバックエンドシステムで定義されるトランザクションメッセージングに特に便利です。たとえば、消費者が別のユーザーからメッセージを受信したときに通知し、Webサイトにアクセスして受信トレイを確認するよう促すことができます。

このアプローチでは、以下のことが可能です。

  • バックエンドからリアルタイムでメールをトリガーする。
  • 開封、クリック数、バウンスなど、マーケティング所有のすべてのCampaignsやCanvasesと一緒に分析を追跡する。
  • メッセージインタラクションデータを使用して、フォローアップのリターゲティングなどの後続メッセージをトリガーする。
  • メッセージ遅延やABテストなど、追加のBraze機能でユースケースを拡張する。
  • オプションで、APIトリガー配信に切り替えて、Brazeダッシュボードでメールテンプレートを定義しながら、バックエンドから送信をトリガーする。

REST APIを通じてメールを送信するには、BrazeダッシュボードでAPIキャンペーンを設定し、/messages/sendエンドポイントを使用してメッセージを送信する必要があります。

前提条件

このガイドを完了するには、以下が必要です。

ステップ 1:APIキャンペーンを作成する

  1. Brazeダッシュボードで、メッセージング > Campaignsに移動します。
  2. キャンペーンを作成を選択し、API Campaignを選択します。
  3. キャンペーンの名前と説明を入力します（例:「メールメッセージ通知」）。
  4. 識別と追跡のために関連するタグを追加します。
  5. メッセージングチャネルを追加を選択し、メールを選択します。
  6. キャンペーンページに表示されるCampaign IDをメモします。APIリクエストを構築する際にこの値が必要です。オプションで、Message Variation IDもメモしてください。送信統計を特定のメッセージバリエーションに帰属させたい場合は、リクエストに含めます。

ステップ 2:APIを使用してメールを送信する

/messages/sendエンドポイントへのPOSTリクエストを構築します。リクエストペイロードにCampaign ID、受信者の外部ユーザーID、およびメールコンテンツを含めます。

リクエスト例

1
2
3

POST https://YOUR_REST_ENDPOINT/messages/send
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

YOUR_REST_ENDPOINT をワークスペースのRESTエンドポイントURLに置き換えてください。

1
2
3
4
5
6
7
8
9
10
11
12
13

{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "external_user_ids": ["user123"],
  "messages": {
    "email": {
      "app_id": "YOUR_APP_ID",
      "message_variation_id": "YOUR_MESSAGE_VARIATION_ID",
      "subject": "You have a new message!",
      "from": "Notifications <[email protected]>",
      "body": "<html><body><h1>You have a new message!</h1><p>Hi {{${first_name}}},</p><p>You received a new message in your inbox. Click the link below to read it:</p><a href='https://yourwebsite.com/messages'>View message</a><p>Thank you for using our service!</p></body></html>"
    }
  }
}

プレースホルダーの値を実際のIDに置き換えてください。from フィールドは "Display Name <[email protected]>" の形式を使用する必要があります。body フィールドは有効なHTMLを受け付け、Liquidパーソナライゼーションをサポートしているため、各受信者に合わせてメールコンテンツをカスタマイズできます。メールメッセージングオブジェクトでサポートされるパラメーターの完全なリストについては、メールオブジェクトを参照してください。

リクエストを構築したら、バックエンドサービスからBraze REST APIにPOSTリクエストを送信します。

ステップ 3:インテグレーションを検証する

設定が完了したら、インテグレーションを検証します。

  1. ステップ 2の説明に従って、自分のユーザーIDを受信者としてAPIリクエストを送信します。
  2. メールが受信トレイに配信されたことを確認します。
  3. Brazeダッシュボードでキャンペーン結果ページに移動し、送信が記録されていることを確認します。
  4. キャンペーンをスケールする際に、結果を注意深く監視します。

考慮事項
New Stuff!