本記事では、「メール配信設定新規作成API」の概要・利用前提・仕様(リクエスト/レスポンス/エラーメッセージ)について紹介しています。
貴社の基幹システム/アプリケーションに連携したメール配信を行いたい場合は、本記事をご参照のもと、貴社開発環境に実装してください。

本記事の構成は下記の通りです。

　1. メール配信設定新規作成APIとは(概要 / b→dash管理画面上のデータ)
　2. 本API利用にあたっての前提事項(事前準備 / 共通仕様)
　3. メール配信設定新規作成APIの仕様(処理フロー / リクエスト / レスポンス)

各セクションの詳細は、以下をご参照ください。

1. メール配信設定新規作成APIとは

本APIの概要

メール配信設定新規作成APIとは、貴社の基幹システム/アプリケーションとb→dashを繋ぐことで、b→dash管理画面を介さずにメールアプリのメール配信設定を新規に作成することができるAPIです。

※ 本APIで配信するメールコンテンツをAPIで作成したい場合は、『メールコンテンツ新規作成APIを実装したい』をご活用ください

本APIで取得できるb→dash管理画面上のデータ

メール配信設定新規作成APIでは、b→dash管理画面にある「メール配信新規作成画面」における操作と同様に、メール配信設定の作成を行うことができます。

本APIを利用した結果は、下記のb→dash管理画面で確認できます。

　・「メール配信設定一覧画面」
　・「メール配信設定詳細画面」(更新履歴モーダル)
　・「メールコンテンツ詳細画面」(利用状況モーダル)

2. 本API利用にあたっての前提事項

事前準備

本APIを利用する事前準備として、下記の4つの手順を踏む必要があります。

　1. セグメント用データの作成
　2. メール配信対象外データファイルの作成
　3. メールコンテンツの作成
　4. 送信元情報の設定

1. セグメント用データの作成

メール配信設定の作成過程で送信対象となるセグメントを選択するため、事前にセグメントを作成する必要があります。

※ セグメント用データの作成がまだ完了していない場合は『セグメントを作成したい』をご参照の上、設定を完了させてください

2. メール配信対象外データファイルの作成

特定の顧客に対して配信しないメール配信設定を作成したい場合、b→dash管理画面上でメールを配信しない対象とする配信対象外データファイルを作成する必要があります。
配信対象外データファイルの作成がまだ完了していない場合は、メールの配信設定に利用するセグメント用データの参照元データファイルから、配信しない顧客またはメールアドレスの「絞込み」を行って配信対象外データファイルを作成してください。

※ b→dash管理画面上で行うデータの絞込みの方法については『データの「絞込み」をしたい』をご参照ください
※「b→dashデータのオプトアウトフォームデータ」「配信不達データ」はb→dashが自動で作成する配信対象外データファイルのため、事前準備は不要です

3. メールコンテンツの作成

メール配信設定の作成過程で配信するメールコンテンツを選択するため、b→dash管理画面上でメールコンテンツを作成する必要があります。メールコンテンツの作成がまだ完了していない場合は、下記をご参照の上、メールコンテンツを作成してください。

　・テキストメールを作成したい場合: 『テキストメールを作成したい』
　・GUIでHTMLメールを作成したい場合: 『“GUI編集モード” で「HTMLメール」を作成したい』
　・HTMLでHTMLメールを作成したい場合: 『“HTML編集モード” で「HTMLメール」を作成したい』
　・APIでHTML/テキストメールを作成したい場合: 『メールコンテンツ新規作成APIを実装したい』

4. 送信元情報の設定

メール配信設定の作成過程で送信元となるメールアドレスを選択するため、事前に送信元情報の設定をする必要があります。

※ 送信元設定のメールアドレスの登録がまだ完了していない場合は『送信元メールアドレスを設定したい』をご参照の上、登録を完了させてください

共通仕様

本APIでは、b→dash APIの共通仕様も参照する必要があります。

※ 共通仕様の詳細については『b→dash APIの共通仕様を知りたい』をご参照ください

3. メール配信設定新規作成APIの仕様

処理フロー図

メール配信設定新規作成APIの処理フロー図は下記の通りです。

メール配信設定新規作成リクエスト

リクエストボディパラメータ

json形式のファイル(拡張子: .json)に、下記のリクエストボディパラメータを指定して、メール配信設定の内容を送信するためのリクエストボディを準備します。

リクエストボディサンプル

{
  "mail_campaign_name": "メール配信設定Ａ",
  "segment_id": "10001",
  "s_mail_column_ids": [
    {
      "datafile_id": "10001",
      "d_mail_column_id": "COLUMN_1"
    },
    {
      "datafile_id": "10001",
      "d_mail_column_id": "COLUMN_2"
    },
    {
      "datafile_id": "10001",
      "d_mail_column_id": "COLUMN_3"
    },
    {
      "datafile_id": "10001",
      "d_mail_column_id": "COLUMN_4"
    },
    {
      "datafile_id": "10001",
      "d_mail_column_id": "COLUMN_5"
    }
  ],
  "is_send_all": true,
  "exclusion_datafile": [
    {
      "datafile_id": "30001",
      "d_mail_column_id": "COLUMN_1"
    },
    {
      "datafile_id": "50001",
      "d_mail_column_id": "COLUMN_1"
    }
  ],
  "contents_id": "70001",
  "sender_info_id": "80001",
  "timings": [
    {
      "interval": "ONCE",
      "year": 2021,
      "month": 12,
      "day": 31,
      "hour": 23,
      "minute": 0
    },
    {
      "interval": "WEEKLY",
      "day_of_the_week": "FRI",
      "hour": 23,
      "minute": 0
    }
  ],
  "is_delivery_segment_update": true,
  "is_enabled_delivery_limit": true,
  "is_auto_parameter": true,
  "is_delivery_the_same_customer": true,
  "delivery_start_date": "20210101",
  "delivery_end_date": "20251231"
}

リクエスト形式

本APIのURIと、準備したリクエストボディ、下記のリクエストヘッダパラメータを用いて、貴社Webアプリから「POST」リクエスト形式でメール配信設定の新規作成リクエストをします。

リクエストヘッダパラメータは下記の通りです。

リクエストコードサンプル

POST https://api.smart-bdash.com/api/v1/mail_deliveries

メール配信設定新規作成レスポンス

レスポンスボディパラメータ

リクエストの送信に成功すると、下記のレスポンス形式で本APIからレスポンスが返されます。

成功レスポンスサンプル (201)

{
  "result": {
    "code": 201,
    "mail_campaign_id": "12345"
    "mail_campaign_name": "メール配信設定Ａ"
  }
}

リクエストエラー発生時のエラーメッセージ詳細